com.oceanbase.jdbc

Class JDBC4PreparedStatement

java.lang.Object

com.oceanbase.jdbc.OceanBaseStatement

com.oceanbase.jdbc.BasePrepareStatement

com.oceanbase.jdbc.JDBC4PreparedStatement

All Implemented Interfaces:

ObPrepareStatement, AutoCloseable, Cloneable, PreparedStatement, Statement, Wrapper

Direct Known Subclasses:

ClientSidePreparedStatement

public class JDBC4PreparedStatement
extends BasePrepareStatement

Field Summary

Fields inherited from class com.oceanbase.jdbc.BasePrepareStatement

autoGeneratedKeys, hasLongData, indexMap, parameterCount, SPEC_ISO_ZONED_DATE_TIME

Fields inherited from class com.oceanbase.jdbc.OceanBaseStatement

actualSql, addRowid, batchQueries, canUseServerTimeout, closed, connection, exceptionFactory, executing, fetchSize, isFetchSizeSet, lock, maxRows, options, originalSql, parameterSql, processedSql, protocol, queryTimeout, results, resultSetConcurrency, resultSetScrollType, rowidSql, selectEndPos, simpleSql, sqlType, STMT_ALTER, STMT_BEGIN, STMT_CALL, STMT_CREATE, STMT_DECLARE, STMT_DELETE, STMT_DROP, STMT_INSERT, STMT_SELECT, STMT_UNKNOWN, STMT_UPDATE, utickSql, whereEndPos

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Constructor Summary

Constructors

Constructor and Description
JDBC4PreparedStatement(OceanBaseConnection connection, String sql, int resultSetScrollType, int resultSetConcurrency, int autoGeneratedKeys, ExceptionFactory exceptionFactory) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addBatch() Adds a set of parameters to this PreparedStatement object's batch of send.
void	addBatch(String sql) Add batch.
String	asSql()
String	asSql(boolean quoteStreamsAndUnknowns)
void	clearBatch() Clear batch.
void	clearParameters() Clears the current parameter values immediately.
JDBC4PreparedStatement	clone(OceanBaseConnection connection) Clone statement.
void	close() Releases this Statement object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
boolean	execute() Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement.
int[]	executeBatch() {inheritdoc}.
protected boolean	executeInternal(int fetchSize)
long[]	executeLargeBatch() Execute batch, like executeBatch(), with returning results with long[].
ResultSet	executeQuery() Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.
int	executeUpdate() Executes the SQL statement in this PreparedStatement object, which must be 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.
ResultSetMetaData	getMetaData() Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.
ParameterMetaData	getParameterMetaData() Retrieves the number, types and properties of this PreparedStatement object's parameters.
ParameterHolder[]	getParameters()
protected ClientPrepareResult	getPrepareResult()
int[]	getServerUpdateCounts() Non JDBC : Permit to retrieve server update counts when using option rewriteBatchedStatements.
void	setArray(int parameterIndex, Array array) Sets the designated parameter to the given java.sql.Array object.
void	setParameter(int parameterIndex, ParameterHolder holder) Set parameter.
void	setParameters(ParameterHolder[] paramArray)
String	toString() {inherit}.

Methods inherited from class com.oceanbase.jdbc.BasePrepareStatement

executeLargeUpdate, getParameterCount, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBINARY_DOUBLE, setBINARY_FLOAT, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setIndexMap, setInt, setINTERVALDS, setINTERVALYM, setLobLocator, setLocalDateTime, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setNull, setNUMBER_FLOAT, setNUMBER, setObject, setObject, setObject, setObject, setObject, setParameterCount, setRef, setRowId, setShort, setSQLXML, setString, setStruct, setTime, setTime, setTimestamp, setTIMESTAMP, setTimestamp, setTIMESTAMPLTZ, setTIMESTAMPTZ, setUnicodeStream, setURL

Methods inherited from class com.oceanbase.jdbc.OceanBaseStatement

