MySQL Connector/J 9.2.0 · com.mysql.cj.jdbc.ClientPreparedStatement

Modifier and Type	Field and Description
protected String	batchedValuesClause
protected boolean	batchHasPlainStatements Does the batch (if any) contain "plain" statements added by Statement.addBatch(String)?
private boolean	compensateForOnDuplicateKeyUpdate
private boolean	doPingInstead
protected MysqlParameterMetadata	parameterMetaData
private ResultSetMetaData	pstmtResultMetaData
protected int	rewrittenBatchSize

Access	Constructor and Description
protected	ClientPreparedStatement(JdbcConnection the connection that created us conn, String the database in use when we were created db) Constructor used by server-side prepared statements
public	ClientPreparedStatement(JdbcConnection the connection creating this statement conn, String the SQL for this statement sql, String the database this statement should be issued against db) Constructor for the PreparedStatement class.
public	ClientPreparedStatement(JdbcConnection the connection creating this statement conn, String the SQL for this statement sql, String the database this statement should be issued against db, QueryInfo already created `QueryInfo` or null. cachedQueryInfo) Creates a new PreparedStatement object.

Method Summary

Modifier and Type	Method and Description
public void	addBatch() Implements java.sql.PreparedStatement.addBatch. Adds a set of parameters to this `PreparedStatement` object's batch of commands.
public void	addBatch(String typically this is a SQL `INSERT` or `UPDATE` statement sql) Overrides com.mysql.cj.jdbc.StatementImpl.addBatch. Implements java.sql.Statement.addBatch. Adds the given SQL command to the current list of commands for this `Statement` object.
protected void	checkBounds(int paramIndex, int parameterIndexOffset)
protected boolean	Returns: true if safe for read-only. checkReadOnlySafeStatement() Check to see if the statement is safe for read-only replicas after failover.
public void	clearBatch() Overrides com.mysql.cj.jdbc.StatementImpl.clearBatch. Implements java.sql.Statement.clearBatch. Empties this `Statement` object's current list of SQL commands.
public void	clearParameters() Implements java.sql.PreparedStatement.clearParameters. Clears the current parameter values immediately.
protected boolean	containsOnDuplicateKeyUpdate()
public void	doClose(CloseOption... options indicating how the close was initiated and/or what should be performed during the close options) Overrides com.mysql.cj.jdbc.StatementImpl.doClose. Implements com.mysql.cj.jdbc.JdbcStatement.doClose. Close this Statement and release resources.
public boolean	execute() Implements java.sql.PreparedStatement.execute. Executes the SQL statement in this `PreparedStatement` object, which may be any kind of SQL statement.
protected long[]	executeBatchInternal() Overrides com.mysql.cj.jdbc.StatementImpl.executeBatchInternal.
protected long[]	Returns: a list of update counts executeBatchSerially(long timeout for the batch execution batchTimeout) Executes the current batch of statements by executing them one-by-one.
protected long[]	Returns: update counts in the same fashion as executeBatch() executeBatchWithMultiValuesClause(long timeout for the batch execution batchTimeout) Rewrites the already prepared statement into a multi-values clause INSERT/REPLACE statement and executes the entire batch using this new statement.
protected < extends `Message` M extends Message> ResultSetInternalMethods	Returns: the results as a ResultSet executeInternal(int the max number of rows to return maxRowsToRetrieve, M the packet to send sendPacket, boolean should a 'streaming' result set be created? createStreamingResultSet, boolean is this query doing a SELECT? queryIsSelectOnly, ColumnDefinition use this metadata instead of the one provided on wire metadata, boolean is this a batch query? isBatch) Actually execute the prepared statement.
public long	executeLargeUpdate() Overrides default java.sql.PreparedStatement.executeLargeUpdate. 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.
protected long[]	Returns: update counts in the same fashion as executeBatch() executePreparedBatchAsMultiStatement(long timeout for the batch execution batchTimeout) Rewrites the already prepared statement into a multi-statement query and executes the entire batch using this new statement.
public ResultSet	executeQuery() Implements java.sql.PreparedStatement.executeQuery. Executes the SQL query in this `PreparedStatement` object and returns the `ResultSet` object generated by the query.
public int	executeUpdate() Implements java.sql.PreparedStatement.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.
protected long	executeUpdateInternal(boolean clearBatchedGeneratedKeysAndWarnings, boolean isBatch)
protected long	Returns: the update count executeUpdateInternal(QueryBindings bindings object bindings, boolean is it a batched statement? isReallyBatch) Added to allow batch-updates
private String	generateMultiStatementForBatch(int numBatches)
public byte[]	getBytesRepresentation(int parameterIndex) Implements com.mysql.cj.jdbc.JdbcPreparedStatement.getBytesRepresentation.
public final int	getCoreParameterIndex(int paramIndex)
protected static ClientPreparedStatement	Returns: ClientPreparedStatement getInstance(JdbcConnection the connection creating this statement conn, String the SQL for this statement sql, String the database this statement should be issued against db) Creates a prepared statement instance
protected static ClientPreparedStatement	Returns: ClientPreparedStatement instance getInstance(JdbcConnection the connection creating this statement conn, String the SQL for this statement sql, String the database this statement should be issued against db, QueryInfo already created `QueryInfo` or null. cachedQueryInfo) Creates a prepared statement instance
public ResultSetMetaData	getMetaData() Implements java.sql.PreparedStatement.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.
public ParameterBindings	getParameterBindings() Implements com.mysql.cj.jdbc.JdbcPreparedStatement.getParameterBindings.
protected int	Returns: offset getParameterIndexOffset() For calling stored functions, this will be -1 as Connector/J does not count the first '?' parameter marker, but JDBC counts it * as 1, otherwise it will return 0
public ParameterMetaData	getParameterMetaData() Implements java.sql.PreparedStatement.getParameterMetaData. Retrieves the number, types and properties of this `PreparedStatement` object's parameters.
public String	getPreparedSql() Implements com.mysql.cj.jdbc.JdbcPreparedStatement.getPreparedSql.
public QueryBindings	getQueryBindings() Implements com.mysql.cj.jdbc.JdbcPreparedStatement.getQueryBindings.
public QueryInfo	getQueryInfo() Implements com.mysql.cj.jdbc.JdbcPreparedStatement.getQueryInfo.
public int	getUpdateCount() Overrides com.mysql.cj.jdbc.StatementImpl.getUpdateCount. Implements java.sql.Statement.getUpdateCount. Retrieves the current result as an update count; if the result is a `ResultSet` object or there are no more results, -1 is returned.
private void	initializeFromQueryInfo()
protected void	initQuery() Overrides com.mysql.cj.jdbc.StatementImpl.initQuery.
private boolean	Returns: `true` if the query does not produce a result set, `false` otherwise. isNonResultSetProducingQuery() Checks if the given SQL query does not return a result set.
public boolean	isNull(int paramIndex) Implements com.mysql.cj.jdbc.JdbcPreparedStatement.isNull.
protected boolean	Returns: `true` if the query produces a result set, `false` otherwise. isResultSetProducingQuery() Checks if the given SQL query is a result set producing query.
protected ClientPreparedStatement	Returns: new ClientPreparedStatement prepareBatchedInsertSQL(JdbcConnection the connection creating this statement localConn, int number of entries in a batch numBatches) Returns a prepared statement for the number of batched parameters, used when re-writing batch INSERTs.
public void	setArray(int the first parameter is 1, the second is 2, ... i, Array an `Array` object that maps an SQL `ARRAY` value x) Implements java.sql.PreparedStatement.setArray. Sets the designated parameter to the given `java.sql.Array` object.
public void	setAsciiStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the Java input stream that contains the ASCII parameter value x) Implements java.sql.PreparedStatement.setAsciiStream. Sets the designated parameter to the given input stream.
public void	setAsciiStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the Java input stream that contains the ASCII parameter value x, int the number of bytes in the stream length) Implements java.sql.PreparedStatement.setAsciiStream. Sets the designated parameter to the given input stream, which will have the specified number of bytes.
public void	setAsciiStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the Java input stream that contains the ASCII parameter value x, long the number of bytes in the stream length) Implements java.sql.PreparedStatement.setAsciiStream. Sets the designated parameter to the given input stream, which will have the specified number of bytes.
public void	setBigDecimal(int the first parameter is 1, the second is 2, ... parameterIndex, BigDecimal the parameter value x) Implements java.sql.PreparedStatement.setBigDecimal. Sets the designated parameter to the given `java.math.BigDecimal` value.
public void	setBigInteger(int parameterIndex, BigInteger x) Implements com.mysql.cj.jdbc.JdbcPreparedStatement.setBigInteger.
public void	setBinaryStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the java input stream which contains the binary parameter value x) Implements java.sql.PreparedStatement.setBinaryStream. Sets the designated parameter to the given input stream.
public void	setBinaryStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the java input stream which contains the binary parameter value x, int the number of bytes in the stream length) Implements java.sql.PreparedStatement.setBinaryStream. Sets the designated parameter to the given input stream, which will have the specified number of bytes.
public void	setBinaryStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream the java input stream which contains the binary parameter value x, long the number of bytes in the stream length) Implements java.sql.PreparedStatement.setBinaryStream. Sets the designated parameter to the given input stream, which will have the specified number of bytes.
public void	setBlob(int the first parameter is 1, the second is 2, ... i, Blob a `Blob` object that maps an SQL `BLOB` value x) Implements java.sql.PreparedStatement.setBlob. Sets the designated parameter to the given `java.sql.Blob` object.
public void	setBlob(int index of the first parameter is 1, the second is 2, ... parameterIndex, InputStream An object that contains the data to set the parameter value to. inputStream) Implements java.sql.PreparedStatement.setBlob. Sets the designated parameter to a `InputStream` object.
public void	setBlob(int index of the first parameter is 1, the second is 2, ... parameterIndex, InputStream An object that contains the data to set the parameter value to. inputStream, long the number of bytes in the parameter data. length) Implements java.sql.PreparedStatement.setBlob. Sets the designated parameter to a `InputStream` object.
public void	setBoolean(int the first parameter is 1, the second is 2, ... parameterIndex, boolean the parameter value x) Implements java.sql.PreparedStatement.setBoolean. Sets the designated parameter to the given Java `boolean` value.
public void	setByte(int the first parameter is 1, the second is 2, ... parameterIndex, byte the parameter value x) Implements java.sql.PreparedStatement.setByte. Sets the designated parameter to the given Java `byte` value.
public void	setBytes(int the first parameter is 1, the second is 2, ... parameterIndex, byte[] the parameter value x) Implements java.sql.PreparedStatement.setBytes. Sets the designated parameter to the given Java array of bytes.
public void	setBytes(int parameterIndex, byte[] x, boolean escapeIfNeeded) Implements com.mysql.cj.jdbc.JdbcPreparedStatement.setBytes.
public void	setCharacterStream(int the first parameter is 1, the second is 2, ... parameterIndex, Reader the `java.io.Reader` object that contains the Unicode data reader) Implements java.sql.PreparedStatement.setCharacterStream. Sets the designated parameter to the given `Reader` object.
public void	setCharacterStream(int the first parameter is 1, the second is 2, ... parameterIndex, Reader the `java.io.Reader` object that contains the Unicode data reader, int the number of characters in the stream length) Implements java.sql.PreparedStatement.setCharacterStream. Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
public void	setCharacterStream(int the first parameter is 1, the second is 2, ... parameterIndex, Reader the `java.io.Reader` object that contains the Unicode data reader, long the number of characters in the stream length) Implements java.sql.PreparedStatement.setCharacterStream. Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
public void	setClob(int index of the first parameter is 1, the second is 2, ... parameterIndex, Reader An object that contains the data to set the parameter value to. reader) Implements java.sql.PreparedStatement.setClob. Sets the designated parameter to a `Reader` object.
public void	setClob(int index of the first parameter is 1, the second is 2, ... parameterIndex, Reader An object that contains the data to set the parameter value to. reader, long the number of characters in the parameter data. length) Implements java.sql.PreparedStatement.setClob. Sets the designated parameter to a `Reader` object.
public void	setClob(int the first parameter is 1, the second is 2, ... i, Clob a `Clob` object that maps an SQL `CLOB` value x) Implements java.sql.PreparedStatement.setClob. Sets the designated parameter to the given `java.sql.Clob` object.
public void	setDate(int the first parameter is 1, the second is 2, ... parameterIndex, Date the parameter value x) Implements java.sql.PreparedStatement.setDate. Sets the designated parameter to the given `java.sql.Date` value using the default time zone of the virtual machine that is running the application.
public void	setDate(int the first parameter is 1, the second is 2, ... parameterIndex, Date the parameter value x, Calendar the `Calendar` object the driver will use to construct the date cal) Implements java.sql.PreparedStatement.setDate. Sets the designated parameter to the given `java.sql.Date` value, using the given `Calendar` object.
public void	setDouble(int the first parameter is 1, the second is 2, ... parameterIndex, double the parameter value x) Implements java.sql.PreparedStatement.setDouble. Sets the designated parameter to the given Java `double` value.
public void	setFloat(int the first parameter is 1, the second is 2, ... parameterIndex, float the parameter value x) Implements java.sql.PreparedStatement.setFloat. Sets the designated parameter to the given Java `float` value.
public void	setInt(int the first parameter is 1, the second is 2, ... parameterIndex, int the parameter value x) Implements java.sql.PreparedStatement.setInt. Sets the designated parameter to the given Java `int` value.
public void	setLong(int the first parameter is 1, the second is 2, ... parameterIndex, long the parameter value x) Implements java.sql.PreparedStatement.setLong. Sets the designated parameter to the given Java `long` value.
public void	setNCharacterStream(int of the first parameter is 1, the second is 2, ... parameterIndex, Reader the parameter value value) Implements java.sql.PreparedStatement.setNCharacterStream. Sets the designated parameter to a `Reader` object.
public void	setNCharacterStream(int of the first parameter is 1, the second is 2, ... parameterIndex, Reader the parameter value reader, long the number of characters in the parameter data. length) Implements java.sql.PreparedStatement.setNCharacterStream. Sets the designated parameter to a `Reader` object.
public void	setNClob(int index of the first parameter is 1, the second is 2, ... parameterIndex, Reader An object that contains the data to set the parameter value to. reader) Implements java.sql.PreparedStatement.setNClob. Sets the designated parameter to a `Reader` object.
public void	setNClob(int index of the first parameter is 1, the second is 2, ... parameterIndex, Reader An object that contains the data to set the parameter value to. reader, long the number of characters in the parameter data. length) Implements java.sql.PreparedStatement.setNClob. Sets the designated parameter to a `Reader` object.
public void	setNClob(int of the first parameter is 1, the second is 2, ... parameterIndex, NClob the parameter value value) Implements java.sql.PreparedStatement.setNClob. Sets the designated parameter to a `java.sql.NClob` object.
public void	setNString(int the first parameter is 1... parameterIndex, String the parameter value x) Implements java.sql.PreparedStatement.setNString. Set a parameter to a Java String value.
public void	setNull(int the first parameter is 1, the second is 2, ... parameterIndex, int the SQL type code defined in `java.sql.Types` sqlType) Implements java.sql.PreparedStatement.setNull. Sets the designated parameter to SQL `NULL`.
public void	setNull(int the first parameter is 1, the second is 2, ... parameterIndex, int a value from `java.sql.Types` sqlType, String the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or REF typeName) Implements java.sql.PreparedStatement.setNull. Sets the designated parameter to SQL `NULL`.
public void	setNull(int parameterIndex, MysqlType mysqlType) Implements com.mysql.cj.jdbc.JdbcPreparedStatement.setNull.
public void	setObject(int the first parameter is 1, the second is 2, ... parameterIndex, Object the object containing the input parameter value parameterObj) Implements java.sql.PreparedStatement.setObject. Sets the value of the designated parameter using the given object.
public void	setObject(int the first parameter is 1, the second is 2, ... parameterIndex, Object the object containing the input parameter value parameterObj, int the SQL type (as defined in java.sql.Types) to be sent to the database targetSqlType) Implements java.sql.PreparedStatement.setObject. Sets the value of the designated parameter with the given object.
public void	setObject(int the first parameter is 1, the second is 2, ... parameterIndex, Object the object containing the input parameter value parameterObj, SQLType the SQL type to be sent to the database targetSqlType) Overrides default java.sql.PreparedStatement.setObject. Sets the value of the designated parameter with the given object.
public void	setObject(int the first parameter is 1, the second is 2, ... parameterIndex, Object the object containing the input parameter value parameterObj, int the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. targetSqlType, int for `java.sql.Types.DECIMAL` or `java.sql.Types.NUMERIC types`, this is the number of digits after the decimal point. For Java Object types `InputStream` and `Reader`, this is the length of the data in the stream or reader. For all other types, this value will be ignored. scale) Implements java.sql.PreparedStatement.setObject. Sets the value of the designated parameter with the given object.
public void	setObject(int the first parameter is 1, the second is 2, ... parameterIndex, Object the object containing the input parameter value x, SQLType the SQL type to be sent to the database. The scale argument may further qualify this type. targetSqlType, int for `java.sql.JDBCType.DECIMAL` or `java.sql.JDBCType.NUMERIC types`, this is the number of digits after the decimal point. For Java Object types `InputStream` and `Reader`, this is the length of the data in the stream or reader. For all other types, this value will be ignored. scaleOrLength) Overrides default java.sql.PreparedStatement.setObject. Sets the value of the designated parameter with the given object.
protected int	setOneBatchedParameterSet(PreparedStatement batchedStatement, int batchedParamIndex, Object paramSet)
public void	setRef(int the first parameter is 1, the second is 2, ... i, Ref an SQL `REF` value x) Implements java.sql.PreparedStatement.setRef. Sets the designated parameter to the given `REF(<structured-type>)` value.
protected void	setRetrieveGeneratedKeys(boolean flag)
public void	setRowId(int the first parameter is 1, the second is 2, ... parameterIndex, RowId the parameter value x) Implements java.sql.PreparedStatement.setRowId. Sets the designated parameter to the given `java.sql.RowId` object.
public void	setShort(int the first parameter is 1, the second is 2, ... parameterIndex, short the parameter value x) Implements java.sql.PreparedStatement.setShort. Sets the designated parameter to the given Java `short` value.
public void	setSQLXML(int index of the first parameter is 1, the second is 2, ... parameterIndex, SQLXML a `SQLXML` object that maps an SQL `XML` value xmlObject) Implements java.sql.PreparedStatement.setSQLXML. Sets the designated parameter to the given `java.sql.SQLXML` object.
public void	setString(int the first parameter is 1, the second is 2, ... parameterIndex, String the parameter value x) Implements java.sql.PreparedStatement.setString. Sets the designated parameter to the given Java `String` value.
public void	setTime(int the first parameter is 1, the second is 2, ... parameterIndex, Time the parameter value x) Implements java.sql.PreparedStatement.setTime. Sets the designated parameter to the given `java.sql.Time` value.
public void	setTime(int the first parameter is 1, the second is 2, ... parameterIndex, Time the parameter value x, Calendar the `Calendar` object the driver will use to construct the time cal) Implements java.sql.PreparedStatement.setTime. Sets the designated parameter to the given `java.sql.Time` value, using the given `Calendar` object.
public void	setTimestamp(int the first parameter is 1, the second is 2, ... parameterIndex, Timestamp the parameter value x) Implements java.sql.PreparedStatement.setTimestamp. Sets the designated parameter to the given `java.sql.Timestamp` value.
public void	setTimestamp(int the first parameter is 1, the second is 2, ... parameterIndex, Timestamp the parameter value x, Calendar the `Calendar` object the driver will use to construct the timestamp cal) Implements java.sql.PreparedStatement.setTimestamp. Sets the designated parameter to the given `java.sql.Timestamp` value, using the given `Calendar` object.
public void	setUnicodeStream(int the first parameter is 1, the second is 2, ... parameterIndex, InputStream a `java.io.InputStream` object that contains the Unicode parameter value x, int the number of bytes in the stream length) Implements java.sql.PreparedStatement.setUnicodeStream. Deprecated Sets the designated parameter to the given input stream, which will have the specified number of bytes.
public void	setURL(int the first parameter is 1, the second is 2, ... parameterIndex, URL the `java.net.URL` object to be set arg) Implements java.sql.PreparedStatement.setURL. Sets the designated parameter to the given `java.net.URL` value.
public String	Returns: this PreparedStatement represented as a string. toString() Overrides java.lang.Object.toString. Returns this PreparedStatement represented as a string.

