Class JdbcClob
Page Summary
The
JdbcClobclass represents a JDBC Clob and provides methods for working with large character data.Methods are available to retrieve the Clob content as an Apps Script Blob or a substring.
You can get the length of the Clob and find the position of a substring or another Clob within it.
Methods are provided to write strings or BlobSource data to the Clob at a specified position.
The Clob can be truncated to a specified length, and resources associated with it can be freed.
A JDBCClob. For documentation of this class, seejava.sql.Clob.
Methods
| Method | Return type | Brief description |
|---|---|---|
free() | void | For documentation of this method, seejava.sql.Clob#truncate(long). |
get | Blob | Gets the content of this JdbcClob as an Apps Script blob. |
get | Blob | Return the data inside this object as a blob converted to the specified content type. |
get | String | For documentation of this method, seejava.sql.Clob#getSubString(long, int). |
length() | Integer | For documentation of this method, seejava.sql.Clob#length(). |
position(search, start) | Integer | For documentation of this method, seejava.sql.Clob#position(Clob, long). |
position(search, start) | Integer | For documentation of this method, seejava.sql.Clob#position(String, long). |
set | Integer | Convenience method for writing aJdbc to a clob. |
set | Integer | Convenience method for writing aJdbc to a clob. |
set | Integer | For documentation of this method, seejava.sql.Clob#setString(long, String). |
set | Integer | For documentation of this method, seejava.sql.Clob#setString(long, String, int, int). |
truncate(length) | void | For documentation of this method, seejava.sql.Clob#truncate(long). |
Detailed documentation
free()
For documentation of this method, seejava.sql.Clob#truncate(long).
getAppsScriptBlob()
getAs(contentType)
Return the data inside this object as a blob converted to the specified content type. Thismethod adds the appropriate extension to the filename—for example, "myfile.pdf". However, itassumes that the part of the filename that follows the last period (if any) is an existingextension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes"ShoppingList.12.25.pdf".
To view the daily quotas for conversions, seeQuotas for GoogleServices. Newly created Google Workspace domains might be temporarily subject to stricterquotas.
Parameters
| Name | Type | Description |
|---|---|---|
content | 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. For a Google Docs document,'text/markdown' is also valid. |
Return
Blob — The data as a blob.
getSubString(position, length)
For documentation of this method, seejava.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, seejava.sql.Clob#length().
Return
Integer — The length (in characters) of this clob.
position(search, start)
For documentation of this method, seejava.sql.Clob#position(Clob, long).
Parameters
| Name | Type | Description |
|---|---|---|
search | Jdbc | 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, seejava.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 aJdbc to a clob.
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position at which writing to the clob starts; the first position is 1. |
blob | Blob | The blob source to write. |
Return
Integer — The number of characters written.
setString(position, blobSource, offset, len)
Convenience method for writing aJdbc to a clob.
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position at which writing to the clob starts; the first position is 1. |
blob | Blob | 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, seejava.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, seejava.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, seejava.sql.Clob#truncate(long).
Parameters
| Name | Type | Description |
|---|---|---|
length | Integer | The size (in bytes) of this clob after truncation. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.