Interface Statement
- All Superinterfaces:
AutoCloseable
,Wrapper
- All Known Subinterfaces:
CallableStatement
,PreparedStatement
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 current
ResultSet
object of the statement if an open one exists.
- Since:
- 1.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The constant indicating that allResultSet
objects that have previously been kept open should be closed when callinggetMoreResults
.static final int
The constant indicating that the currentResultSet
object should be closed when callinggetMoreResults
.static final int
The constant indicating that an error occurred while executing a batch statement.static final int
The constant indicating that the currentResultSet
object should not be closed when callinggetMoreResults
.static final int
The constant indicating that generated keys should not be made available for retrieval.static final int
The constant indicating that generated keys should be made available for retrieval.static final int
The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds the given SQL command to the current list of commands for thisStatement
object.void
cancel()
Cancels thisStatement
object if both the DBMS and driver support aborting an SQL statement.void
Empties thisStatement
object's current list of SQL commands.void
Clears all the warnings reported on thisStatement
object.void
close()
Releases thisStatement
object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.void
Specifies that thisStatement
will be closed when all its dependent result sets are closed.default String
enquoteIdentifier
(String identifier, boolean alwaysQuote) Returns a SQL identifier.default String
enquoteLiteral
(String val) Returns aString
enclosed in single quotes.default String
Returns aString
representing a National Character Set Literal enclosed in single quotes and prefixed with a upper case letter N.boolean
Executes the given SQL statement, which may return multiple results.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.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.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.int[]
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.default long[]
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.default long
executeLargeUpdate
(String sql) Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.default long
executeLargeUpdate
(String sql, int autoGeneratedKeys) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatement
object should be made available for retrieval.default long
executeLargeUpdate
(String sql, int[] columnIndexes) 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.default long
executeLargeUpdate
(String sql, String[] columnNames) 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.executeQuery
(String sql) Executes the given SQL statement, which returns a singleResultSet
object.int
executeUpdate
(String sql) Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.int
executeUpdate
(String sql, int autoGeneratedKeys) Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatement
object should be made available for retrieval.int
executeUpdate
(String sql, int[] columnIndexes) 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.int
executeUpdate
(String sql, String[] columnNames) 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.Retrieves theConnection
object that produced thisStatement
object.int
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object.int
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object.Retrieves any auto-generated keys created as a result of executing thisStatement
object.default long
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain.default long
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned.int
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object.int
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain.boolean
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.boolean
getMoreResults
(int current) Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
object.int
Retrieves the number of seconds the driver will wait for aStatement
object to execute.Retrieves the current result as aResultSet
object.int
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.int
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.int
Retrieves the result set type forResultSet
objects generated by thisStatement
object.int
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned.Retrieves the first warning reported by calls on thisStatement
object.boolean
isClosed()
Retrieves whether thisStatement
object has been closed.boolean
Returns a value indicating whether thisStatement
will be closed when all its dependent result sets are closed.boolean
Returns a value indicating whether theStatement
is poolable or not.default boolean
isSimpleIdentifier
(String identifier) Retrieves whetheridentifier
is a simple SQL identifier.void
setCursorName
(String name) Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods.void
setEscapeProcessing
(boolean enable) Sets escape processing on or off.void
setFetchDirection
(int direction) Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object.void
setFetchSize
(int rows) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSet
objects generated by thisStatement
.default void
setLargeMaxRows
(long max) Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number.void
setMaxFieldSize
(int max) Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object.void
setMaxRows
(int max) Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number.void
setPoolable
(boolean poolable) Requests that aStatement
be pooled or not pooled.void
setQueryTimeout
(int seconds) Sets the number of seconds the driver will wait for aStatement
object to execute to the given number of seconds.Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Field Details
-
CLOSE_CURRENT_RESULT
static final int CLOSE_CURRENT_RESULTThe constant indicating that the currentResultSet
object should be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
-
KEEP_CURRENT_RESULT
static final int KEEP_CURRENT_RESULTThe constant indicating that the currentResultSet
object should not be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
-
CLOSE_ALL_RESULTS
static final int CLOSE_ALL_RESULTSThe constant indicating that allResultSet
objects that have previously been kept open should be closed when callinggetMoreResults
.- Since:
- 1.4
- See Also:
-
SUCCESS_NO_INFO
static final int SUCCESS_NO_INFOThe constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available.- Since:
- 1.4
- See Also:
-
EXECUTE_FAILED
static final int EXECUTE_FAILEDThe constant indicating that an error occurred while executing a batch statement.- Since:
- 1.4
- See Also:
-
RETURN_GENERATED_KEYS
static final int RETURN_GENERATED_KEYSThe constant indicating that generated keys should be made available for retrieval.- Since:
- 1.4
- See Also:
-
NO_GENERATED_KEYS
static final int NO_GENERATED_KEYSThe constant indicating that generated keys should not be made available for retrieval.- Since:
- 1.4
- See Also:
-
-
Method Details
-
executeQuery
Executes the given SQL statement, which returns a singleResultSet
object.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- an SQL statement to be sent to the database, typically a static SQLSELECT
statement- Returns:
- a
ResultSet
object that contains the data produced by the given query; nevernull
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement produces anything other than a singleResultSet
object, the method is called on aPreparedStatement
orCallableStatement
SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
-
executeUpdate
Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement produces aResultSet
object, the method is called on aPreparedStatement
orCallableStatement
SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
-
close
Releases thisStatement
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 aStatement
object that is already closed has no effect.Note:When a
Statement
object is closed, its currentResultSet
object, if one exists, is also closed.- Specified by:
close
in interfaceAutoCloseable
- Throws:
SQLException
- if a database access error occurs
-
getMaxFieldSize
Retrieves the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
,NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded.- Returns:
- the current column size limit for columns storing character and binary values; zero means there is no limit
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
setMaxFieldSize
Sets the limit for the maximum number of bytes that can be returned for character and binary column values in aResultSet
object produced by thisStatement
object. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARY
,CHAR
,VARCHAR
,NCHAR
,NVARCHAR
,LONGNVARCHAR
andLONGVARCHAR
fields. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Parameters:
max
- the new column size limit in bytes; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionmax >= 0
is not satisfied- See Also:
-
getMaxRows
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain. If this limit is exceeded, the excess rows are silently dropped.- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
setMaxRows
Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.- Parameters:
max
- the new max rows limit; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionmax >= 0
is not satisfied- See Also:
-
setEscapeProcessing
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.The
Connection
andDataSource
propertyescapeProcessing
may be used to change the default escape processing behavior. A value of true (the default) enables escape Processing for allStatement
objects. A value of false disables escape processing for allStatement
objects. ThesetEscapeProcessing
method may be used to specify the escape processing behavior for an individualStatement
object.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
-true
to enable escape processing;false
to disable it- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
-
getQueryTimeout
Retrieves the number of seconds the driver will wait for aStatement
object to execute. If the limit is exceeded, aSQLException
is thrown.- Returns:
- the current query timeout limit in seconds; zero means there is no limit
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
setQueryTimeout
Sets the number of seconds the driver will wait for aStatement
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, anSQLTimeoutException
is thrown. A JDBC driver must apply this limit to theexecute
,executeQuery
andexecuteUpdate
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 theaddBatch
method or to the entire batch of SQL commands invoked by theexecuteBatch
method (consult your driver vendor documentation for details).- Parameters:
seconds
- the new query timeout limit in seconds; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionseconds >= 0
is not satisfied- See Also:
-
cancel
Cancels thisStatement
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.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
-
getWarnings
Retrieves the first warning reported by calls on thisStatement
object. SubsequentStatement
object warnings will be chained to thisSQLWarning
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 anSQLException
to be thrown.Note: If you are processing a
ResultSet
object, any warnings associated with reads on thatResultSet
object will be chained on it rather than on theStatement
object that produced it.- Returns:
- the first
SQLWarning
object ornull
if there are no warnings - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
-
clearWarnings
Clears all the warnings reported on thisStatement
object. After a call to this method, the methodgetWarnings
will returnnull
until a new warning is reported for thisStatement
object.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
-
setCursorName
Sets the SQL cursor name to the givenString
, which will be used by subsequentStatement
objectexecute
methods. This name can then be used in SQL positioned update or delete statements to identify the current row in theResultSet
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'sSELECT
statement should have the formSELECT FOR UPDATE
. IfFOR 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 theResultSet
object being used for positioning. Also, cursor names must be unique within a connection.- Parameters:
name
- the new cursor name, which must be unique within a connection- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method
-
execute
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- any SQL statement- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the method is called on aPreparedStatement
orCallableStatement
SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- See Also:
-
getResultSet
Retrieves the current result as aResultSet
object. This method should be called only once per result.- Returns:
- the current result as a
ResultSet
object ornull
if the result is an update count or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
getUpdateCount
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned. This method should be called only once per result.- Returns:
- the current result as an update count; -1 if the current result is a
ResultSet
object or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
getMoreResults
Moves to thisStatement
object's next result, returnstrue
if it is aResultSet
object, and implicitly closes any currentResultSet
object(s) obtained with the methodgetResultSet
.There are no more results when the following is true:
// stmt is a Statement object ((stmt.getMoreResults() == false) && (stmt.getUpdateCount() == -1))
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- See Also:
-
setFetchDirection
Gives the driver a hint as to the direction in which rows will be processed inResultSet
objects created using thisStatement
object. The default value isResultSet.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
- the initial direction for processing rows- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the given direction is not one ofResultSet.FETCH_FORWARD
,ResultSet.FETCH_REVERSE
, orResultSet.FETCH_UNKNOWN
- Since:
- 1.2
- See Also:
-
getFetchDirection
Retrieves the direction for fetching rows from database tables that is the default for result sets generated from thisStatement
object. If thisStatement
object has not set a fetch direction by calling the methodsetFetchDirection
, the return value is implementation-specific.- Returns:
- the default fetch direction for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
- See Also:
-
setFetchSize
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed forResultSet
objects generated by thisStatement
. If the value specified is zero, then the hint is ignored. The default value is zero.- Parameters:
rows
- the number of rows to fetch- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionrows >= 0
is not satisfied.- Since:
- 1.2
- See Also:
-
getFetchSize
Retrieves the number of result set rows that is the default fetch size forResultSet
objects generated from thisStatement
object. If thisStatement
object has not set a fetch size by calling the methodsetFetchSize
, the return value is implementation-specific.- Returns:
- the default fetch size for result sets generated
from this
Statement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
- See Also:
-
getResultSetConcurrency
Retrieves the result set concurrency forResultSet
objects generated by thisStatement
object.- Returns:
- either
ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
-
getResultSetType
Retrieves the result set type forResultSet
objects generated by thisStatement
object.- Returns:
- one of
ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
-
addBatch
Adds the given SQL command to the current list of commands for thisStatement
object. The commands in this list can be executed as a batch by calling the methodexecuteBatch
.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- typically this is a SQLINSERT
orUPDATE
statement- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the driver does not support batch updates, the method is called on aPreparedStatement
orCallableStatement
- Since:
- 1.2
- See Also:
-
clearBatch
Empties thisStatement
object's current list of SQL commands.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch updates- Since:
- 1.2
- See Also:
-
executeBatch
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Theint
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 methodexecuteBatch
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 process commands in a batch update after a
BatchUpdateException
object has been thrown.- Returns:
- 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.
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofSQLException
) if one of the commands sent to the database fails to execute properly or attempts to return a result set.SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.2
- See Also:
-
getConnection
Retrieves theConnection
object that produced thisStatement
object.- Returns:
- the connection that produced this statement
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.2
-
getMoreResults
Moves to thisStatement
object's next result, deals with any currentResultSet
object(s) according to the instructions specified by the given flag, and returnstrue
if the next result is aResultSet
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
- one of the followingStatement
constants indicating what should happen to currentResultSet
objects obtained using the methodgetResultSet
:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
, orStatement.CLOSE_ALL_RESULTS
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the argument supplied is not one of the following:Statement.CLOSE_CURRENT_RESULT
,Statement.KEEP_CURRENT_RESULT
orStatement.CLOSE_ALL_RESULTS
SQLFeatureNotSupportedException
- ifDatabaseMetaData.supportsMultipleOpenResults
returnsfalse
and eitherStatement.KEEP_CURRENT_RESULT
orStatement.CLOSE_ALL_RESULTS
are supplied as the argument.- Since:
- 1.4
- See Also:
-
getGeneratedKeys
Retrieves any auto-generated keys created as a result of executing thisStatement
object. If thisStatement
object did not generate any keys, an emptyResultSet
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.
- Returns:
- a
ResultSet
object containing the auto-generated key(s) generated by the execution of thisStatement
object - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
executeUpdate
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatement
object should be made available for retrieval. The driver will ignore the flag if the SQL statement is not anINSERT
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
orCallableStatement
.- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.autoGeneratedKeys
- 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
- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement returns aResultSet
object, the given constant is not one of those allowed, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
-
executeUpdate
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 anINSERT
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
orCallableStatement
.- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnIndexes
- an array of column indexes indicating the columns that should be returned from the inserted row- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object, the second argument supplied to this method is not anint
array whose elements are valid column indexes, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
-
executeUpdate
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 anINSERT
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
orCallableStatement
.- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnNames
- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT
,UPDATE
, orDELETE
statements, or 0 for SQL statements that return nothing - Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object, the second argument supplied to this method is not aString
array whose elements are valid column names, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
-
execute
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 anINSERT
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- any SQL statementautoGeneratedKeys
- a constant indicating whether auto-generated keys should be made available for retrieval using the methodgetGeneratedKeys
; one of the following constants:Statement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the second parameter supplied to this method is notStatement.RETURN_GENERATED_KEYS
orStatement.NO_GENERATED_KEYS
, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
- See Also:
-
execute
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 anINSERT
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- any SQL statementcolumnIndexes
- an array of the indexes of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys
- Returns:
true
if the first result is aResultSet
object;false
if it is an update count or there are no results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the elements in theint
array passed to this method are not valid column indexes, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
- See Also:
-
execute
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 anINSERT
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 methodsgetResultSet
orgetUpdateCount
to retrieve the result, andgetMoreResults
to move to any subsequent result(s).Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.- Parameters:
sql
- any SQL statementcolumnNames
- an array of the names of the columns in the inserted row that should be made available for retrieval by a call to the methodgetGeneratedKeys
- Returns:
true
if the next result is aResultSet
object;false
if it is an update count or there are no more results- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the elements of theString
array passed to this method are not valid column names, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.4
- See Also:
-
getResultSetHoldability
Retrieves the result set holdability forResultSet
objects generated by thisStatement
object.- Returns:
- either
ResultSet.HOLD_CURSORS_OVER_COMMIT
orResultSet.CLOSE_CURSORS_AT_COMMIT
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.4
-
isClosed
Retrieves whether thisStatement
object has been closed. AStatement
is closed if the method close has been called on it, or if it is automatically closed.- Returns:
- true if this
Statement
object is closed; false if it is still open - Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
setPoolable
Requests that aStatement
be pooled or not pooled. The value specified is a hint to the statement pool implementation indicating whether the application 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 aPreparedStatement
andCallableStatement
are poolable when created.- Parameters:
poolable
- requests that the statement be pooled if true and that the statement not be pooled if false- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.6
-
isPoolable
Returns a value indicating whether theStatement
is poolable or not.- Returns:
true
if theStatement
is poolable;false
otherwise- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.6
- See Also:
-
closeOnCompletion
Specifies that thisStatement
will be closed when all its dependent result sets are closed. If execution of theStatement
does not produce any result sets, this method has no effect.Note: Multiple calls to
closeOnCompletion
do not toggle the effect on thisStatement
. However, a call tocloseOnCompletion
does effect both the subsequent execution of statements, and statements that currently have open, dependent, result sets.- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.7
-
isCloseOnCompletion
Returns a value indicating whether thisStatement
will be closed when all its dependent result sets are closed.- Returns:
true
if theStatement
will be closed when all of its dependent result sets are closed;false
otherwise- Throws:
SQLException
- if this method is called on a closedStatement
- Since:
- 1.7
-
getLargeUpdateCount
Retrieves the current result as an update count; if the result is aResultSet
object or there are no more results, -1 is returned. This method should be called only once per result.This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.The default implementation will throw
UnsupportedOperationException
- Returns:
- the current result as an update count; -1 if the current result
is a
ResultSet
object or there are no more results - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.8
- See Also:
-
setLargeMaxRows
Sets the limit for the maximum number of rows that anyResultSet
object generated by thisStatement
object can contain to the given number. If the limit is exceeded, the excess rows are silently dropped.This method should be used when the row limit may exceed
Integer.MAX_VALUE
.The default implementation will throw
UnsupportedOperationException
- Parameters:
max
- the new max rows limit; zero means there is no limit- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the conditionmax >= 0
is not satisfied- Since:
- 1.8
- See Also:
-
getLargeMaxRows
Retrieves the maximum number of rows that aResultSet
object produced by thisStatement
object can contain. If this limit is exceeded, the excess rows are silently dropped.This method should be used when the returned row limit may exceed
Integer.MAX_VALUE
.The default implementation will return
0
- Returns:
- the current maximum number of rows for a
ResultSet
object produced by thisStatement
object; zero means there is no limit - Throws:
SQLException
- if a database access error occurs or this method is called on a closedStatement
- Since:
- 1.8
- See Also:
-
executeLargeBatch
Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts. Thelong
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 methodexecuteLargeBatch
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.getLargeUpdateCounts
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
This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.The default implementation will throw
UnsupportedOperationException
- Returns:
- 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.
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
or the driver does not support batch statements. ThrowsBatchUpdateException
(a subclass ofSQLException
) if one of the commands sent to the database fails to execute properly or attempts to return a result set.SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
- See Also:
-
executeLargeUpdate
Executes the given SQL statement, which may be anINSERT
,UPDATE
, orDELETE
statement or an SQL statement that returns nothing, such as an SQL DDL statement.This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.The default implementation will throw
UnsupportedOperationException
- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement produces aResultSet
object, the method is called on aPreparedStatement
orCallableStatement
SQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
-
executeLargeUpdate
Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by thisStatement
object should be made available for retrieval. The driver will ignore the flag if the SQL statement is not anINSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.The default implementation will throw
SQLFeatureNotSupportedException
- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.autoGeneratedKeys
- 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
- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the given SQL statement returns aResultSet
object, the given constant is not one of those allowed, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method with a constant of Statement.RETURN_GENERATED_KEYSSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
-
executeLargeUpdate
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 anINSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.The default implementation will throw
SQLFeatureNotSupportedException
- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnIndexes
- an array of column indexes indicating the columns that should be returned from the inserted row- Returns:
- either (1) the row count for SQL Data Manipulation Language (DML) statements or (2) 0 for SQL statements that return nothing
- Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object,the second argument supplied to this method is not anint
array whose elements are valid column indexes, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
-
executeLargeUpdate
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 anINSERT
statement, or an SQL statement able to return auto-generated keys (the list of such statements is vendor-specific).This method should be used when the returned row count may exceed
Integer.MAX_VALUE
.Note:This method cannot be called on a
PreparedStatement
orCallableStatement
.The default implementation will throw
SQLFeatureNotSupportedException
- Parameters:
sql
- an SQL Data Manipulation Language (DML) statement, such asINSERT
,UPDATE
orDELETE
; or an SQL statement that returns nothing, such as a DDL statement.columnNames
- an array of the names of the columns that should be returned from the inserted row- Returns:
- either the row count for
INSERT
,UPDATE
, orDELETE
statements, or 0 for SQL statements that return nothing - Throws:
SQLException
- if a database access error occurs, this method is called on a closedStatement
, the SQL statement returns aResultSet
object, the second argument supplied to this method is not aString
array whose elements are valid column names, the method is called on aPreparedStatement
orCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this methodSQLTimeoutException
- when the driver has determined that the timeout value that was specified by thesetQueryTimeout
method has been exceeded and has at least attempted to cancel the currently runningStatement
- Since:
- 1.8
-
enquoteLiteral
Returns aString
enclosed in single quotes. Any occurrence of a single quote within the string will be replaced by two single quotes.Examples of the conversion: Value Result Hello 'Hello' G'Day 'G''Day' 'G''Day' '''G''''Day''' I'''M 'I''''''M' - Implementation Note:
- JDBC driver implementations may need to provide their own implementation of this method in order to meet the requirements of the underlying datasource.
- Parameters:
val
- a character string- Returns:
- A string enclosed by single quotes with every single quote converted to two single quotes
- Throws:
NullPointerException
- if val isnull
SQLException
- if a database access error occurs- Since:
- 9
-
enquoteIdentifier
Returns a SQL identifier. Ifidentifier
is a simple SQL identifier:- Return the original value if
alwaysQuote
isfalse
- Return a delimited identifier if
alwaysQuote
istrue
identifier
is not a simple SQL identifier,identifier
will be enclosed in double quotes if not already present. If the datasource does not support double quotes for delimited identifiers, the identifier should be enclosed by the string returned fromDatabaseMetaData.getIdentifierQuoteString()
. If the datasource does not support delimited identifiers, aSQLFeatureNotSupportedException
should be thrown.A
SQLException
will be thrown ifidentifier
contains any characters invalid in a delimited identifier or the identifier length is invalid for the datasource.- Implementation Requirements:
- The default implementation uses the following criteria to
determine a valid simple SQL identifier:
- The string is not enclosed in double quotes
- The first character is an alphabetic character from a through z, or from A through Z
- The name only contains alphanumeric characters or the character "_"
SQLException
if:identifier
contains anull
character or double quote and is not a simple SQL identifier.- The length of
identifier
is less than 1 or greater than 128 characters
Examples of the conversion: identifier alwaysQuote Result Hello false Hello Hello true "Hello" G'Day false "G'Day" "Bruce Wayne" false "Bruce Wayne" "Bruce Wayne" true "Bruce Wayne" GoodDay$ false "GoodDay$" Hello"World false SQLException "Hello"World" false SQLException - Implementation Note:
- JDBC driver implementations may need to provide their own implementation of this method in order to meet the requirements of the underlying datasource.
- Parameters:
identifier
- a SQL identifieralwaysQuote
- indicates if a simple SQL identifier should be returned as a quoted identifier- Returns:
- A simple SQL identifier or a delimited identifier
- Throws:
SQLException
- if identifier is not a valid identifierSQLFeatureNotSupportedException
- if the datasource does not support delimited identifiersNullPointerException
- if identifier isnull
- Since:
- 9
- Return the original value if
-
isSimpleIdentifier
Retrieves whetheridentifier
is a simple SQL identifier.- Implementation Requirements:
- The default implementation uses the following criteria to
determine a valid simple SQL identifier:
- The string is not enclosed in double quotes
- The first character is an alphabetic character from a through z, or from A through Z
- The string only contains alphanumeric characters or the character "_"
- The string is between 1 and 128 characters in length inclusive
Examples of the conversion: identifier Simple Identifier Hello true G'Day false "Bruce Wayne" false GoodDay$ false Hello"World false "Hello"World" false - Implementation Note:
- JDBC driver implementations may need to provide their own implementation of this method in order to meet the requirements of the underlying datasource.
- Parameters:
identifier
- a SQL identifier- Returns:
- true if a simple SQL identifier, false otherwise
- Throws:
NullPointerException
- if identifier isnull
SQLException
- if a database access error occurs- Since:
- 9
-
enquoteNCharLiteral
Returns aString
representing a National Character Set Literal enclosed in single quotes and prefixed with a upper case letter N. Any occurrence of a single quote within the string will be replaced by two single quotes.Examples of the conversion: Value Result Hello N'Hello' G'Day N'G''Day' 'G''Day' N'''G''''Day''' I'''M N'I''''''M' N'Hello' N'N''Hello''' - Implementation Note:
- JDBC driver implementations may need to provide their own implementation of this method in order to meet the requirements of the underlying datasource. An implementation of enquoteNCharLiteral may accept a different set of characters than that accepted by the same drivers implementation of enquoteLiteral.
- Parameters:
val
- a character string- Returns:
- the result of replacing every single quote character in the argument by two single quote characters where this entire result is then prefixed with 'N'.
- Throws:
NullPointerException
- if val isnull
SQLException
- if a database access error occurs- Since:
- 9
-