Inherited from com.mysql.cj.jdbc.StatementImpl:: addBatch cancel checkCancelTimeout checkClosed checkNullOrEmptyQuery clearAttributes clearBatchedArgs clearWarnings close closeAllOpenResults closeOnCompletion closeQuery containsOnDuplicateKeyInString disableStreamingResults doPingInstead enableStreamingResults execute execute execute execute executeBatch executeLargeBatch executeLargeUpdate executeLargeUpdate executeLargeUpdate executeLargeUpdate executeQuery executeSimpleNonQuery executeUpdate executeUpdate executeUpdate executeUpdate executeUpdateInternal generatePingResultSet getBatchedArgs getBatchedGeneratedKeys getBatchedGeneratedKeys getCancelTimeoutLock getConnection getCurrentDatabase getExceptionInterceptor getExecuteTime getFetchDirection getFetchSize getGeneratedKeys getGeneratedKeysInternal getGeneratedKeysInternal getId getLargeMaxRows getLargeUpdateCount getLastInsertID getLocalInfileInputStream getLongUpdateCount getMaxFieldSize getMaxRows getMoreResults getMoreResults getOpenResultSetCount getQuery getQueryAttributesBindings getQueryTimeout getResultFetchSize getResultSet getResultSetConcurrency getResultSetFactory getResultSetHoldability getResultSetInternal getResultSetType getResultType getServerStatementId getSession getStatementExecuting getTimeoutInMillis getWarnings handleExceptionForBatch hasDeadlockOrTimeoutRolledBackTx implicitlyCloseAllOpenResults isClearWarningsCalled isClosed isCloseOnCompletion isNonResultSetProducingQuery isPoolable isResultSetProducingQuery isWrapperFor meetsConditionsForStreamingResultSet notifyResultSetClose processMultiCountsAndKeys resetCancelledState setAttribute setCancelStatus setClearWarningsCalled setCurrentDatabase setCursorName setEscapeProcessing setExecuteTime setFetchDirection setFetchSize setHoldResultsOpenOverClose setLargeMaxRows setLocalInfileInputStream setMaxFieldSize setMaxRows setPingTarget setPoolable setQueryTimeout setResultFetchSize setResultSetConcurrency setResultSetType setResultSetType setResultType setTimeoutInMillis setupStreamingTimeout startQueryTimer statementBegins stopQueryTimer unwrap

public Class ClientPreparedStatement

Field Summary

Constructor Summary

Method Summary