Интерфейс Blob

public interface Blob

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

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

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

Методы

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 - количество последовательных байтов для копирования; значение length должно быть 0 или больше

Возвращает:

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

Исключения:

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

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

С тех пор:

1.2

См. также:

setBytes(long, byte[])

getBinaryStream

InputStream getBinaryStream()
                     throws SQLException

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

Возвращает:

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

Исключения:

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

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

С тех пор:

1.2

См. также:

setBinaryStream(long)

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

Параметры:

pos - позиция в объекте BLOB для начала записи; первая позиция — 1

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

Возвращает:

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

Исключения:

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

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

С тех пор:

1.4

См. также:

getBytes(long, int)

setBytes

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

Параметры:

pos - позиция в объекте BLOB для начала записи; первая позиция — 1

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

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

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

Возвращает:

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

Исключения:

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

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

С тех пор:

1.4

См. также:

getBytes(long, int)

setBinaryStream

OutputStream setBinaryStream(long pos)
                      throws SQLException

Параметры:

pos - позиция в значении BLOB для начала записи; первая позиция — 1

Возвращает:

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

Исключения:

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

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

С тех пор:

1.4

См. также:

getBinaryStream()

truncate

void truncate(long len)
       throws SQLException

Параметры:

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

Исключения:

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

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

С тех пор:

1.4

free

void free()
   throws SQLException

Исключения:

SQLException - если произошла ошибка при освобождении ресурсов Blob

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

С тех пор:

1.6

getBinaryStream

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