cancel, checkClose, checkCloseOnCompletion, clearWarnings, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatchEpilogue, executeBatchExceptionEpilogue, executeBatchExceptionEpilogue, executeEpilogue, executeExceptionEpilogue, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeQueryPrologue, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getActualSql, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResults, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getSqlType, getUpdateCount, getWarnings, getWhereEndPos, isAddRowid, isClosed, isCloseOnCompletion, isCursorResultSet, isPoolable, isSimpleIdentifier, isWrapperFor, realClose, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setLocalInfileInputStream, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, setTimerTask, skipMoreResults, testExecute, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.sql.Statement

cancel, clearWarnings, closeOnCompletion, execute, execute, execute, execute, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Constructor Detail

JDBC4PreparedStatement

public JDBC4PreparedStatement(OceanBaseConnection connection,
                              String sql,
                              int resultSetScrollType,
                              int resultSetConcurrency,
                              int autoGeneratedKeys,
                              ExceptionFactory exceptionFactory)
                       throws SQLException

Constructor.

Parameters:

connection - connection

sql - sql query

resultSetScrollType - one of the following ResultSet constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

resultSetConcurrency - a concurrency type; one of ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE

autoGeneratedKeys - a flag indicating whether auto-generated keys should be returned; one of Statement.RETURN_GENERATED_KEYS or Statement.NO_GENERATED_KEYS

exceptionFactory - exception factory

Throws:

SQLException - exception

Method Detail

clone

public JDBC4PreparedStatement clone(OceanBaseConnection connection)
                             throws CloneNotSupportedException

Clone statement.

Overrides:

clone in class BasePrepareStatement

Parameters:

connection - connection

Returns:

Clone statement.

Throws:

CloneNotSupportedException - if any error occur.

execute

public boolean execute()
                throws SQLException

Executes the SQL statement in this PreparedStatement object, which may be any kind of SQL statement. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by the methods executeQuery and executeUpdate.
The execute method returns a boolean to indicate the form of the first result. You must call either the method getResultSet or getUpdateCount to retrieve the result; you must call getInternalMoreResults to move to any subsequent result(s).

Returns:

true if the first result is a ResultSet object; false if the first result is an update count or there is no result

Throws:

SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or an argument is supplied to this method

See Also:

Statement.execute(java.lang.String), Statement.getResultSet(), Statement.getUpdateCount(), Statement.getMoreResults()

executeQuery

public ResultSet executeQuery()
                       throws SQLException

Executes the SQL query in this PreparedStatement object and returns the ResultSet object generated by the query.

Returns:

a ResultSet object that contains the data produced by the query; never null

Throws:

SQLException - if a database access error occurs; this method is called on a closed PreparedStatement or the SQL statement does not return a ResultSet object

executeUpdate

public int executeUpdate()
                  throws SQLException

Executes the SQL statement in this PreparedStatement object, which must be 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. Result-set are permitted for historical reason, even if spec indicate to throw exception.

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 closed PreparedStatement

executeInternal

protected boolean executeInternal(int fetchSize)
                           throws SQLException

Specified by:

executeInternal in class BasePrepareStatement

Throws:

SQLException

addBatch

public void addBatch()
              throws SQLException

Adds a set of parameters to this PreparedStatement object's batch of send.

Throws:

SQLException - if a database access error occurs or this method is called on a closed PreparedStatement

Since:

1.2

See Also:

Statement.addBatch(java.lang.String)

addBatch

public void addBatch(String sql)
              throws SQLException

Add batch.

Specified by:

addBatch in interface Statement

Overrides:

addBatch in class OceanBaseStatement

Parameters:

sql - typically this is a SQL INSERT or UPDATE statement

Throws:

SQLException - every time since that method is forbidden on prepareStatement

See Also:

OceanBaseStatement.executeBatch(), DatabaseMetaData.supportsBatchUpdates()

clearBatch

public void clearBatch()

Clear batch.

Specified by:

clearBatch in interface Statement

Overrides:

clearBatch in class OceanBaseStatement

See Also:

OceanBaseStatement.addBatch(java.lang.String), DatabaseMetaData.supportsBatchUpdates()

executeBatch

public int[] executeBatch()
                   throws SQLException

