Интерфейс Blob

Все известные реализующие классы:: SerialBlob

public interface Blob

Представление (отображение) в языке программирования Java значения SQL BLOB. SQL BLOB — это встроенный тип, который хранит двоиный большой объект (BLOB) в качестве значения столбца в строке таблицы базы данных. По умолчанию драйверы реализуют Blob с использованием SQL locator(BLOB), что означает, что объект Blob содержит логическую ссылку на данные SQL BLOB, а не сами данные. Объект Blob действует в течение транзакции, в которой он был создан.

Методы в интерфейсах ResultSet, CallableStatement и PreparedStatement, такие как getBlob и setBlob, позволяют программисту получать доступ к значению SQL BLOB. Интерфейс Blob предоставляет методы для получения длины значения SQL BLOB (двоичного большого объекта), для материализации значения BLOB на клиенте и для определения позиции шаблона байтов в значении BLOB. Кроме того, этот интерфейс имеет методы для обновления значения BLOB.

Все методы интерфейса Blob должны быть полностью реализованы, если JDBC-драйвер поддерживает тип данных.

С:: 1.2

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`free()`	Этот метод освобождает объект `Blob` и освобождает ресурсы, которые он удерживает.
`InputStream`	`getBinaryStream()`	Извлекает значение `BLOB`, обозначенное этим экземпляром `Blob` как поток.
`InputStream`	`getBinaryStream(long pos, long length)`	Возвращает объект `InputStream`, содержащий частичное значение `Blob`, начиная с байта, указанного pos, и имеющий длину length байт.
`byte[]`	`getBytes(long pos, int length)`	Извлекает все или часть значения `BLOB`, которое представляет этот объект `Blob`, в виде массива байтов.
`long`	`length()`	Возвращает количество байтов в значении `BLOB` , обозначенном этим объектом `Blob`.
`long`	`position(byte[] pattern, long start)`	Извлекает позицию байта, на которой указанный массив байтов `pattern` начинается внутри значения `BLOB` , которое представляет этот объект `Blob`.
`long`	`position(Blob pattern, long start)`	Извлекает позицию байта в значении `BLOB`, обозначенном этим объектом `Blob` , на которой начинается `pattern`.
`OutputStream`	`setBinaryStream(long pos)`	Извлекает поток, который может быть использован для записи в значение `BLOB` , которое представляет этот объект `Blob`.
`int`	`setBytes(long pos, byte[] bytes)`	Записывает заданный массив байтов в значение `BLOB` , которое представляет этот объект `Blob` , начиная с позиции `pos`, и возвращает количество записанных байтов.
`int`	`setBytes(long pos, byte[] bytes, int offset, int len)`	Записывает весь или часть заданного массива `byte` в значение `BLOB` , которое представляет этот объект `Blob` , и возвращает количество записанных байтов.
`void`	`truncate(long len)`	Укорачивает значение `BLOB` , которое представляет этот объект `Blob` , чтобы оно имело длину `len` байт.

Подробное описание методов

length

long length() throws SQLException

Возвращает количество байтов в значении BLOB, обозначенном этим объектом Blob.

Возвращает:: длина BLOB в байтах
Исключение:: SQLException - если возникла ошибка при доступе к длине BLOB; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

getBytes

byte[] getBytes(long pos, int length) throws SQLException

Извлекает все или часть значения BLOB, которое представляет этот объект Blob, в виде массива байтов. Этот массив содержит до length последовательных байтов, начиная с позиции pos.

Параметры:

pos - порядковый номер первого байта в значении BLOB, которое должно быть извлечено; первый байт находится на позиции 1

length - количество последовательных байтов для копирования; значение для длины должно быть 0 или больше

Возвращает:

массив байтов, содержащий до length последовательных байтов из значения BLOB, обозначенного этим объектом Blob, начиная с байта на позиции pos

Исключение:

SQLException - если возникла ошибка при доступе к значению BLOB; если pos меньше 1 или длина меньше 0

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.2

См. также:

getBinaryStream

InputStream getBinaryStream() throws SQLException

Извлекает значение BLOB, обозначенное этим экземпляром Blob, в виде потока.

Возвращает:

поток, содержащий данные BLOB

Исключение:

SQLException - если возникла ошибка при доступе к значению BLOB

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.2

См. также:

position

long position(byte[] pattern, long start) throws SQLException

Возвращает позицию байта, на которой начинается указанный массив байтов pattern внутри значения BLOB, которое представляет этот объект Blob. Поиск pattern начинается с позиции start.

Параметры:: pattern - массив байтов, для которого выполняется поиск; start - позиция, с которой начинается поиск; первая позиция - 1
Возвращает:: позиция, на которой встречается шаблон, иначе -1
Исключение:: SQLException - если возникла ошибка при доступе к значению BLOB или если start меньше 1; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

position

long position(Blob pattern, long start) throws SQLException

