declare namespace java {
namespace sql {
/**
* An input stream that contains a stream of values representing an
* instance of an SQL structured type or an SQL distinct type.
* This interface, used only for custom mapping, is used by the driver
* behind the scenes, and a programmer never directly invokes
* SQLInput
methods. The reader methods
* (readLong
, readBytes
, and so on)
* provide a way for an implementation of the SQLData
* interface to read the values in an SQLInput
object.
* And as described in SQLData
, calls to reader methods must
* be made in the order that their corresponding attributes appear in the
* SQL definition of the type.
* The method wasNull
is used to determine whether
* the last value read was SQL NULL
.
*
When the method getObject
is called with an
* object of a class implementing the interface SQLData
,
* the JDBC driver calls the method SQLData.getSQLType
* to determine the SQL type of the user-defined type (UDT)
* being custom mapped. The driver
* creates an instance of SQLInput
, populating it with the
* attributes of the UDT. The driver then passes the input
* stream to the method SQLData.readSQL
, which in turn
* calls the SQLInput
reader methods
* in its implementation for reading the
* attributes from the input stream.
* @since 1.2
*/
// @ts-ignore
interface SQLInput {
/**
* Reads the next attribute in the stream and returns it as a String
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readString(): string
/**
* Reads the next attribute in the stream and returns it as a boolean
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns false
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readBoolean(): boolean
/**
* Reads the next attribute in the stream and returns it as a byte
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readByte(): number /*byte*/
/**
* Reads the next attribute in the stream and returns it as a short
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readShort(): number /*short*/
/**
* Reads the next attribute in the stream and returns it as an int
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readInt(): number /*int*/
/**
* Reads the next attribute in the stream and returns it as a long
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readLong(): number /*long*/
/**
* Reads the next attribute in the stream and returns it as a float
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readFloat(): number /*float*/
/**
* Reads the next attribute in the stream and returns it as a double
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns 0
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readDouble(): number /*double*/
/**
* Reads the next attribute in the stream and returns it as a java.math.BigDecimal
* object in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readBigDecimal(): java.math.BigDecimal
/**
* Reads the next attribute in the stream and returns it as an array of bytes
* in the Java programming language.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readBytes(): number /*byte*/[]
/**
* Reads the next attribute in the stream and returns it as a java.sql.Date
object.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readDate(): java.sql.Date
/**
* Reads the next attribute in the stream and returns it as a java.sql.Time
object.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readTime(): java.sql.Time
/**
* Reads the next attribute in the stream and returns it as a java.sql.Timestamp
object.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readTimestamp(): java.sql.Timestamp
/**
* Reads the next attribute in the stream and returns it as a stream of Unicode characters.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readCharacterStream(): java.io.Reader
/**
* Reads the next attribute in the stream and returns it as a stream of ASCII characters.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readAsciiStream(): java.io.InputStream
/**
* Reads the next attribute in the stream and returns it as a stream of uninterpreted
* bytes.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readBinaryStream(): java.io.InputStream
/**
* Reads the datum at the head of the stream and returns it as an
* Object
in the Java programming language. The
* actual type of the object returned is determined by the default type
* mapping, and any customizations present in this stream's type map.
*
A type map is registered with the stream by the JDBC driver before the * stream is passed to the application. *
When the datum at the head of the stream is an SQL NULL
,
* the method returns null
. If the datum is an SQL structured or distinct
* type, it determines the SQL type of the datum at the head of the stream.
* If the stream's type map has an entry for that SQL type, the driver
* constructs an object of the appropriate class and calls the method
* SQLData.readSQL
on that object, which reads additional data from the
* stream, using the protocol described for that method.
* @return the datum at the head of the stream as an Object
in the
* Java programming language;null
if the datum is SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readObject(): any
/**
* Reads an SQL REF
value from the stream and returns it as a
* Ref
object in the Java programming language.
* @return a Ref
object representing the SQL REF
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readRef(): java.sql.Ref
/**
* Reads an SQL BLOB
value from the stream and returns it as a
* Blob
object in the Java programming language.
* @return a Blob
object representing data of the SQL BLOB
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readBlob(): java.sql.Blob
/**
* Reads an SQL CLOB
value from the stream and returns it as a
* Clob
object in the Java programming language.
* @return a Clob
object representing data of the SQL CLOB
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readClob(): java.sql.Clob
/**
* Reads an SQL ARRAY
value from the stream and returns it as an
* Array
object in the Java programming language.
* @return an Array
object representing data of the SQL
* ARRAY
value at the head of the stream; null
* if the value read is SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
readArray(): java.sql.Array
/**
* Retrieves whether the last value read was SQL NULL
.
* @return true
if the most recently read SQL value was SQL
* NULL
; false
otherwise
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
// @ts-ignore
wasNull(): boolean
/**
* Reads an SQL DATALINK
value from the stream and returns it as a
* java.net.URL
object in the Java programming language.
* @return a java.net.URL
object.
* @exception SQLException if a database access error occurs,
* or if a URL is malformed
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
// @ts-ignore
readURL(): java.net.URL
/**
* Reads an SQL NCLOB
value from the stream and returns it as a
* NClob
object in the Java programming language.
* @return a NClob
object representing data of the SQL NCLOB
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
// @ts-ignore
readNClob(): java.sql.NClob
/**
* Reads the next attribute in the stream and returns it as a String
* in the Java programming language. It is intended for use when
* accessing NCHAR
,NVARCHAR
* and LONGNVARCHAR
columns.
* @return the attribute; if the value is SQL NULL
, returns null
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
// @ts-ignore
readNString(): string
/**
* Reads an SQL XML
value from the stream and returns it as a
* SQLXML
object in the Java programming language.
* @return a SQLXML
object representing data of the SQL XML
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
// @ts-ignore
readSQLXML(): java.sql.SQLXML
/**
* Reads an SQL ROWID
value from the stream and returns it as a
* RowId
object in the Java programming language.
* @return a RowId
object representing data of the SQL ROWID
value
* at the head of the stream; null
if the value read is
* SQL NULL
* @exception SQLException if a database access error occurs
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
// @ts-ignore
readRowId(): java.sql.RowId
/**
* Reads the next attribute in the stream and returns it as an
* {@code Object} in the Java programming language. The
* actual type of the object returned is determined by the specified
* Java data type, and any customizations present in this
* stream's type map.
*
A type map is registered with the stream by the JDBC driver before the * stream is passed to the application. *
When the attribute at the head of the stream is an SQL {@code NULL} * the method returns {@code null}. If the attribute is an SQL * structured or distinct * type, it determines the SQL type of the attribute at the head of the stream. * If the stream's type map has an entry for that SQL type, the driver * constructs an object of the appropriate class and calls the method * {@code SQLData.readSQL} on that object, which reads additional data from the * stream, using the protocol described for that method. *
* The default implementation will throw {@code SQLFeatureNotSupportedException}
* @param