Интерфейс SQLInput

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

public interface SQLInput

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

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

С:: 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()`	Читает следующий атрибут в потоке и возвращает его как поток символов Юникода.
`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

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

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

readBoolean

boolean readBoolean() throws SQLException

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

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

readByte

byte readByte() throws SQLException

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

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

readShort

short readShort() throws SQLException

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

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

readInt

int readInt() throws SQLException

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

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

readLong

long readLong() throws SQLException

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

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

readFloat

float readFloat() throws SQLException

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

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

readDouble

double readDouble() throws SQLException

Считывает следующее атрибут в потоке и возвращает его как double в языке программирования 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

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

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

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

Возвращает:: данные в начале потока как Object в языке программирования 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, 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/SQLInput.html