jdk.sql.SQLOutput — clojure-interop/java.sql 1.0.5

The output stream for writing the attributes of a user-defined type back to the database. This interface, used only for custom mapping, is used by the driver, and its methods are never directly invoked by a programmer. When an object of a class implementing the interface SQLData is passed as an argument to an SQL statement, the JDBC driver calls the method SQLData.getSQLType to determine the kind of SQL datum being passed to the database. The driver then creates an instance of SQLOutput and passes it to the method SQLData.writeSQL. The method writeSQL in turn calls the appropriate SQLOutput writer methods writeBoolean, writeCharacterStream, and so on) to write data from the SQLData object to the SQLOutput output stream as the representation of an SQL user-defined type.

write-array clj

(write-array this x)

Writes an SQL ARRAY value to the stream.

x - an Array object representing data of an SQL ARRAY type - java.sql.Array

throws: java.sql.SQLException - if a database access error occurs

write-ascii-stream clj

(write-ascii-stream this x)

Writes the next attribute to the stream as a stream of ASCII characters.

x - the value to pass to the database - java.io.InputStream

throws: java.sql.SQLException - if a database access error occurs

write-big-decimal clj

(write-big-decimal this x)

Writes the next attribute to the stream as a java.math.BigDecimal object. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - java.math.BigDecimal

throws: java.sql.SQLException - if a database access error occurs

write-binary-stream clj

(write-binary-stream this x)

Writes the next attribute to the stream as a stream of uninterpreted bytes.

x - the value to pass to the database - java.io.InputStream

throws: java.sql.SQLException - if a database access error occurs

write-blob clj

(write-blob this x)

Writes an SQL BLOB value to the stream.

x - a Blob object representing data of an SQL BLOB value - java.sql.Blob

throws: java.sql.SQLException - if a database access error occurs

write-boolean clj

(write-boolean this x)

Writes the next attribute to the stream as a Java boolean. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - boolean

throws: java.sql.SQLException - if a database access error occurs

write-byte clj

(write-byte this x)

Writes the next attribute to the stream as a Java byte. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - byte

throws: java.sql.SQLException - if a database access error occurs

write-bytes clj

(write-bytes this x)

Writes the next attribute to the stream as an array of bytes. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - byte[]

throws: java.sql.SQLException - if a database access error occurs

write-character-stream clj

(write-character-stream this x)

Writes the next attribute to the stream as a stream of Unicode characters.

x - the value to pass to the database - java.io.Reader

throws: java.sql.SQLException - if a database access error occurs

write-clob clj

(write-clob this x)

Writes an SQL CLOB value to the stream.

x - a Clob object representing data of an SQL CLOB value - java.sql.Clob

throws: java.sql.SQLException - if a database access error occurs

write-date clj

(write-date this x)

Writes the next attribute to the stream as a java.sql.Date object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

x - the value to pass to the database - java.sql.Date

throws: java.sql.SQLException - if a database access error occurs

write-double clj

(write-double this x)

Writes the next attribute to the stream as a Java double. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - double

throws: java.sql.SQLException - if a database access error occurs

write-float clj

(write-float this x)

Writes the next attribute to the stream as a Java float. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - float

throws: java.sql.SQLException - if a database access error occurs

write-int clj

(write-int this x)

Writes the next attribute to the stream as a Java int. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - int

throws: java.sql.SQLException - if a database access error occurs

write-long clj

(write-long this x)

Writes the next attribute to the stream as a Java long. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - long

throws: java.sql.SQLException - if a database access error occurs

write-n-clob clj

(write-n-clob this x)

Writes an SQL NCLOB value to the stream.

x - a NClob object representing data of an SQL NCLOB value - java.sql.NClob

throws: java.sql.SQLException - if a database access error occurs

write-n-string clj

(write-n-string this x)

Writes the next attribute to the stream as a String in the Java programming language. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the stream.

x - the value to pass to the database - java.lang.String

throws: java.sql.SQLException - if a database access error occurs

write-object clj

(write-object this x)

(write-object this x target-sql-type)

Writes to the stream the data contained in the given object. The object will be converted to the specified targetSqlType before being sent to the stream.

When the object is null, this method writes an SQL NULL to the stream.

If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

The default implementation will throw SQLFeatureNotSupportedException

x - the object containing the input parameter value - java.lang.Object target-sql-type - the SQL type to be sent to the database. - java.sql.SQLType

returns: default void

throws: java.sql.SQLException - if a database access error occurs or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero

write-ref clj

(write-ref this x)

Writes an SQL REF value to the stream.

x - a Ref object representing data of an SQL REF value - java.sql.Ref

throws: java.sql.SQLException - if a database access error occurs

write-row-id clj

(write-row-id this x)

Writes an SQL ROWID value to the stream.

x - a RowId object representing data of an SQL ROWID value - java.sql.RowId

throws: java.sql.SQLException - if a database access error occurs

write-short clj

(write-short this x)

Writes the next attribute to the stream as a Java short. Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - short

throws: java.sql.SQLException - if a database access error occurs

write-sqlxml clj

(write-sqlxml this x)

Writes an SQL XML value to the stream.

x - a SQLXML object representing data of an SQL XML value - java.sql.SQLXML

throws: java.sql.SQLException - if a database access error occurs, the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object or if there is an error processing the XML value. The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.

write-string clj

(write-string this x)

Writes the next attribute to the stream as a String in the Java programming language.

x - the value to pass to the database - java.lang.String

throws: java.sql.SQLException - if a database access error occurs

write-struct clj

(write-struct this x)

Writes an SQL structured type value to the stream.

x - a Struct object representing data of an SQL structured type - java.sql.Struct

throws: java.sql.SQLException - if a database access error occurs

write-time clj

(write-time this x)

Writes the next attribute to the stream as a java.sql.Time object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

x - the value to pass to the database - java.sql.Time

throws: java.sql.SQLException - if a database access error occurs

write-timestamp clj

(write-timestamp this x)

Writes the next attribute to the stream as a java.sql.Timestamp object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

x - the value to pass to the database - java.sql.Timestamp

throws: java.sql.SQLException - if a database access error occurs

write-url clj

(write-url this x)

Writes a SQL DATALINK value to the stream.

x - a java.net.URL object representing the data of SQL DATALINK type - java.net.URL

throws: java.sql.SQLException - if a database access error occurs