The interface that adds support to the JDBC API for the JavaBeans™ component model. A rowset, which can be used as a JavaBeans component in a visual Bean development environment, can be created and configured at design time and executed at run time.
The RowSet interface provides a set of JavaBeans properties that allow a RowSet instance to be configured to connect to a JDBC data source and read some data from the data source. A group of setter methods (setInt, setBytes, setString, and so on) provide a way to pass input parameters to a rowset's command property. This command is the SQL query the rowset uses when it gets its data from a relational database, which is generally the case.
The RowSet interface supports JavaBeans events, allowing other components in an application to be notified when an event occurs on a rowset, such as a change in its value.
The RowSet interface is unique in that it is intended to be
implemented using the rest of the JDBC API. In other words, a
RowSet implementation is a layer of software that executes on top
of a JDBC driver. Implementations of the RowSet interface can
be provided by anyone, including JDBC driver vendors who want to
provide a RowSet implementation as part of their JDBC products.
A RowSet object may make a connection with a data source and maintain that connection throughout its life cycle, in which case it is called a connected rowset. A rowset may also make a connection with a data source, get data from it, and then close the connection. Such a rowset is called a disconnected rowset. A disconnected rowset may make changes to its data while it is disconnected and then send the changes back to the original source of the data, but it must reestablish a connection to do so.
A disconnected rowset may have a reader (a RowSetReader object) and a writer (a RowSetWriter object) associated with it. The reader may be implemented in many different ways to populate a rowset with data, including getting data from a non-relational data source. The writer can also be implemented in many different ways to propagate changes made to the rowset's data back to the underlying data source.
Rowsets are easy to use. The RowSet interface extends the standard java.sql.ResultSet interface. The RowSetMetaData interface extends the java.sql.ResultSetMetaData interface. Thus, developers familiar with the JDBC API will have to learn a minimal number of new APIs to use rowsets. In addition, third-party software tools that work with JDBC ResultSet objects will also easily be made to work with rowsets.
The interface that adds support to the JDBC API for the JavaBeans™ component model. A rowset, which can be used as a JavaBeans component in a visual Bean development environment, can be created and configured at design time and executed at run time. The RowSet interface provides a set of JavaBeans properties that allow a RowSet instance to be configured to connect to a JDBC data source and read some data from the data source. A group of setter methods (setInt, setBytes, setString, and so on) provide a way to pass input parameters to a rowset's command property. This command is the SQL query the rowset uses when it gets its data from a relational database, which is generally the case. The RowSet interface supports JavaBeans events, allowing other components in an application to be notified when an event occurs on a rowset, such as a change in its value. The RowSet interface is unique in that it is intended to be implemented using the rest of the JDBC API. In other words, a RowSet implementation is a layer of software that executes `on top` of a JDBC driver. Implementations of the RowSet interface can be provided by anyone, including JDBC driver vendors who want to provide a RowSet implementation as part of their JDBC products. A RowSet object may make a connection with a data source and maintain that connection throughout its life cycle, in which case it is called a connected rowset. A rowset may also make a connection with a data source, get data from it, and then close the connection. Such a rowset is called a disconnected rowset. A disconnected rowset may make changes to its data while it is disconnected and then send the changes back to the original source of the data, but it must reestablish a connection to do so. A disconnected rowset may have a reader (a RowSetReader object) and a writer (a RowSetWriter object) associated with it. The reader may be implemented in many different ways to populate a rowset with data, including getting data from a non-relational data source. The writer can also be implemented in many different ways to propagate changes made to the rowset's data back to the underlying data source. Rowsets are easy to use. The RowSet interface extends the standard java.sql.ResultSet interface. The RowSetMetaData interface extends the java.sql.ResultSetMetaData interface. Thus, developers familiar with the JDBC API will have to learn a minimal number of new APIs to use rowsets. In addition, third-party software tools that work with JDBC ResultSet objects will also easily be made to work with rowsets.
(add-row-set-listener this listener)
Registers the given listener so that it will be notified of events that occur on this RowSet object.
listener - a component that has implemented the RowSetListener interface and wants to be notified when events occur on this RowSet object - javax.sql.RowSetListener
Registers the given listener so that it will be notified of events that occur on this RowSet object. listener - a component that has implemented the RowSetListener interface and wants to be notified when events occur on this RowSet object - `javax.sql.RowSetListener`
(clear-parameters this)
Clears the parameters set for this RowSet object's command. In general, parameter values remain in force for repeated use of a RowSet object. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values, which can be done by calling the method clearParameters.
throws: java.sql.SQLException - if a database access error occurs
Clears the parameters set for this RowSet object's command. In general, parameter values remain in force for repeated use of a RowSet object. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values, which can be done by calling the method clearParameters. throws: java.sql.SQLException - if a database access error occurs
(execute this)
Fills this RowSet object with data.
The execute method may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map.
The execute method may use the following properties to create a statement to execute a command: command, read only, maximum field size, maximum rows, escape processing, and query timeout.
If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored.
If this RowSet object does not maintain a continuous connection with its source of data, it may use a reader (a RowSetReader object) to fill itself with data. In this case, a reader will have been registered with this RowSet object, and the method execute will call on the reader's readData method as part of its implementation.
throws: java.sql.SQLException - if a database access error occurs or any of the properties necessary for making a connection and creating a statement have not been set
Fills this RowSet object with data. The execute method may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map. The execute method may use the following properties to create a statement to execute a command: command, read only, maximum field size, maximum rows, escape processing, and query timeout. If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored. If this RowSet object does not maintain a continuous connection with its source of data, it may use a reader (a RowSetReader object) to fill itself with data. In this case, a reader will have been registered with this RowSet object, and the method execute will call on the reader's readData method as part of its implementation. throws: java.sql.SQLException - if a database access error occurs or any of the properties necessary for making a connection and creating a statement have not been set
(get-command this)
Retrieves this RowSet object's command property.
The command property contains a command string, which must be an SQL query, that can be executed to fill the rowset with data. The default value is null.
returns: the command string; may be null - java.lang.String
Retrieves this RowSet object's command property. The command property contains a command string, which must be an SQL query, that can be executed to fill the rowset with data. The default value is null. returns: the command string; may be null - `java.lang.String`
(get-data-source-name this)
Retrieves the logical name that identifies the data source for this RowSet object.
returns: a data source name - java.lang.String
Retrieves the logical name that identifies the data source for this RowSet object. returns: a data source name - `java.lang.String`
(get-escape-processing? this)
Retrieves whether escape processing is enabled for this RowSet object. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database.
returns: true if escape processing is enabled;
false if it is disabled - boolean
throws: java.sql.SQLException - if a database access error occurs
Retrieves whether escape processing is enabled for this RowSet object. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database. returns: true if escape processing is enabled; false if it is disabled - `boolean` throws: java.sql.SQLException - if a database access error occurs
(get-max-field-size this)
Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, LONGVARCHAR, NCHAR and NVARCHAR columns. If the limit is exceeded, the excess data is silently discarded.
returns: the current maximum column size limit; zero means that there
is no limit - int
throws: java.sql.SQLException - if a database access error occurs
Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, LONGVARCHAR, NCHAR and NVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. returns: the current maximum column size limit; zero means that there is no limit - `int` throws: java.sql.SQLException - if a database access error occurs
(get-max-rows this)
Retrieves the maximum number of rows that this RowSet object can contain. If the limit is exceeded, the excess rows are silently dropped.
returns: the current maximum number of rows that this RowSet
object can contain; zero means unlimited - int
throws: java.sql.SQLException - if a database access error occurs
Retrieves the maximum number of rows that this RowSet object can contain. If the limit is exceeded, the excess rows are silently dropped. returns: the current maximum number of rows that this RowSet object can contain; zero means unlimited - `int` throws: java.sql.SQLException - if a database access error occurs
(get-password this)
Retrieves the password used to create a database connection. The password property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object.
returns: the password for making a database connection - java.lang.String
Retrieves the password used to create a database connection. The password property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object. returns: the password for making a database connection - `java.lang.String`
(get-query-timeout this)
Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, an SQLException is thrown.
returns: the current query timeout limit in seconds; zero means
unlimited - int
throws: java.sql.SQLException - if a database access error occurs
Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, an SQLException is thrown. returns: the current query timeout limit in seconds; zero means unlimited - `int` throws: java.sql.SQLException - if a database access error occurs
(get-transaction-isolation this)
Retrieves the transaction isolation level set for this RowSet object.
returns: the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED,
Connection.TRANSACTION_READ_COMMITTED,
Connection.TRANSACTION_REPEATABLE_READ, or
Connection.TRANSACTION_SERIALIZABLE - int
Retrieves the transaction isolation level set for this RowSet object. returns: the transaction isolation level; one of Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE - `int`
(get-type-map this)
Retrieves the Map object associated with this RowSet object, which specifies the custom mapping of SQL user-defined types, if any. The default is for the type map to be empty.
returns: a java.util.Map object containing the names of
SQL user-defined types and the Java classes to which they are
to be mapped - java.util.Map<java.lang.String,java.lang.Class<?>>
throws: java.sql.SQLException - if a database access error occurs
Retrieves the Map object associated with this RowSet object, which specifies the custom mapping of SQL user-defined types, if any. The default is for the type map to be empty. returns: a java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped - `java.util.Map<java.lang.String,java.lang.Class<?>>` throws: java.sql.SQLException - if a database access error occurs
(get-url this)
Retrieves the url property this RowSet object will use to create a connection if it uses the DriverManager instead of a DataSource object to establish the connection. The default value is null.
returns: a string url - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Retrieves the url property this RowSet object will use to create a connection if it uses the DriverManager instead of a DataSource object to establish the connection. The default value is null. returns: a string url - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(get-username this)
Retrieves the username used to create a database connection for this RowSet object. The username property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object.
returns: the username property - java.lang.String
Retrieves the username used to create a database connection for this RowSet object. The username property is set at run time before calling the method execute. It is not usually part of the serialized state of a RowSet object. returns: the username property - `java.lang.String`
(read-only? this)
Retrieves whether this RowSet object is read-only. If updates are possible, the default is for a rowset to be updatable.
Attempts to update a read-only rowset will result in an SQLException being thrown.
returns: true if this RowSet object is
read-only; false if it is updatable - boolean
Retrieves whether this RowSet object is read-only. If updates are possible, the default is for a rowset to be updatable. Attempts to update a read-only rowset will result in an SQLException being thrown. returns: true if this RowSet object is read-only; false if it is updatable - `boolean`
(remove-row-set-listener this listener)
Removes the specified listener from the list of components that will be notified when an event occurs on this RowSet object.
listener - a component that has been registered as a listener for this RowSet object - javax.sql.RowSetListener
Removes the specified listener from the list of components that will be notified when an event occurs on this RowSet object. listener - a component that has been registered as a listener for this RowSet object - `javax.sql.RowSetListener`
(set-array this i x)
Sets the designated parameter in this RowSet object's command with the given Array value. The driver will convert this to the ARRAY value that the Array object represents before sending it to the database.
i - the first parameter is 1, the second is 2, ... - int
x - an object representing an SQL array - java.sql.Array
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given Array value. The driver will convert this to the ARRAY value that the Array object represents before sending it to the database. i - the first parameter is 1, the second is 2, ... - `int` x - an object representing an SQL array - `java.sql.Array` throws: java.sql.SQLException - if a database access error occurs
(set-ascii-stream this parameter-index x)
(set-ascii-stream this parameter-index x length)
Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large ASCII value via a java.io.InputStream rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the Java input stream that contains the ASCII parameter value - java.io.InputStream
length - the number of bytes in the stream - int
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large ASCII value via a java.io.InputStream rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the Java input stream that contains the ASCII parameter value - `java.io.InputStream` length - the number of bytes in the stream - `int` throws: java.sql.SQLException - if a database access error occurs
(set-big-decimal this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given java.math.BigDeciaml value. The driver converts this to an SQL NUMERIC value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.math.BigDecimal
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given java.math.BigDeciaml value. The driver converts this to an SQL NUMERIC value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.math.BigDecimal` throws: java.sql.SQLException - if a database access error occurs
(set-binary-stream this parameter-index x)
(set-binary-stream this parameter-index x length)
Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large binary value via a java.io.InputStream rather than as a LONGVARBINARY parameter. The driver will read the data from the stream as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the java input stream which contains the binary parameter value - java.io.InputStream
length - the number of bytes in the stream - int
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given java.io.InputStream value. It may be more practical to send a very large binary value via a java.io.InputStream rather than as a LONGVARBINARY parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the java input stream which contains the binary parameter value - `java.io.InputStream` length - the number of bytes in the stream - `int` throws: java.sql.SQLException - if a database access error occurs
(set-blob this i x)
(set-blob this parameter-index input-stream length)
Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB
parameter-index - index of the first parameter is 1, the second is 2, ... - int
input-stream - An object that contains the data to set the parameter value to. - java.io.InputStream
length - the number of bytes in the parameter data. - long
throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed PreparedStatement, if parameterIndex does not correspond to a parameter marker in the SQL statement, if the length specified is less than zero or if the number of bytes in the inputstream does not match the specified length.
Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB parameter-index - index of the first parameter is 1, the second is 2, ... - `int` input-stream - An object that contains the data to set the parameter value to. - `java.io.InputStream` length - the number of bytes in the parameter data. - `long` throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed PreparedStatement, if parameterIndex does not correspond to a parameter marker in the SQL statement, if the length specified is less than zero or if the number of bytes in the inputstream does not match the specified length.
(set-boolean this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java boolean value. The driver converts this to an SQL BIT value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - boolean
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java boolean value. The driver converts this to an SQL BIT value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `boolean` throws: java.sql.SQLException - if a database access error occurs
(set-byte this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java byte value. The driver converts this to an SQL TINYINT value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - byte
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java byte value. The driver converts this to an SQL TINYINT value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `byte` throws: java.sql.SQLException - if a database access error occurs
(set-bytes this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java array of byte values. Before sending it to the database, the driver converts this to an SQL VARBINARY or LONGVARBINARY value, depending on the argument's size relative to the driver's limits on VARBINARY values.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - byte[]
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java array of byte values. Before sending it to the database, the driver converts this to an SQL VARBINARY or LONGVARBINARY value, depending on the argument's size relative to the driver's limits on VARBINARY values. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `byte[]` throws: java.sql.SQLException - if a database access error occurs
(set-character-stream this parameter-index reader)
(set-character-stream this parameter-index reader length)
Sets the designated parameter in this RowSet object's command to the given java.io.Reader value. It may be more practical to send a very large UNICODE value via a java.io.Reader rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file.
Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
parameter-index - the first parameter is 1, the second is 2, ... - int
reader - the Reader object that contains the UNICODE data to be set - java.io.Reader
length - the number of characters in the stream - int
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given java.io.Reader value. It may be more practical to send a very large UNICODE value via a java.io.Reader rather than as a LONGVARCHAR parameter. The driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface. parameter-index - the first parameter is 1, the second is 2, ... - `int` reader - the Reader object that contains the UNICODE data to be set - `java.io.Reader` length - the number of characters in the stream - `int` throws: java.sql.SQLException - if a database access error occurs
(set-clob this i x)
(set-clob this parameter-index reader length)
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB
parameter-index - index of the first parameter is 1, the second is 2, ... - int
reader - An object that contains the data to set the parameter value to. - java.io.Reader
length - the number of characters in the parameter data. - long
throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed PreparedStatement, if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero.
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB parameter-index - index of the first parameter is 1, the second is 2, ... - `int` reader - An object that contains the data to set the parameter value to. - `java.io.Reader` length - the number of characters in the parameter data. - `long` throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed PreparedStatement, if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero.
(set-command this cmd)
Sets this RowSet object's command property to the given SQL query.
This property is optional when a rowset gets its data from a data source that does not support commands, such as a spreadsheet.
cmd - the SQL query that will be used to get the data for this RowSet object; may be null - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets this RowSet object's command property to the given SQL query. This property is optional when a rowset gets its data from a data source that does not support commands, such as a spreadsheet. cmd - the SQL query that will be used to get the data for this RowSet object; may be null - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(set-concurrency this concurrency)
Sets the concurrency of this RowSet object to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by default ResultSet.CONCUR_READ_ONLY
concurrency - one of the ResultSet constants specifying a concurrency level: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE - int
throws: java.sql.SQLException - if a database access error occurs
Sets the concurrency of this RowSet object to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by default ResultSet.CONCUR_READ_ONLY concurrency - one of the ResultSet constants specifying a concurrency level: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE - `int` throws: java.sql.SQLException - if a database access error occurs
(set-data-source-name this name)
Sets the data source name property for this RowSet object to the given String.
The value of the data source name property can be used to do a lookup of a DataSource object that has been registered with a naming service. After being retrieved, the DataSource object can be used to create a connection to the data source that it represents.
name - the logical name of the data source for this RowSet object; may be null - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets the data source name property for this RowSet object to the given String. The value of the data source name property can be used to do a lookup of a DataSource object that has been registered with a naming service. After being retrieved, the DataSource object can be used to create a connection to the data source that it represents. name - the logical name of the data source for this RowSet object; may be null - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(set-date this parameter-index x)
(set-date this parameter-index x cal)
Sets the designated parameter in this RowSet object's command with the given java.sql.Date value. The driver will convert this to an SQL DATE value, using the given java.util.Calendar object to calculate the date.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.sql.Date
cal - the java.util.Calendar object to use for calculating the date - java.util.Calendar
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given java.sql.Date value. The driver will convert this to an SQL DATE value, using the given java.util.Calendar object to calculate the date. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.sql.Date` cal - the java.util.Calendar object to use for calculating the date - `java.util.Calendar` throws: java.sql.SQLException - if a database access error occurs
(set-double this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java double value. The driver converts this to an SQL DOUBLE value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - double
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java double value. The driver converts this to an SQL DOUBLE value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `double` throws: java.sql.SQLException - if a database access error occurs
(set-escape-processing this enable)
Sets escape processing for this RowSet object on or off. If escape scanning is on (the default), the driver will do escape substitution before sending an SQL statement to the database.
enable - true to enable escape processing; false to disable it - boolean
throws: java.sql.SQLException - if a database access error occurs
Sets escape processing for this RowSet object on or off. If escape scanning is on (the default), the driver will do escape substitution before sending an SQL statement to the database. enable - true to enable escape processing; false to disable it - `boolean` throws: java.sql.SQLException - if a database access error occurs
(set-float this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java float value. The driver converts this to an SQL REAL value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - float
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java float value. The driver converts this to an SQL REAL value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `float` throws: java.sql.SQLException - if a database access error occurs
(set-int this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java int value. The driver converts this to an SQL INTEGER value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - int
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java int value. The driver converts this to an SQL INTEGER value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `int` throws: java.sql.SQLException - if a database access error occurs
(set-long this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java long value. The driver converts this to an SQL BIGINT value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - long
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java long value. The driver converts this to an SQL BIGINT value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `long` throws: java.sql.SQLException - if a database access error occurs
(set-max-field-size this max)
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, LONGVARCHAR, NCHAR and NVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.
max - the new max column size limit in bytes; zero means unlimited - int
throws: java.sql.SQLException - if a database access error occurs
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only to BINARY, VARBINARY, LONGVARBINARYBINARY, CHAR, VARCHAR, LONGVARCHAR, NCHAR and NVARCHAR columns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256. max - the new max column size limit in bytes; zero means unlimited - `int` throws: java.sql.SQLException - if a database access error occurs
(set-max-rows this max)
Sets the maximum number of rows that this RowSet object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped.
max - the new maximum number of rows; zero means unlimited - int
throws: java.sql.SQLException - if a database access error occurs
Sets the maximum number of rows that this RowSet object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped. max - the new maximum number of rows; zero means unlimited - `int` throws: java.sql.SQLException - if a database access error occurs
(set-n-character-stream this parameter-index value)
(set-n-character-stream this parameter-index value length)
Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.
parameter-index - of the first parameter is 1, the second is 2, ... - int
value - the parameter value - java.io.Reader
length - the number of characters in the parameter data. - long
throws: java.sql.SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database. parameter-index - of the first parameter is 1, the second is 2, ... - `int` value - the parameter value - `java.io.Reader` length - the number of characters in the parameter data. - `long` throws: java.sql.SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
(set-n-clob this parameter-name value)
(set-n-clob this parameter-name reader length)
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB
parameter-name - the name of the parameter to be set - java.lang.String
reader - An object that contains the data to set the parameter value to. - java.io.Reader
length - the number of characters in the parameter data. - long
throws: java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB parameter-name - the name of the parameter to be set - `java.lang.String` reader - An object that contains the data to set the parameter value to. - `java.io.Reader` length - the number of characters in the parameter data. - `long` throws: java.sql.SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
(set-n-string this parameter-index value)
Sets the designated parameter to the given String object. 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 database.
parameter-index - of the first parameter is 1, the second is 2, ... - int
value - the parameter value - java.lang.String
throws: java.sql.SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
Sets the designated parameter to the given String object. 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 database. parameter-index - of the first parameter is 1, the second is 2, ... - `int` value - the parameter value - `java.lang.String` throws: java.sql.SQLException - if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs
(set-null this parameter-index sql-type)
(set-null this param-index sql-type type-name)
Sets the designated parameter in this RowSet object's SQL command to SQL NULL. This version of the method setNull should be used for SQL user-defined types (UDTs) and REF type parameters. Examples of UDTs include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.
Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL UDT or REF parameter. In the case of a UDT, the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it.
Although it is intended for UDT and REF parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.
param-index - the first parameter is 1, the second is 2, ... - int
sql-type - a value from java.sql.Types - int
type-name - the fully qualified name of an SQL UDT or the type name of the SQL structured type being referenced by a REF type; ignored if the parameter is not a UDT or REF type - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's SQL command to SQL NULL. This version of the method setNull should be used for SQL user-defined types (UDTs) and REF type parameters. Examples of UDTs include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL UDT or REF parameter. In the case of a UDT, the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for UDT and REF parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored. param-index - the first parameter is 1, the second is 2, ... - `int` sql-type - a value from java.sql.Types - `int` type-name - the fully qualified name of an SQL UDT or the type name of the SQL structured type being referenced by a REF type; ignored if the parameter is not a UDT or REF type - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(set-object this parameter-name x)
(set-object this parameter-index x target-sql-type)
(set-object this parameter-index x target-sql-type scale-or-length)
Sets the designated parameter in this RowSet object's command with the given Java Object. For integral values, the java.lang equivalent objects should be used (for example, an instance of the class Integer for an int).
If the second argument is an InputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader then the reader must contain the number of characters specified * by scaleOrLength. If these conditions are not true the driver will generate a SQLException when the prepared statement is executed.
The given Java object will be converted to the targetSqlType before being sent to the database.
If the object is of a class implementing SQLData, the rowset should call the method SQLData.writeSQL to write the object to an SQLOutput 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.
Note that this method may be used to pass datatabase-specific abstract data types.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the object containing the input parameter value - java.lang.Object
target-sql-type - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. - int
scale-or-length - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored. - int
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given Java Object. For integral values, the java.lang equivalent objects should be used (for example, an instance of the class Integer for an int). If the second argument is an InputStream then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is a Reader then the reader must contain the number of characters specified * by scaleOrLength. If these conditions are not true the driver will generate a SQLException when the prepared statement is executed. The given Java object will be converted to the targetSqlType before being sent to the database. If the object is of a class implementing SQLData, the rowset should call the method SQLData.writeSQL to write the object to an SQLOutput 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. Note that this method may be used to pass datatabase-specific abstract data types. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the object containing the input parameter value - `java.lang.Object` target-sql-type - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. - `int` scale-or-length - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For Java Object types InputStream and Reader, this is the length of the data in the stream or reader. For all other types, this value will be ignored. - `int` throws: java.sql.SQLException - if a database access error occurs
(set-password this password)
Sets the database password for this RowSet object to the given String.
password - the password string - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets the database password for this RowSet object to the given String. password - the password string - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(set-query-timeout this seconds)
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, an SQLException is thrown.
seconds - the new query timeout limit in seconds; zero means that there is no limit - int
throws: java.sql.SQLException - if a database access error occurs
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, an SQLException is thrown. seconds - the new query timeout limit in seconds; zero means that there is no limit - `int` throws: java.sql.SQLException - if a database access error occurs
(set-read-only this value)
Sets whether this RowSet object is read-only to the given boolean.
value - true if read-only; false if updatable - boolean
throws: java.sql.SQLException - if a database access error occurs
Sets whether this RowSet object is read-only to the given boolean. value - true if read-only; false if updatable - `boolean` throws: java.sql.SQLException - if a database access error occurs
(set-ref this i x)
Sets the designated parameter in this RowSet object's command with the given Ref value. The driver will convert this to the appropriate REF(<structured-type>) value.
i - the first parameter is 1, the second is 2, ... - int
x - an object representing data of an SQL REF type - java.sql.Ref
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given Ref value. The driver will convert this to the appropriate REF(<structured-type>) value. i - the first parameter is 1, the second is 2, ... - `int` x - an object representing data of an SQL REF type - `java.sql.Ref` throws: java.sql.SQLException - if a database access error occurs
(set-row-id this parameter-index x)
Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.sql.RowId
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.sql.RowId` throws: java.sql.SQLException - if a database access error occurs
(set-short this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java short value. The driver converts this to an SQL SMALLINT value before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - short
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java short value. The driver converts this to an SQL SMALLINT value before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `short` throws: java.sql.SQLException - if a database access error occurs
(set-sqlxml this parameter-index xml-object)
Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.
parameter-index - index of the first parameter is 1, the second is 2, ... - int
xml-object - a SQLXML object that maps an SQL XML value - java.sql.SQLXML
throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed result set, 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.
Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database. parameter-index - index of the first parameter is 1, the second is 2, ... - `int` xml-object - a SQLXML object that maps an SQL XML value - `java.sql.SQLXML` throws: java.sql.SQLException - if a database access error occurs, this method is called on a closed result set, 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.
(set-string this parameter-index x)
Sets the designated parameter in this RowSet object's command to the given Java String value. Before sending it to the database, the driver converts this to an SQL VARCHAR or LONGVARCHAR value, depending on the argument's size relative to the driver's limits on VARCHAR values.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command to the given Java String value. Before sending it to the database, the driver converts this to an SQL VARCHAR or LONGVARCHAR value, depending on the argument's size relative to the driver's limits on VARCHAR values. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
(set-time this parameter-index x)
(set-time this parameter-index x cal)
Sets the designated parameter in this RowSet object's command with the given java.sql.Time value. The driver will convert this to an SQL TIME value, using the given java.util.Calendar object to calculate it, before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.sql.Time
cal - the java.util.Calendar object to use for calculating the time - java.util.Calendar
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given java.sql.Time value. The driver will convert this to an SQL TIME value, using the given java.util.Calendar object to calculate it, before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.sql.Time` cal - the java.util.Calendar object to use for calculating the time - `java.util.Calendar` throws: java.sql.SQLException - if a database access error occurs
(set-timestamp this parameter-index x)
(set-timestamp this parameter-index x cal)
Sets the designated parameter in this RowSet object's command with the given java.sql.Timestamp value. The driver will convert this to an SQL TIMESTAMP value, using the given java.util.Calendar object to calculate it, before sending it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the parameter value - java.sql.Timestamp
cal - the java.util.Calendar object to use for calculating the timestamp - java.util.Calendar
throws: java.sql.SQLException - if a database access error occurs
Sets the designated parameter in this RowSet object's command with the given java.sql.Timestamp value. The driver will convert this to an SQL TIMESTAMP value, using the given java.util.Calendar object to calculate it, before sending it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the parameter value - `java.sql.Timestamp` cal - the java.util.Calendar object to use for calculating the timestamp - `java.util.Calendar` throws: java.sql.SQLException - if a database access error occurs
(set-transaction-isolation this level)
Sets the transaction isolation level for this RowSet object.
level - the transaction isolation level; one of Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE - int
throws: java.sql.SQLException - if a database access error occurs
Sets the transaction isolation level for this RowSet object. level - the transaction isolation level; one of Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE - `int` throws: java.sql.SQLException - if a database access error occurs
(set-type this type)
Sets the type of this RowSet object to the given type. This method is used to change the type of a rowset, which is by default read-only and non-scrollable.
type - one of the ResultSet constants specifying a type: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE - int
throws: java.sql.SQLException - if a database access error occurs
Sets the type of this RowSet object to the given type. This method is used to change the type of a rowset, which is by default read-only and non-scrollable. type - one of the ResultSet constants specifying a type: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE - `int` throws: java.sql.SQLException - if a database access error occurs
(set-type-map this map)
Installs the given java.util.Map object as the default type map for this RowSet object. This type map will be used unless another type map is supplied as a method parameter.
map - a java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped - java.util.Map
throws: java.sql.SQLException - if a database access error occurs
Installs the given java.util.Map object as the default type map for this RowSet object. This type map will be used unless another type map is supplied as a method parameter. map - a java.util.Map object containing the names of SQL user-defined types and the Java classes to which they are to be mapped - `java.util.Map` throws: java.sql.SQLException - if a database access error occurs
(set-url this parameter-index x)
Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database.
parameter-index - the first parameter is 1, the second is 2, ... - int
x - the java.net.URL object to be set - java.net.URL
throws: java.sql.SQLException - if a database access error occurs or this method is called on a closed PreparedStatement
Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database. parameter-index - the first parameter is 1, the second is 2, ... - `int` x - the java.net.URL object to be set - `java.net.URL` throws: java.sql.SQLException - if a database access error occurs or this method is called on a closed PreparedStatement
(set-username this name)
Sets the username property for this RowSet object to the given String.
name - a user name - java.lang.String
throws: java.sql.SQLException - if a database access error occurs
Sets the username property for this RowSet object to the given String. name - a user name - `java.lang.String` throws: java.sql.SQLException - if a database access error occurs
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close