{inheritdoc}.

Specified by:

executeBatch in interface Statement

Overrides:

executeBatch in class OceanBaseStatement

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 send were added to the batch.

Throws:

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 send sent to the database fails to execute properly or attempts to return a result set.

See Also:

OceanBaseStatement.addBatch(java.lang.String), DatabaseMetaData.supportsBatchUpdates()

getServerUpdateCounts

public int[] getServerUpdateCounts()

Non JDBC : Permit to retrieve server update counts when using option rewriteBatchedStatements.

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.

executeLargeBatch

public long[] executeLargeBatch()
                         throws SQLException

Execute batch, like executeBatch(), with returning results with long[]. For when row count may exceed Integer.MAX_VALUE.

Specified by:

executeLargeBatch in interface Statement

Overrides:

executeLargeBatch in class OceanBaseStatement

Returns:

an array of update counts (one element for each command in the batch)

Throws:

SQLException - if a database error occur.

getMetaData

public ResultSetMetaData getMetaData()
                              throws SQLException

Retrieves a ResultSetMetaData object that contains information about the columns of the ResultSet object that will be returned when this PreparedStatement object is executed.
Because a PreparedStatement object is precompiled, it is possible to know about the ResultSet object that it will return without having to execute it. Consequently, it is possible to invoke the method getMetaData on a PreparedStatement object rather than waiting to execute it and then invoking the ResultSet.getMetaData method on the ResultSet object that is returned.

Returns:

the description of a ResultSet object's columns or null if the driver cannot return a ResultSetMetaData object

Throws:

SQLException - if a database access error occurs or this method is called on a closed PreparedStatement

setParameter

public void setParameter(int parameterIndex,
                         ParameterHolder holder)
                  throws SQLException

Set parameter.

Specified by:

setParameter in class BasePrepareStatement

Parameters:

parameterIndex - index

holder - parameter holder

Throws:

SQLException - if index position doesn't correspond to query parameters

getParameterMetaData

public ParameterMetaData getParameterMetaData()
                                       throws SQLException

Retrieves the number, types and properties of this PreparedStatement object's parameters.

Specified by:

getParameterMetaData in interface PreparedStatement

Specified by:

getParameterMetaData in class BasePrepareStatement

Returns:

a ParameterMetaData object that contains information about the number, types and properties for each parameter marker of this PreparedStatement object

Throws:

SQLException - if a database access error occurs or this method is called on a closed PreparedStatement

Since:

1.4

See Also:

ParameterMetaData

clearParameters

public void clearParameters()
                     throws SQLException

Clears the current parameter values immediately.

In general, parameter values remain in force for repeated use of a statement. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values; this can be done by calling the method clearParameters.

Throws:

SQLException

getParameters

public ParameterHolder[] getParameters()

Specified by:

getParameters in class BasePrepareStatement

setParameters

public void setParameters(ParameterHolder[] paramArray)

Specified by:

setParameters in class BasePrepareStatement

close

public void close()
           throws SQLException

Description copied from class: OceanBaseStatement

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.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Statement

Overrides:

close in class OceanBaseStatement

Throws:

SQLException - if a database access error occurs

toString

public String toString()

{inherit}.

Overrides:

toString in class Object

setArray

public void setArray(int parameterIndex,
                     Array array)
              throws SQLException

Description copied from class: BasePrepareStatement

Sets the designated parameter to the given java.sql.Array object. The driver converts this to an SQL ARRAY value when it sends it to the database.

Specified by:

setArray in interface PreparedStatement

Overrides:

setArray in class BasePrepareStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

array - an Array object that maps an SQL ARRAY value

Throws:

SQLException - if parameterIndex does not correspond to a parameter marker in the SQL statement; if a database access error occurs or this method is called on a closed PreparedStatement

getPrepareResult

protected ClientPrepareResult getPrepareResult()

asSql

public String asSql()
             throws SQLException

Overrides:

asSql in class BasePrepareStatement

Throws:

SQLException

asSql

public String asSql(boolean quoteStreamsAndUnknowns)
             throws SQLException

Throws:

SQLException