Интерфейс Clob

Все известные подинтерфейсы:: NClob

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

public interface Clob

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

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

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

С:: 1.2

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

Модификатор и тип	Метод	Описание
`void`	`free()`	Этот метод освобождает ресурсы, которые удерживает объект `Clob`.
`InputStream`	`getAsciiStream()`	Извлекает значение `CLOB`, обозначенное этим объектом `Clob` как поток ascii.
`Reader`	`getCharacterStream()`	Извлекает значение `CLOB`, обозначенное этим объектом `Clob` как объект `java.io.Reader` (или как поток символов).
`Reader`	`getCharacterStream(long pos, long length)`	Возвращает объект `Reader`, содержащий частичное значение `Clob`, начиная с символа, указанного pos, длиной length символов.
`String`	`getSubString(long pos, int length)`	Извлекает копию указанной подстроки в значении `CLOB`, обозначенном этим объектом `Clob`.
`long`	`length()`	Извлекает количество символов в значении `CLOB`, обозначенном этим объектом `Clob`.
`long`	`position(String searchstr, long start)`	Извлекает позицию символа, в которой указанная подстрока `searchstr` появляется в значении SQL `CLOB`, представленном этим объектом `Clob`.
`long`	`position(Clob searchstr, long start)`	Извлекает позицию символа, в которой указанный объект `Clob` `searchstr` появляется в этом объекте `Clob`.
`OutputStream`	`setAsciiStream(long pos)`	Извлекает поток, который будет использоваться для записи символов Ascii в значение `CLOB`, которое представляет этот объект `Clob`, начиная с позиции `pos`.
`Writer`	`setCharacterStream(long pos)`	Извлекает поток, который будет использоваться для записи потока символов Unicode в значение `CLOB`, которое представляет этот объект `Clob`, на позиции `pos`.
`int`	`setString(long pos, String str)`	Записывает заданный Java `String` в значение `CLOB`, которое обозначает этот объект `Clob` в позиции `pos`.
`int`	`setString(long pos, String str, int offset, int len)`	Записывает `len` символов `str`, начиная с символа `offset`, в значение `CLOB`, которое представляет этот объект `Clob`.
`void`	`truncate(long len)`	Усекает значение `CLOB`, которое обозначает этот объект `Clob` , до длины `len` символов.

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

length

long length() throws SQLException

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

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

getSubString

String getSubString(long pos, int length) throws SQLException

Возвращает копию указанного подстроки в значении CLOB, обозначенном этим объектом Clob. Подстрока начинается с позиции pos и содержит до length последовательных символов.

Параметры:: pos - первый символ подстроки для извлечения. Первый символ имеет позицию 1.; length - количество последовательных символов для копирования; значение длины должно быть 0 или больше
Возвращает:: подстроку в значении String значения CLOB, обозначенного этим объектом Clob
Выбрасывает:: SQLException - если произошла ошибка при доступе к значению CLOB; если pos меньше 1 или длина меньше 0; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.2

getCharacterStream

Reader getCharacterStream() throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, в виде объекта java.io.Reader (или как поток символов).

Возвращает:

объект java.io.Reader, содержащий данные CLOB

Выбрасывает:

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

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

С момента:

1.2

См. также:

setCharacterStream(long)

getAsciiStream

InputStream getAsciiStream() throws SQLException

Возвращает значение CLOB, обозначенное этим объектом Clob, в виде потока ASCII.

Возвращает:

объект java.io.InputStream, содержащий данные CLOB

Выбрасывает:

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

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

С момента:

1.2

См. также:

setAsciiStream(long)

position

long position(String searchstr, long start) throws SQLException

Возвращает позицию символа, на которой указанная подстрока searchstr появляется в значении SQL CLOB , представленном этим объектом Clob. Поиск начинается с позиции start.

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

position

long position(Clob searchstr, long start) throws SQLException

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

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

setString

int setString(long pos, String str) throws SQLException

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

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

Параметры:: pos - позиция, с которой начать запись в значение CLOB, представленное этим объектом Clob; первая позиция - 1.; str - строка, которая будет записана в значение CLOB, которое обозначает этот объект Clob
Возвращает:: количество записанных символов
Выбрасывает:: SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.4

setString

int setString(long pos, String str, int offset, int len) throws SQLException

Записывает len символов из str, начиная с символа offset, в значение CLOB этого объекта Clob. Строка перепишет существующие символы в объекте Clob начиная с позиции pos. Если при записи заданной строки достигается конец значения Clob, то длина значения Clob будет увеличена для размещения дополнительных символов.

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

Параметры:: pos - позиция, с которой начать запись в этом объекте CLOB; Первая позиция - 1; str - строка для записи в значение CLOB этого объекта Clob; offset - смещение в str для начала чтения символов для записи; len - количество символов для записи
Возвращает:: количество записанных символов
Выбрасывает:: SQLException - если произошла ошибка при доступе к значению CLOB или если pos меньше 1; SQLFeatureNotSupportedException - если JDBC-драйвер не поддерживает этот метод
С момента:: 1.4

setAsciiStream

OutputStream setAsciiStream(long pos) throws SQLException

Возвращает поток, который будет использоваться для записи символов ASCII в значение CLOB этого объекта Clob, начиная с позиции pos. Символы, записанные в поток, перепишут существующие символы в объекте Clob начиная с позиции pos. Если при записи символов в поток достигается конец значения Clob, то длина значения Clob будет увеличена для размещения дополнительных символов.

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

Параметры:

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

Возвращает:

поток, в который можно записывать символы в кодировке ASCII

Выбрасывает:

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

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

С момента:

1.4

См. также:

getAsciiStream()

setCharacterStream

Writer setCharacterStream(long pos) throws SQLException

Возвращает поток, который будет использоваться для записи потока Unicode-символов в значение CLOB этого объекта Clob, по позиции pos. Символы, записанные в поток, перепишут существующие символы в объекте Clob начиная с позиции pos. Если при записи символов в поток достигается конец значения Clob, то длина значения Clob будет увеличена для размещения дополнительных символов.

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

Параметры:

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

Возвращает:

поток, в который можно записывать символы в кодировке Unicode

Выбрасывает:

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

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

С момента:

1.4

См. также:

getCharacterStream()

truncate

void truncate(long len) throws SQLException

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

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

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

free

void free() throws SQLException

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

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

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

getCharacterStream

Reader getCharacterStream(long pos, long length) throws SQLException

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

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

© 1993, 2021, 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/17/docs/api/java.sql/java/sql/Clob.html