Интерфейс SQLInput

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

public interface SQLInput

Поток ввода, содержащий последовательность значений, представляющих экземпляр SQL-структурированного типа или SQL-различимого типа. Этот интерфейс, используемый только для пользовательского сопоставления, используется драйвером за кулисами, и программист никогда напрямую не вызывает SQLInput методы. Методы reader (readLong, readBytes и т. д.) предоставляют способ реализации интерфейса SQLData для чтения значений в объекте SQLInput. И, как описано в SQLData, вызовы методов reader должны выполняться в том порядке, в котором соответствующие атрибуты появляются в SQL-определении типа. Метод wasNull используется для определения, было ли последнее прочитанное значение SQL NULL.

Когда метод getObject вызывается с объектом класса, реализующего интерфейс SQLData, JDBC-драйвер вызывает метод SQLData.getSQLType, чтобы определить SQL-тип пользовательского типа (UDT), который подлежит пользовательскому сопоставлению. Драйвер создает экземпляр SQLInput, заполняя его атрибутами UDT. Затем драйвер передает поток ввода методу SQLData.readSQL, который в свою очередь вызывает методы SQLInput reader в своей реализации для чтения атрибутов из потока ввода.

С:: 1.2

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

Модификатор и тип	Метод	Описание
`Array`	`readArray()`	Считывает значение SQL `ARRAY` из потока и возвращает его как объект `Array` на языке программирования Java.
`InputStream`	`readAsciiStream()`	Считывает следующий атрибут в потоке и возвращает его как поток ASCII-символов.
`BigDecimal`	`readBigDecimal()`	Считывает следующий атрибут в потоке и возвращает его как объект `java.math.BigDecimal` на языке программирования Java.
`InputStream`	`readBinaryStream()`	Считывает следующий атрибут в потоке и возвращает его как поток неинтерпретируемых байтов.
`Blob`	`readBlob()`	Считывает значение SQL `BLOB` из потока и возвращает его как объект `Blob` на языке программирования Java.
`boolean`	`readBoolean()`	Считывает следующий атрибут в потоке и возвращает его как `boolean` на языке программирования Java.
`byte`	`readByte()`	Считывает следующий атрибут в потоке и возвращает его как `byte` на языке программирования Java.
`byte[]`	`readBytes()`	Считывает следующий атрибут в потоке и возвращает его как массив байтов на языке программирования Java.
`Reader`	`readCharacterStream()`	Считывает следующий атрибут в потоке и возвращает его как поток символов Unicode.
`Clob`	`readClob()`	Считывает значение SQL `CLOB` из потока и возвращает его как объект `Clob` на языке программирования Java.
`Date`	`readDate()`	Считывает следующий атрибут в потоке и возвращает его как объект `java.sql.Date`.
`double`	`readDouble()`	Считывает следующий атрибут в потоке и возвращает его как `double` на языке программирования Java.
`float`	`readFloat()`	Считывает следующий атрибут в потоке и возвращает его как `float` на языке программирования Java.
`int`	`readInt()`	Считывает следующий атрибут в потоке и возвращает его как `int` на языке программирования Java.
`long`	`readLong()`	Считывает следующий атрибут в потоке и возвращает его как `long` на языке программирования Java.
`NClob`	`readNClob()`	Считывает значение SQL `NCLOB` из потока и возвращает его как объект `NClob` на языке программирования Java.
`String`	`readNString()`	Считывает следующий атрибут в потоке и возвращает его как `String` на языке программирования Java.
`Object`	`readObject()`	Считывает данные в начале потока и возвращает их как `Object` на языке программирования Java.
`default <T> T`	`readObject(Class<T> type)`	Считывает следующий атрибут в потоке и возвращает его как `Object` на языке программирования Java.
`Ref`	`readRef()`	Считывает значение SQL `REF` из потока и возвращает его как объект `Ref` на языке программирования Java.
`RowId`	`readRowId()`	Считывает значение SQL `ROWID` из потока и возвращает его как объект `RowId` на языке программирования Java.
`short`	`readShort()`	Считывает следующий атрибут в потоке и возвращает его как `short` на языке программирования Java.
`SQLXML`	`readSQLXML()`	Считывает значение SQL `XML` из потока и возвращает его как объект `SQLXML` на языке программирования Java.
`String`	`readString()`	Считывает следующий атрибут в потоке и возвращает его как `String` на языке программирования Java.
`Time`	`readTime()`	Считывает следующий атрибут в потоке и возвращает его как объект `java.sql.Time`.
`Timestamp`	`readTimestamp()`	Считывает следующий атрибут в потоке и возвращает его как объект `java.sql.Timestamp`.
`URL`	`readURL()`	Считывает значение SQL `DATALINK` из потока и возвращает его как объект `java.net.URL` на языке программирования Java.
`boolean`	`wasNull()`	Возвращает значение, определяющее, было ли последнее считанное значение SQL `NULL`.

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

readString

String readString() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как строку в языке программирования Java.

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

readBoolean

boolean readBoolean() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как логическое значение в языке программирования Java.

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

readByte

byte readByte() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как байт в языке программирования Java.

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

readShort

short readShort() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как целое число со знаком в языке программирования Java.

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

readInt

int readInt() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как целое число в языке программирования Java.

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

