Class JdbcBlob

JdbcBlob

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

Methods

Method	Return type	Brief description
free()	void	For documentation of this method, see java.sql.Blob#free().
getAppsScriptBlob()	Blob	Gets the content of this JdbcBlob as an Apps Script blob.
getAs(contentType)	Blob	Return the data inside this object as a blob converted to the specified content type.
getBytes(position, length)	Byte[]	For documentation of this method, see java.sql.Blob#getBytes(long, int).
length()	Integer	For documentation of this method, see java.sql.Blob#length().
position(pattern, start)	Integer	For documentation of this method, see java.sql.Blob#position(byte[], long).
position(pattern, start)	Integer	For documentation of this method, see java.sql.Blob#position(blob, long).
setBytes(position, blobSource)	Integer	Convenience method for writing a JdbcBlob to this blob.
setBytes(position, blobSource, offset, length)	Integer	Convenience method for writing a JdbcBlob to this blob.
setBytes(position, bytes)	Integer	For documentation of this method, see java.sql.Blob#setBytes(long, byte[]).
setBytes(position, bytes, offset, length)	Integer	For documentation of this method, see java.sql.Blob#setBytes(long, byte[], int, int).
truncate(length)	void	For documentation of this method, see java.sql.Blob#truncate(long).

Detailed documentation

free()

For documentation of this method, see java.sql.Blob#free().

---

getAppsScriptBlob()

Gets the content of this JdbcBlob 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.

---

getBytes(position, length)

For documentation of this method, see java.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, see java.sql.Blob#length().

Return

Integer — The number of bytes in this blob.

---

position(pattern, start)

For documentation of this method, see java.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, see java.sql.Blob#position(blob, long).

Parameters

Name	Type	Description
pattern	JdbcBlob	The JdbcBlob 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 a JdbcBlob to this blob.

Parameters

Name	Type	Description
position	Integer	The position in the blob at which to start writing; the first position is 1.
blobSource	BlobSource	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 a JdbcBlob to this blob.

Parameters

Name	Type	Description
position	Integer	The position in the blob at which to start writing; the first position is 1.
blobSource	BlobSource	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, see java.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, see java.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, see java.sql.Blob#truncate(long).

Parameters

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