Class JdbcBlob
Page Summary
JdbcBlob is a JDBC
Blobobject, providing methods for interacting with binary large object data.You can get the content of a JdbcBlob as an Apps Script blob using
getAppsScriptBlob()or convert it to a specified content type usinggetAs().Methods like
getBytes()andlength()allow you to retrieve data and the size of the blob, respectively.You can find the position of a pattern within the blob using
position()and write bytes to the blob using varioussetBytes()methods.The
free()method releases the resources held by the blob andtruncate()truncates the blob to a specified length.
A JDBCBlob. For documentation of this class, seejava.sql.Blob.
Methods
| Method | Return type | Brief description |
|---|---|---|
free() | void | For documentation of this method, seejava.sql.Blob#free(). |
get | Blob | Gets the content of this JdbcBlob as an Apps Script blob. |
get | Blob | Return the data inside this object as a blob converted to the specified content type. |
get | Byte[] | For documentation of this method, seejava.sql.Blob#getBytes(long, int). |
length() | Integer | For documentation of this method, seejava.sql.Blob#length(). |
position(pattern, start) | Integer | For documentation of this method, seejava.sql.Blob#position(byte[], long). |
position(pattern, start) | Integer | For documentation of this method, seejava.sql.Blob#position(blob, long). |
set | Integer | Convenience method for writing aJdbc to this blob. |
set | Integer | Convenience method for writing aJdbc to this blob. |
set | Integer | For documentation of this method, seejava.sql.Blob#setBytes(long, byte[]). |
set | Integer | For documentation of this method, seejava.sql.Blob#setBytes(long, byte[], int, int). |
truncate(length) | void | For documentation of this method, seejava.sql.Blob#truncate(long). |
Detailed documentation
free()
For documentation of this method, seejava.sql.Blob#free().
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.
getBytes(position, length)
For documentation of this method, seejava.sql.Blob#getBytes(long, int).
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The ordinal position of the first byte in the blob value to be extracted; the first byte is at position 1. |
length | Integer | The number of consecutive bytes to copy; the value for length must be zero or greater. |
Return
Byte[] — A byte array containing up to the specified number of consecutive bytes from the blob value.
length()
For documentation of this method, seejava.sql.Blob#length().
Return
Integer — The number of bytes in this blob.
position(pattern, start)
For documentation of this method, seejava.sql.Blob#position(byte[], long).
Parameters
| Name | Type | Description |
|---|---|---|
pattern | Byte[] | The byte array to search for. |
start | Integer | The position in the blob value where to beging searching; the first position is 1. |
Return
Integer — The position at which the specified pattern begins, or else -1 if the pattern is not found.
position(pattern, start)
For documentation of this method, seejava.sql.Blob#position(blob, long).
Parameters
| Name | Type | Description |
|---|---|---|
pattern | Jdbc | TheJdbc indicating the value to search for. |
start | Integer | The position in the blob value where to beging searching; the first position is 1. |
Return
Integer — The position at which the specified pattern begins, or else -1 if the pattern is not found.
setBytes(position, blobSource)
Convenience method for writing aJdbc to this blob.
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position in the blob at which to start writing; the first position is 1. |
blob | Blob | The source of data to write to this blob. |
Return
Integer — The number of bytes written.
setBytes(position, blobSource, offset, length)
Convenience method for writing aJdbc to this blob.
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position in the blob at which to start writing; the first position is 1. |
blob | Blob | The source of data to write to this blob. |
offset | Integer | The offset into the provided byte array at which to start reading bytes to set. |
length | Integer | The number of bytes to write to the blob. |
Return
Integer — The number of bytes written.
setBytes(position, bytes)
For documentation of this method, seejava.sql.Blob#setBytes(long, byte[]).
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position in the blob at which to start writing; the first position is 1. |
bytes | Byte[] | The array of bytes to write to this blob. |
Return
Integer — The number of bytes written.
setBytes(position, bytes, offset, length)
For documentation of this method, seejava.sql.Blob#setBytes(long, byte[], int, int).
Parameters
| Name | Type | Description |
|---|---|---|
position | Integer | The position in the blob at which to start writing; the first position is 1. |
bytes | Byte[] | The array of bytes to write to this blob. |
offset | Integer | The offset into the provided byte array at which to start reading bytes to set. |
length | Integer | The number of bytes to write to the blob. |
Return
Integer — The number of bytes written.
truncate(length)
For documentation of this method, seejava.sql.Blob#truncate(long).
Parameters
| Name | Type | Description |
|---|---|---|
length | Integer | The size (in bytes) of this blob 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.