Class JdbcClob

A JDBC Clob. For documentation of this class, see java.sql.Clob .

Methods

Method	Return type	Brief description
`free()`	`void`	For documentation of this method, see `java.sql.Clob#truncate(long)`.
`getAppsScriptBlob()`	`Blob`	Gets the content of this JdbcClob as an Apps Script blob.
`getAs(contentType)`	`Blob`	Return the data inside this object as a blob converted to the specified content type.
`getSubString(position, length)`	`String`	For documentation of this method, see `java.sql.Clob#getSubString(long, int)`.
`length()`	`Integer`	For documentation of this method, see `java.sql.Clob#length()`.
`position(search, start)`	`Integer`	For documentation of this method, see `java.sql.Clob#position(Clob, long)`.
`position(search, start)`	`Integer`	For documentation of this method, see `java.sql.Clob#position(String, long)`.
`setString(position, blobSource)`	`Integer`	Convenience method for writing a `JdbcClob` to a clob.
`setString(position, blobSource, offset, len)`	`Integer`	Convenience method for writing a `JdbcClob` to a clob.
`setString(position, value)`	`Integer`	For documentation of this method, see `java.sql.Clob#setString(long, String)`.
`setString(position, value, offset, len)`	`Integer`	For documentation of this method, see `java.sql.Clob#setString(long, String, int, int)`.
`truncate(length)`	`void`	For documentation of this method, see `java.sql.Clob#truncate(long)`.

Detailed documentation

`free()`

For documentation of this method, see java.sql.Clob#truncate(long).

`getAppsScriptBlob()`

Gets the content of this JdbcClob as an Apps Script blob.

Return

Blob — A Blob that can be used directly by other Apps Script APIs.

`getAs(contentType)`

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".

Parameters

Name	Type	Description
`contentType`	`String`	The MIME type to convert to. For most blobs, `'application/pdf'` is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of `'image/bmp'`, `'image/gif'`, `'image/jpeg'`, or `'image/png'` are also valid.

Return

Blob — The data as a blob.

`getSubString(position, length)`

For documentation of this method, see java.sql.Clob#getSubString(long, int).

Parameters

Name	Type	Description
`position`	`Integer`	The index of the first character of the substring to extract. The first character is at index 1.
`length`	`Integer`	The number of consecutive characters to copy (must be 0 or greater).

Return

String — The retrieved substring.

`length()`

For documentation of this method, see java.sql.Clob#length().

Return

Integer — The length (in characters) of this clob.

`position(search, start)`

For documentation of this method, see java.sql.Clob#position(Clob, long).

Parameters

Name	Type	Description
`search`	`JdbcClob`	The clob object to search for.
`start`	`Integer`	The position at which to begin searching; the first position is 1.

Return

Integer — The position at which the specifed clob appears, or -1 if it is not present.

`position(search, start)`

For documentation of this method, see java.sql.Clob#position(String, long).

Parameters

Name	Type	Description
`search`	`String`	The substring to search for.
`start`	`Integer`	The position at which to begin searching; the first position is 1.

Return

Integer — The position at which the specifed substring appears, or -1 if it is not present.

`setString(position, blobSource)`

Convenience method for writing a JdbcClob to a clob.

Parameters

Name	Type	Description
`position`	`Integer`	The position at which writing to the clob starts; the first position is 1.
`blobSource`	`BlobSource`	The blob source to write.

Return

Integer — The number of characters written.

`setString(position, blobSource, offset, len)`

Convenience method for writing a JdbcClob to a clob.

Parameters

Name	Type	Description
`position`	`Integer`	The position at which writing to the clob starts; the first position is 1.
`blobSource`	`BlobSource`	The blob source to write.
`offset`	`Integer`	The offset into the provided string where reading characters to write starts.
`len`	`Integer`	The number of characters to write.

Return

Integer — The number of characters written.

`setString(position, value)`

For documentation of this method, see java.sql.Clob#setString(long, String).

Parameters

Name	Type	Description
`position`	`Integer`	The position at which writing to the clob starts; the first position is 1.
`value`	`String`	The string to write.

Return

Integer — The number of characters written.

`setString(position, value, offset, len)`

For documentation of this method, see java.sql.Clob#setString(long, String, int, int).

Parameters

Name	Type	Description
`position`	`Integer`	The position at which writing to the clob starts; the first position is 1.
`value`	`String`	The string to write.
`offset`	`Integer`	The offset into the provided string where reading characters to write starts.
`len`	`Integer`	The number of characters to write.

Return

Integer — The number of characters written.

`truncate(length)`

For documentation of this method, see java.sql.Clob#truncate(long).

Parameters

Name	Type	Description
`length`	`Integer`	The size (in bytes) of this clob after truncation.