readLong

long readLong() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как длинное целое число в языке программирования Java.

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

readFloat

float readFloat() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как число с плавающей точкой в языке программирования Java.

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

readDouble

double readDouble() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как число двойной точности в языке программирования Java.

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

readBigDecimal

BigDecimal readBigDecimal() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект java.math.BigDecimal в языке программирования Java.

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

readBytes

byte[] readBytes() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как массив байтов в языке программирования Java.

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

readDate

Date readDate() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект java.sql.Date.

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

readTime

Time readTime() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект java.sql.Time.

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

readTimestamp

Timestamp readTimestamp() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как объект java.sql.Timestamp.

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

readCharacterStream

Reader readCharacterStream() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток Юникода.

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

readAsciiStream

InputStream readAsciiStream() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток ASCII-символов.

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

readBinaryStream

InputStream readBinaryStream() throws SQLException

Считывает следующий атрибут в потоке и возвращает его как поток необработанных байтов.

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

readObject

Object readObject() throws SQLException

Считывает данные в начале потока и возвращает их как объект в языке программирования Java. Фактический тип возвращаемого объекта определяется стандартным сопоставлением типов и любыми настройками, присутствующими в карте типов данного потока.

Карта типов регистрируется драйвером JDBC перед тем, как поток передается приложению.

Когда данные в начале потока являются SQL NULL, метод возвращает null. Если данные представляют структурированный или отличительный тип SQL, он определяет тип данных SQL данных в начале потока. Если карта типов потока содержит запись для этого типа SQL, драйвер создает объект соответствующего класса и вызывает метод SQLData.readSQL на этом объекте, который считывает дополнительные данные из потока, используя протокол, описанный для этого метода.

Возвращает:: данные в начале потока в виде объекта в языке программирования Java; null если данные представляют SQL NULL
Бросает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.2

readRef

Ref readRef() throws SQLException

Читает значение SQL REF из потока и возвращает его как объект Ref на языке программирования Java.

Возвращает:: объект Ref, представляющий значение SQL REF в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.2

readBlob

Blob readBlob() throws SQLException

Читает значение SQL BLOB из потока и возвращает его как объект Blob на языке программирования Java.

Возвращает:: объект Blob, представляющий данные значения SQL BLOB в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.2

readClob

Clob readClob() throws SQLException

Читает значение SQL CLOB из потока и возвращает его как объект Clob на языке программирования Java.

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

readArray

Array readArray() throws SQLException

Читает значение SQL ARRAY из потока и возвращает его как объект Array на языке программирования Java.

Возвращает:: объект Array, представляющий данные значения SQL ARRAY в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.2

wasNull

boolean wasNull() throws SQLException

Возвращает, было ли последнее прочитанное значение SQL NULL.

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

readURL

URL readURL() throws SQLException

Читает значение SQL DATALINK из потока и возвращает его как объект java.net.URL на языке программирования Java.

Возвращает:: объект java.net.URL.
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных или URL некорректен; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.4

readNClob

NClob readNClob() throws SQLException

Читает значение SQL NCLOB из потока и возвращает его как объект NClob на языке программирования Java.

Возвращает:: объект NClob, представляющий данные значения SQL NCLOB в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.6

readNString

String readNString() throws SQLException

Читает следующий атрибут в потоке и возвращает его как String на языке программирования Java. Предназначен для доступа к столбцам NCHAR, NVARCHAR и LONGNVARCHAR.

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

readSQLXML

SQLXML readSQLXML() throws SQLException

Читает значение SQL XML из потока и возвращает его как объект SQLXML на языке программирования Java.

Возвращает:: объект SQLXML, представляющий данные значения SQL XML в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.6

readRowId

RowId readRowId() throws SQLException

Читает значение SQL ROWID из потока и возвращает его как объект RowId на языке программирования Java.

Возвращает:: объект RowId, представляющий данные значения SQL ROWID в начале потока; null, если прочитанное значение является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.6

readObject

default <T> T readObject(Class<T> type) throws SQLException

Читает следующий атрибут в потоке и возвращает его как Object на языке программирования Java. Фактический тип возвращаемого объекта определяется указанным типом данных Java и любыми настройка в карте типов этого потока.

Карта типов регистрируется драйвером JDBC до того, как поток передается приложению.

Когда атрибут в начале потока является SQL NULL, метод возвращает null. Если атрибут является SQL структурированным или отличительным типом, он определяет SQL тип атрибута в начале потока. Если в карте типов потока есть запись для этого SQL типа, драйвер создает объект соответствующего класса и вызывает метод SQLData.readSQL на этом объекте, который читает дополнительные данные из потока, используя протокол, описанный для этого метода.

По умолчанию реализация будет выбрасывать SQLFeatureNotSupportedException

Параметры типа:: T - тип класса, моделируемого этим объектом Class
Параметры:: type - Класс, представляющий тип данных Java для преобразования атрибута.
Возвращает:: атрибут в начале потока как Object на языке программирования Java; null если атрибут является SQL NULL
Выбрасывает:: SQLException - если произошла ошибка доступа к базе данных; SQLFeatureNotSupportedException - если драйвер JDBC не поддерживает этот метод
С:: 1.8

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.sql/java/sql/SQLInput.html