Возвращает позицию байта в значении BLOB, обозначенном этим объектом Blob, на которой начинается pattern. Поиск начинается с позиции start.

Параметры:: pattern - объект Blob, обозначающий значение BLOB для поиска; start - позиция в значении BLOB, с которой начинается поиск; первая позиция - 1
Возвращает:: позиция, на которой начинается шаблон, иначе -1
Исключение:: SQLException - если возникла ошибка при доступе к значению BLOB или если start меньше 1; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.2

setBytes

int setBytes(long pos, byte[] bytes) throws SQLException

Записывает заданный массив байтов в значение BLOB, которое представляет этот объект Blob, начиная с позиции pos, и возвращает количество записанных байтов. Массив байтов перезапишет существующие байты в объекте Blob, начиная с позиции pos. Если при записи массива байтов достигнут конец значения Blob, то длина значения Blob увеличится для размещения дополнительных байтов.

Примечание: Если указанное значение для pos больше, чем длина+1 значения BLOB, то поведение не определено. Некоторые драйверы JDBC могут выбросить SQLException, в то время как другие драйверы могут поддерживать эту операцию.

Параметры:

pos - позиция в объекте BLOB, с которой начинается запись; первая позиция - 1

bytes - массив байтов, который должен быть записан в значение BLOB, которое представляет этот объект Blob

Возвращает:

количество записанных байтов

Исключение:

SQLException - если возникла ошибка при доступе к значению BLOB или если pos меньше 1

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.4

См. также:

setBytes

int setBytes(long pos, byte[] bytes, int offset, int len) throws SQLException

Записывает весь или часть заданного массива byte в значение BLOB, которое представляет этот объект Blob, и возвращает количество записанных байтов. Запись начинается с позиции pos в значении BLOB; len байтов из заданного массива байтов записываются. Массив байтов перезапишет существующие байты в объекте Blob, начиная с позиции pos. Если при записи массива байтов достигнут конец значения Blob, то длина значения Blob увеличится для размещения дополнительных байтов.

Примечание: Если указанное значение для pos больше, чем длина+1 значения BLOB, то поведение не определено. Некоторые драйверы JDBC могут выбросить SQLException или поддержать эту операцию.

Параметры:

pos - позиция в объекте BLOB, с которой начинается запись; первая позиция - 1

bytes - массив байтов, который должен быть записан в этот объект BLOB

offset - смещение в массиве bytes, с которого начинается чтение байтов для установки

len - количество байтов, которые должны быть записаны в значение BLOB из массива байтов bytes

Возвращает:

количество записанных байтов

Исключение:

SQLException - если возникла ошибка при доступе к значению BLOB или если pos меньше 1

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.4

См. также:

setBinaryStream

OutputStream setBinaryStream(long pos) throws SQLException

Получает поток, который можно использовать для записи в значение BLOB, которое представляет этот объект Blob. Поток начинается с позиции pos. Байты, записанные в поток, перезапишут существующие байты в объекте Blob начиная с позиции pos. Если при записи в поток достигнут конец значения Blob, то длина значения Blob увеличится для размещения дополнительных байтов.

Параметры:

pos - позиция в значении BLOB, с которой начинается запись; первая позиция - 1

Возвращает:

объект java.io.OutputStream, в который можно записывать данные

Исключение:

SQLException - если возникла ошибка при доступе к значению BLOB или если pos меньше 1

SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод

С момента:

1.4

См. также:

truncate

void truncate(long len) throws SQLException

Усекает значение BLOB, которое представляет этот объект Blob, чтобы оно имело длину len байт.

Параметры:: len - длина в байтах, до которой должно быть усечено значение BLOB, которое представляет этот объект Blob
Исключение:: SQLException - если возникла ошибка при доступе к значению BLOB или если len меньше 0; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С момента:: 1.4

освободить

void free() throws SQLException

Этот метод освобождает объект Blob и высвобождает ресурсы, которые он удерживает. Объект становится недействительным после вызова метода free.

После вызова free, любая попытка вызвать метод, отличный от free, приведет к выбрасыванию SQLException. Если free вызывается несколько раз, последующие вызовы free обрабатываются как бесполезные действия.

Исключение:: SQLException - если произошла ошибка при высвобождении ресурсов Blob; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.6

получитьПотокБинарныхДанных

InputStream getBinaryStream(long pos, long length) throws SQLException

Возвращает объект InputStream, содержащий частичное значение Blob, начиная с байта, указанного pos, длина которого равна length байтам.

Параметры:: pos - смещение до первого байта частичного значения для извлечения. Первый байт в Blob находится на позиции 1.; length - длина в байтах частичного значения для извлечения
Возвращает:: InputStream, через который можно прочитать частичное значение Blob.
Исключение:: SQLException - если pos меньше 1 или если pos больше количества байтов в Blob или если pos + length больше количества байтов в Blob; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.6

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.sql/java/sql/Blob.html