Statement
interface Statement : Wrapper, AutoCloseable
java.sql.Statement |
The object used for executing a static SQL statement and returning the results it produces.
By default, only one ResultSet
object per Statement
object can be open at the same time. Therefore, if the reading of one ResultSet
object is interleaved with the reading of another, each must have been generated by different Statement
objects. All execution methods in the Statement
interface implicitly close a statment's current ResultSet
object if an open one exists.
Summary
Constants | |
---|---|
static Int |
The constant indicating that all |
static Int |
The constant indicating that the current |
static Int |
The constant indicating that an error occured while executing a batch statement. |
static Int |
The constant indicating that the current |
static Int |
The constant indicating that generated keys should not be made available for retrieval. |
static Int |
The constant indicating that generated keys should be made available for retrieval. |
static Int |
The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available. |
Public methods | |
---|---|
abstract Unit |
Adds the given SQL command to the current list of commmands for this |
abstract Unit |
cancel() Cancels this |
abstract Unit |
Empties this |
abstract Unit |
Clears all the warnings reported on this |
abstract Unit |
close() Releases this |
abstract Boolean |
Executes the given SQL statement, which may return multiple results. |
abstract Boolean |
Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. |
abstract Boolean |
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. |
abstract Boolean |
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. |
abstract IntArray! |
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. |
abstract ResultSet! |
executeQuery(sql: String!) Executes the given SQL statement, which returns a single |
abstract Int |
executeUpdate(sql: String!) Executes the given SQL statement, which may be an |
abstract Int |
executeUpdate(sql: String!, autoGeneratedKeys: Int) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this |
abstract Int |
executeUpdate(sql: String!, columnIndexes: IntArray!) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. |
abstract Int |
executeUpdate(sql: String!, columnNames: Array<String!>!) Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. |
abstract Connection! |
Retrieves the |
abstract Int |
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this |
abstract Int |
Retrieves the number of result set rows that is the default fetch size for |
abstract ResultSet! |
Retrieves any auto-generated keys created as a result of executing this |
abstract Int |
Retrieves the maximum number of bytes that can be returned for character and binary column values in a |
abstract Int |
Retrieves the maximum number of rows that a |
abstract Boolean |
Moves to this |
abstract Boolean |
getMoreResults(current: Int) Moves to this |
abstract Int |
Retrieves the number of seconds the driver will wait for a |
abstract ResultSet! |
Retrieves the current result as a |
abstract Int |
Retrieves the result set concurrency for |
abstract Int |
Retrieves the result set holdability for |
abstract Int |
Retrieves the result set type for |
abstract Int |
Retrieves the current result as an update count; if the result is a |
abstract SQLWarning! |
Retrieves the first warning reported by calls on this |
abstract Boolean |
isClosed() Retrieves whether this |
abstract Boolean |
Returns a value indicating whether the |
abstract Unit |
setCursorName(name: String!) Sets the SQL cursor name to the given |
abstract Unit |
setEscapeProcessing(enable: Boolean) Sets escape processing on or off. |
abstract Unit |
setFetchDirection(direction: Int) Gives the driver a hint as to the direction in which rows will be processed in |
abstract Unit |
setFetchSize(rows: Int) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for |
abstract Unit |
setMaxFieldSize(max: Int) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a |
abstract Unit |
setMaxRows(max: Int) Sets the limit for the maximum number of rows that any |
abstract Unit |
setPoolable(poolable: Boolean) Requests that a |
abstract Unit |
setQueryTimeout(seconds: Int) Sets the number of seconds the driver will wait for a |
Inherited functions | |
---|---|
Constants
CLOSE_ALL_RESULTS
static val CLOSE_ALL_RESULTS: Int
The constant indicating that all ResultSet
objects that have previously been kept open should be closed when calling getMoreResults
.
Value: 3
CLOSE_CURRENT_RESULT
static val CLOSE_CURRENT_RESULT: Int
The constant indicating that the current ResultSet
object should be closed when calling getMoreResults
.
Value: 1
EXECUTE_FAILED
static val EXECUTE_FAILED: Int
The constant indicating that an error occured while executing a batch statement.
Value: -3
KEEP_CURRENT_RESULT
static val KEEP_CURRENT_RESULT: Int
The constant indicating that the current ResultSet
object should not be closed when calling getMoreResults
.
Value: 2
NO_GENERATED_KEYS
static val NO_GENERATED_KEYS: Int
The constant indicating that generated keys should not be made available for retrieval.
Value: 2
RETURN_GENERATED_KEYS
static val RETURN_GENERATED_KEYS: Int
The constant indicating that generated keys should be made available for retrieval.
Value: 1
SUCCESS_NO_INFO
static val SUCCESS_NO_INFO: Int
The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available.
Value: -2
Public methods
addBatch
abstract fun addBatch(sql: String!): Unit
Adds the given SQL command to the current list of commmands for this Statement
object. The commands in this list can be executed as a batch by calling the method executeBatch
.
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: typically this is a SQL INSERT or UPDATE statement |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the driver does not support batch updates, the method is called on a PreparedStatement or CallableStatement |
cancel
abstract fun cancel(): Unit
Cancels this Statement
object if both the DBMS and driver support aborting an SQL statement. This method can be used by one thread to cancel a statement that is being executed by another thread.
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
clearBatch
abstract fun clearBatch(): Unit
Empties this Statement
object's current list of SQL commands.
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the driver does not support batch updates |
clearWarnings
abstract fun clearWarnings(): Unit
Clears all the warnings reported on this Statement
object. After a call to this method, the method getWarnings
will return null
until a new warning is reported for this Statement
object.
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
close
abstract fun close(): Unit
Releases this Statement
object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed. It is generally good practice to release resources as soon as you are finished with them to avoid tying up database resources.
Calling the method close
on a Statement
object that is already closed has no effect.
Note:When a Statement
object is closed, its current ResultSet
object, if one exists, is also closed.
Exceptions | |
---|---|
java.lang.Exception |
if this resource cannot be closed |
java.sql.SQLException |
if a database access error occurs |
execute
abstract fun execute(sql: String!): Boolean
Executes the given SQL statement, which may return multiple results. In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The execute
method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to move to any subsequent result(s).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: any SQL statement |
Return | |
---|---|
Boolean |
true if the first result is a ResultSet object; false if it is an update count or there are no results |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the method is called on a PreparedStatement or CallableStatement |
See Also
execute
abstract fun execute(
sql: String!,
autoGeneratedKeys: Int
): Boolean
Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval. The driver will ignore this signal if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The execute
method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to move to any subsequent result(s).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: any SQL statement |
autoGeneratedKeys |
Int: a constant indicating whether auto-generated keys should be made available for retrieval using the method getGeneratedKeys ; one of the following constants: Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS |
Return | |
---|---|
Boolean |
true if the first result is a ResultSet object; false if it is an update count or there are no results |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the second parameter supplied to this method is not Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS , the method is called on a PreparedStatement or CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS |
execute
abstract fun execute(
sql: String!,
columnIndexes: IntArray!
): Boolean
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Under some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The execute
method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to move to any subsequent result(s).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: any SQL statement |
columnIndexes |
IntArray!: an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys |
Return | |
---|---|
Boolean |
true if the first result is a ResultSet object; false if it is an update count or there are no results |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the elements in the int array passed to this method are not valid column indexes, the method is called on a PreparedStatement or CallableStatement |
See Also
execute
abstract fun execute(
sql: String!,
columnNames: Array<String!>!
): Boolean
Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
In some (uncommon) situations, a single SQL statement may return multiple result sets and/or update counts. Normally you can ignore this unless you are (1) executing a stored procedure that you know may return multiple results or (2) you are dynamically executing an unknown SQL string.
The execute
method executes an SQL statement and indicates the form of the first result. You must then use the methods getResultSet
or getUpdateCount
to retrieve the result, and getMoreResults
to move to any subsequent result(s).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: any SQL statement |
columnNames |
Array<String!>!: an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the method getGeneratedKeys |
Return | |
---|---|
Boolean |
true if the next result is a ResultSet object; false if it is an update count or there are no more results |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement ,the elements of the String array passed to this method are not valid column names, the method is called on a PreparedStatement or CallableStatement |
executeBatch
abstract fun executeBatch(): IntArray!
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. The int
elements of the array that is returned are ordered to correspond to the commands in the batch, which are ordered according to the order in which they were added to the batch. The elements in the array returned by the method executeBatch
may be one of the following:
- A number greater than or equal to zero -- indicates that the command was processed successfully and is an update count giving the number of rows in the database that were affected by the command's execution
- A value of
SUCCESS_NO_INFO
-- indicates that the command was processed successfully but that the number of rows affected is unknownIf one of the commands in a batch update fails to execute properly, this method throws a
BatchUpdateException
, and a JDBC driver may or may not continue to process the remaining commands in the batch. However, the driver's behavior must be consistent with a particular DBMS, either always continuing to process commands or never continuing to process commands. If the driver continues processing after a failure, the array returned by the methodBatchUpdateException.getUpdateCounts
will contain as many elements as there are commands in the batch, and at least one of the elements will be the following: - A value of
EXECUTE_FAILED
-- indicates that the command failed to execute successfully and occurs only if a driver continues to process commands after a command fails
The possible implementations and return values have been modified in the Java 2 SDK, Standard Edition, version 1.3 to accommodate the option of continuing to proccess commands in a batch update after a BatchUpdateException
obejct has been thrown.
Return | |
---|---|
IntArray! |
an array of update counts containing one element for each command in the batch. The elements of the array are ordered according to the order in which commands were added to the batch. |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the driver does not support batch statements. Throws BatchUpdateException (a subclass of SQLException ) if one of the commands sent to the database fails to execute properly or attempts to return a result set. |
executeQuery
abstract fun executeQuery(sql: String!): ResultSet!
Executes the given SQL statement, which returns a single ResultSet
object.
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: an SQL statement to be sent to the database, typically a static SQL SELECT statement |
Return | |
---|---|
ResultSet! |
a ResultSet object that contains the data produced by the given query; never null |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the given SQL statement produces anything other than a single ResultSet object, the method is called on a PreparedStatement or CallableStatement |
executeUpdate
abstract fun executeUpdate(sql: String!): Int
Executes the given SQL statement, which may be an INSERT
, UPDATE
, or DELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: an SQL Data Manipulation Language (DML) statement, such as INSERT , UPDATE or DELETE ; or an SQL statement that returns nothing, such as a DDL statement. |
Return | |
---|---|
Int |
either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the given SQL statement produces a ResultSet object, the method is called on a PreparedStatement or CallableStatement |
executeUpdate
abstract fun executeUpdate(
sql: String!,
autoGeneratedKeys: Int
): Int
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this Statement
object should be made available for retrieval. The driver will ignore the flag if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: an SQL Data Manipulation Language (DML) statement, such as INSERT , UPDATE or DELETE ; or an SQL statement that returns nothing, such as a DDL statement. |
autoGeneratedKeys |
Int: a flag indicating whether auto-generated keys should be made available for retrieval; one of the following constants: Statement.RETURN_GENERATED_KEYS Statement.NO_GENERATED_KEYS |
Return | |
---|---|
Int |
either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing |
Exceptions | |
---|---|
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the given SQL statement returns a ResultSet object, the given constant is not one of those allowed, the method is called on a PreparedStatement or CallableStatement |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYS |
executeUpdate
abstract fun executeUpdate(
sql: String!,
columnIndexes: IntArray!
): Int
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the indexes of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: an SQL Data Manipulation Language (DML) statement, such as INSERT , UPDATE or DELETE ; or an SQL statement that returns nothing, such as a DDL statement. |
columnIndexes |
IntArray!: an array of column indexes indicating the columns that should be returned from the inserted row |
Return | |
---|---|
Int |
either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the SQL statement returns a ResultSet object,the second argument supplied to this method is not an int array whose elements are valid column indexes, the method is called on a PreparedStatement or CallableStatement |
executeUpdate
abstract fun executeUpdate(
sql: String!,
columnNames: Array<String!>!
): Int
Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval. This array contains the names of the columns in the target table that contain the auto-generated keys that should be made available. The driver will ignore the array if the SQL statement is not an INSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).
Note:This method cannot be called on a PreparedStatement
or CallableStatement
.
Parameters | |
---|---|
sql |
String!: an SQL Data Manipulation Language (DML) statement, such as INSERT , UPDATE or DELETE ; or an SQL statement that returns nothing, such as a DDL statement. |
columnNames |
Array<String!>!: an array of the names of the columns that should be returned from the inserted row |
Return | |
---|---|
Int |
either the row count for INSERT , UPDATE , or DELETE statements, or 0 for SQL statements that return nothing |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLTimeoutException |
when the driver has determined that the timeout value that was specified by the setQueryTimeout method has been exceeded and has at least attempted to cancel the currently running Statement |
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement , the SQL statement returns a ResultSet object, the second argument supplied to this method is not a String array whose elements are valid column names, the method is called on a PreparedStatement or CallableStatement |
getConnection
abstract fun getConnection(): Connection!
Retrieves the Connection
object that produced this Statement
object.
Return | |
---|---|
Connection! |
the connection that produced this statement |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
getFetchDirection
abstract fun getFetchDirection(): Int
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this Statement
object. If this Statement
object has not set a fetch direction by calling the method setFetchDirection
, the return value is implementation-specific.
Return | |
---|---|
Int |
the default fetch direction for result sets generated from this Statement object |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getFetchSize
abstract fun getFetchSize(): Int
Retrieves the number of result set rows that is the default fetch size for ResultSet
objects generated from this Statement
object. If this Statement
object has not set a fetch size by calling the method setFetchSize
, the return value is implementation-specific.
Return | |
---|---|
Int |
the default fetch size for result sets generated from this Statement object |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getGeneratedKeys
abstract fun getGeneratedKeys(): ResultSet!
Retrieves any auto-generated keys created as a result of executing this Statement
object. If this Statement
object did not generate any keys, an empty ResultSet
object is returned.
Note:If the columns which represent the auto-generated keys were not specified, the JDBC driver implementation will determine the columns which best represent the auto-generated keys.
Return | |
---|---|
ResultSet! |
a ResultSet object containing the auto-generated key(s) generated by the execution of this Statement object |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
getMaxFieldSize
abstract fun getMaxFieldSize(): Int
Retrieves the maximum number of bytes that can be returned for character and binary column values in a ResultSet
object produced by this Statement
object. This limit applies only to BINARY
, VARBINARY
, LONGVARBINARY
, CHAR
, VARCHAR
, NCHAR
, NVARCHAR
, LONGNVARCHAR
and LONGVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded.
Return | |
---|---|
Int |
the current column size limit for columns storing character and binary values; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getMaxRows
abstract fun getMaxRows(): Int
Retrieves the maximum number of rows that a ResultSet
object produced by this Statement
object can contain. If this limit is exceeded, the excess rows are silently dropped.
Return | |
---|---|
Int |
the current maximum number of rows for a ResultSet object produced by this Statement object; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getMoreResults
abstract fun getMoreResults(): Boolean
Moves to this Statement
object's next result, returns true
if it is a ResultSet
object, and implicitly closes any current ResultSet
object(s) obtained with the method getResultSet
.
There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
Return | |
---|---|
Boolean |
true if the next result is a ResultSet object; false if it is an update count or there are no more results |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getMoreResults
abstract fun getMoreResults(current: Int): Boolean
Moves to this Statement
object's next result, deals with any current ResultSet
object(s) according to the instructions specified by the given flag, and returns true
if the next result is a ResultSet
object.
There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults(current) == false) && (stmt.getUpdateCount() == -1))
Parameters | |
---|---|
current |
Int: one of the following Statement constants indicating what should happen to current ResultSet objects obtained using the method getResultSet : Statement.CLOSE_CURRENT_RESULT , Statement.KEEP_CURRENT_RESULT , or Statement.CLOSE_ALL_RESULTS |
Return | |
---|---|
Boolean |
true if the next result is a ResultSet object; false if it is an update count or there are no more results |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the argument supplied is not one of the following: Statement.CLOSE_CURRENT_RESULT , Statement.KEEP_CURRENT_RESULT or Statement.CLOSE_ALL_RESULTS |
java.sql.SQLFeatureNotSupportedException |
if DatabaseMetaData.supportsMultipleOpenResults returns false and either Statement.KEEP_CURRENT_RESULT or Statement.CLOSE_ALL_RESULTS are supplied as the argument. |
See Also
getQueryTimeout
abstract fun getQueryTimeout(): Int
Retrieves the number of seconds the driver will wait for a Statement
object to execute. If the limit is exceeded, a SQLException
is thrown.
Return | |
---|---|
Int |
the current query timeout limit in seconds; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getResultSet
abstract fun getResultSet(): ResultSet!
Retrieves the current result as a ResultSet
object. This method should be called only once per result.
Return | |
---|---|
ResultSet! |
the current result as a ResultSet object or null if the result is an update count or there are no more results |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getResultSetConcurrency
abstract fun getResultSetConcurrency(): Int
Retrieves the result set concurrency for ResultSet
objects generated by this Statement
object.
Return | |
---|---|
Int |
either ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
getResultSetHoldability
abstract fun getResultSetHoldability(): Int
Retrieves the result set holdability for ResultSet
objects generated by this Statement
object.
Return | |
---|---|
Int |
either ResultSet.HOLD_CURSORS_OVER_COMMIT or ResultSet.CLOSE_CURSORS_AT_COMMIT |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
getResultSetType
abstract fun getResultSetType(): Int
Retrieves the result set type for ResultSet
objects generated by this Statement
object.
Return | |
---|---|
Int |
one of ResultSet.TYPE_FORWARD_ONLY , ResultSet.TYPE_SCROLL_INSENSITIVE , or ResultSet.TYPE_SCROLL_SENSITIVE |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
getUpdateCount
abstract fun getUpdateCount(): Int
Retrieves the current result as an update count; if the result is a ResultSet
object or there are no more results, -1 is returned. This method should be called only once per result.
Return | |
---|---|
Int |
the current result as an update count; -1 if the current result is a ResultSet object or there are no more results |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
See Also
getWarnings
abstract fun getWarnings(): SQLWarning!
Retrieves the first warning reported by calls on this Statement
object. Subsequent Statement
object warnings will be chained to this SQLWarning
object.
The warning chain is automatically cleared each time a statement is (re)executed. This method may not be called on a closed Statement
object; doing so will cause an SQLException
to be thrown.
Note: If you are processing a ResultSet
object, any warnings associated with reads on that ResultSet
object will be chained on it rather than on the Statement
object that produced it.
Return | |
---|---|
SQLWarning! |
the first SQLWarning object or null if there are no warnings |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
isClosed
abstract fun isClosed(): Boolean
Retrieves whether this Statement
object has been closed. A Statement
is closed if the method close has been called on it, or if it is automatically closed.
Return | |
---|---|
Boolean |
true if this Statement object is closed; false if it is still open |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs |
isPoolable
abstract fun isPoolable(): Boolean
Returns a value indicating whether the Statement
is poolable or not.
Return | |
---|---|
Boolean |
true if the Statement is poolable; false otherwise
|
Exceptions | |
---|---|
java.sql.SQLException |
if this method is called on a closed Statement
|
setCursorName
abstract fun setCursorName(name: String!): Unit
Sets the SQL cursor name to the given String
, which will be used by subsequent Statement
object execute
methods. This name can then be used in SQL positioned update or delete statements to identify the current row in the ResultSet
object generated by this statement. If the database does not support positioned update/delete, this method is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT
statement should have the form SELECT FOR UPDATE
. If FOR UPDATE
is not present, positioned updates may fail.
Note: By definition, the execution of positioned updates and deletes must be done by a different Statement
object than the one that generated the ResultSet
object being used for positioning. Also, cursor names must be unique within a connection.
Parameters | |
---|---|
name |
String!: the new cursor name, which must be unique within a connection |
Exceptions | |
---|---|
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
setEscapeProcessing
abstract fun setEscapeProcessing(enable: Boolean): Unit
Sets escape processing on or off. If escape scanning is on (the default), the driver will do escape substitution before sending the SQL statement to the database. Note: Since prepared statements have usually been parsed prior to making this call, disabling escape processing for PreparedStatements
objects will have no effect.
Parameters | |
---|---|
enable |
Boolean: true to enable escape processing; false to disable it |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs or this method is called on a closed Statement |
setFetchDirection
abstract fun setFetchDirection(direction: Int): Unit
Gives the driver a hint as to the direction in which rows will be processed in ResultSet
objects created using this Statement
object. The default value is ResultSet.FETCH_FORWARD
.
Note that this method sets the default fetch direction for result sets generated by this Statement
object. Each result set has its own methods for getting and setting its own fetch direction.
Parameters | |
---|---|
direction |
Int: the initial direction for processing rows |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the given direction is not one of ResultSet.FETCH_FORWARD , ResultSet.FETCH_REVERSE , or ResultSet.FETCH_UNKNOWN |
See Also
setFetchSize
abstract fun setFetchSize(rows: Int): Unit
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for ResultSet
objects genrated by this Statement
. If the value specified is zero, then the hint is ignored. The default value is zero.
Parameters | |
---|---|
rows |
Int: the number of rows to fetch |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the condition rows >= 0 is not satisfied. |
See Also
setMaxFieldSize
abstract fun setMaxFieldSize(max: Int): Unit
Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a ResultSet
object produced by this Statement
object. This limit applies only to BINARY
, VARBINARY
, LONGVARBINARY
, CHAR
, VARCHAR
, NCHAR
, NVARCHAR
, LONGNVARCHAR
and LONGVARCHAR
fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.
Parameters | |
---|---|
max |
Int: the new column size limit in bytes; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the condition max >= 0 is not satisfied |
See Also
setMaxRows
abstract fun setMaxRows(max: Int): Unit
Sets the limit for the maximum number of rows that any ResultSet
object generated by this Statement
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.
Parameters | |
---|---|
max |
Int: the new max rows limit; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the condition max >= 0 is not satisfied |
See Also
setPoolable
abstract fun setPoolable(poolable: Boolean): Unit
Requests that a Statement
be pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the applicaiton wants the statement to be pooled. It is up to the statement pool manager as to whether the hint is used.
The poolable value of a statement is applicable to both internal statement caches implemented by the driver and external statement caches implemented by application servers and other applications.
By default, a Statement
is not poolable when created, and a PreparedStatement
and CallableStatement
are poolable when created.
Parameters | |
---|---|
poolable |
Boolean: requests that the statement be pooled if true and that the statement not be pooled if false |
Exceptions | |
---|---|
java.sql.SQLException |
if this method is called on a closed Statement
|
setQueryTimeout
abstract fun setQueryTimeout(seconds: Int): Unit
Sets the number of seconds the driver will wait for a Statement
object to execute to the given number of seconds. By default there is no limit on the amount of time allowed for a running statement to complete. If the limit is exceeded, an SQLTimeoutException
is thrown. A JDBC driver must apply this limit to the execute
, executeQuery
and executeUpdate
methods.
Note: JDBC driver implementations may also apply this limit to ResultSet
methods (consult your driver vendor documentation for details).
Note: In the case of Statement
batching, it is implementation defined as to whether the time-out is applied to individual SQL commands added via the addBatch
method or to the entire batch of SQL commands invoked by the executeBatch
method (consult your driver vendor documentation for details).
Parameters | |
---|---|
seconds |
Int: the new query timeout limit in seconds; zero means there is no limit |
Exceptions | |
---|---|
java.sql.SQLException |
if a database access error occurs, this method is called on a closed Statement or the condition seconds >= 0 is not satisfied |
See Also