MySQL Connector/J 9.2.0 · com.mysql.cj.ServerPreparedQuery

Field Summary

Modifier and Type	Field and Description
public static final int	BLOB_STREAM_READ_BUF_SIZE
protected NativeMessageBuilder	commandBuilder
protected RuntimeProperty<Boolean>	explainSlowQueries
protected boolean	gatherPerfMetrics The "gatherPerfMetrics" connection property value
protected boolean	logSlowQueries The "logSlowQueries" connection property value
public static final byte	OPEN_CURSOR_FLAG
public static final byte	PARAMETER_COUNT_AVAILABLE
private Field[]	parameterFields Field-level metadata for parameters
protected boolean	profileSQL The "profileSQL" connection property value
protected boolean	queryWasSlow
private ColumnDefinition	resultFields Field-level metadata for result sets.
private long	serverStatementId The ID that the server uses to identify this PreparedStatement
protected RuntimeProperty<Integer>	slowQueryThresholdMillis
private boolean	useAutoSlowLog
protected boolean	useCursorFetch

Inherited from com.mysql.cj.ClientPreparedQuery:: autoClosePStmtStreams batchCommandIndex originalSql parameterCount queryBindings queryInfo useStreamLengthsInPrepStmts

Constructor Summary

Access	Constructor and Description
protected	ServerPreparedQuery(NativeSession sess)

Method Summary

Modifier and Type	Method and Description
public void	clearParameters(boolean flag indicating whether we need an additional clean up clearServerParameters)
public void	closeQuery() Overrides com.mysql.cj.ClientPreparedQuery.closeQuery. Implements com.mysql.cj.Query.closeQuery.
protected long[]	computeMaxParameterSetSizeAndBatchSize(int number of batched arguments numBatchedArgs) Overrides com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize. Computes the maximum parameter set size and the size of the entire batch given the number of arguments in the batch.
public <M extends Message> M	fillSendPacket(QueryBindings bindings) Overrides com.mysql.cj.ClientPreparedQuery.fillSendPacket. Implements com.mysql.cj.PreparedQuery.fillSendPacket.
public static ServerPreparedQuery	getInstance(NativeSession sess)
public Field[]	getParameterFields()
public ColumnDefinition	getResultFields()
public long	getServerStatementId()
public NativePacketPayload	prepareExecutePacket()
public <T extends Resultset> T	readExecuteResult(NativePacketPayload resultPacket, int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory, String queryAsString)
public NativePacketPayload	sendExecutePacket(NativePacketPayload packet, String queryAsString)
public < extends `Resultset` T extends Resultset> T	Returns: T instance serverExecute(int rows limit maxRowsToRetrieve, boolean should c/J create a streaming result? createStreamingResultSet, ColumnDefinition use this metadata instead of the one provided on wire metadata, ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` resultSetFactory)
private void	serverLongData(int parameter index parameterIndex, BindValue `containing long data` binding) Sends stream-type data parameters to the server.
public void	serverPrepare(String query string sql)
public void	serverResetStatement()
public void	setParameterFields(Field[] parameterFields)
public void	setResultFields(ColumnDefinition resultFields)
public void	setServerStatementId(long serverStatementId)
public void	statementBegins() Overrides com.mysql.cj.AbstractQuery.statementBegins. Implements com.mysql.cj.Query.statementBegins.
private void	storeStreamOrReader(int parameterIndex, NativePacketPayload packet, Closeable streamOrReader)
private String	truncateQueryToLog(String sql)

Inherited from com.mysql.cj.ClientPreparedQuery:: asSql checkNullOrEmptyQuery computeBatchSize getBatchCommandIndex getOriginalSql getParameterCount getQueryBindings getQueryInfo setBatchCommandIndex setOriginalSql setParameterCount setQueryBindings setQueryInfo

Field Detail

BLOB_STREAM_READ_BUF_SIZE	back to summary
public static final int BLOB_STREAM_READ_BUF_SIZE

commandBuilder	back to summary
protected NativeMessageBuilder commandBuilder

explainSlowQueries	back to summary
protected RuntimeProperty<Boolean> explainSlowQueries

gatherPerfMetrics	back to summary
protected boolean gatherPerfMetrics The "gatherPerfMetrics" connection property value

logSlowQueries	back to summary
protected boolean logSlowQueries The "logSlowQueries" connection property value

OPEN_CURSOR_FLAG	back to summary
public static final byte OPEN_CURSOR_FLAG

PARAMETER_COUNT_AVAILABLE	back to summary
public static final byte PARAMETER_COUNT_AVAILABLE

parameterFields	back to summary
private Field[] parameterFields Field-level metadata for parameters

profileSQL	back to summary
protected boolean profileSQL The "profileSQL" connection property value

queryWasSlow	back to summary
protected boolean queryWasSlow

resultFields	back to summary
private ColumnDefinition resultFields Field-level metadata for result sets. From statement prepare.

serverStatementId	back to summary
private long serverStatementId The ID that the server uses to identify this PreparedStatement

slowQueryThresholdMillis	back to summary
protected RuntimeProperty<Integer> slowQueryThresholdMillis

useAutoSlowLog	back to summary
private boolean useAutoSlowLog

useCursorFetch	back to summary
protected boolean useCursorFetch

Constructor Detail

ServerPreparedQuery	back to summary
protected ServerPreparedQuery(NativeSession sess)

Method Detail

clearParameters	back to summary
public void clearParameters(boolean clearServerParameters) Parameters clearServerParameters:boolean flag indicating whether we need an additional clean up

closeQuery	back to summary
public void closeQuery() Overrides com.mysql.cj.ClientPreparedQuery.closeQuery. Implements com.mysql.cj.Query.closeQuery. Annotations @Override

closeQuery

back to summary

public void closeQuery()

Overrides com.mysql.cj.ClientPreparedQuery.closeQuery.

Implements com.mysql.cj.Query.closeQuery.

Annotations

@Override

computeMaxParameterSetSizeAndBatchSize	back to summary
protected long[] computeMaxParameterSetSizeAndBatchSize(int numBatchedArgs) Overrides com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize. Computes the maximum parameter set size and the size of the entire batch given the number of arguments in the batch. Parameters numBatchedArgs:int Doc from com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize. number of batched arguments Returns:long[] Doc from com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize. new long[] { maxSizeOfParameterSet, sizeOfEntireBatch } Annotations @Override

computeMaxParameterSetSizeAndBatchSize

back to summary

protected long[] computeMaxParameterSetSizeAndBatchSize(int numBatchedArgs)

Overrides com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize.

Computes the maximum parameter set size and the size of the entire batch given the number of arguments in the batch.

Parameters

numBatchedArgs:int

Doc from com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize.

number of batched arguments

Returns:long[]

Doc from com.mysql.cj.ClientPreparedQuery.computeMaxParameterSetSizeAndBatchSize.

new long[] { maxSizeOfParameterSet, sizeOfEntireBatch }

Annotations

@Override

fillSendPacket	back to summary
public <M extends Message> M fillSendPacket(QueryBindings bindings) Overrides com.mysql.cj.ClientPreparedQuery.fillSendPacket. Implements com.mysql.cj.PreparedQuery.fillSendPacket. Annotations @Override

fillSendPacket

back to summary

public <M extends Message> M fillSendPacket(QueryBindings bindings)

Overrides com.mysql.cj.ClientPreparedQuery.fillSendPacket.

Implements com.mysql.cj.PreparedQuery.fillSendPacket.

Annotations

@Override

getInstance	back to summary
public static ServerPreparedQuery getInstance(NativeSession sess)

getParameterFields	back to summary
public Field[] getParameterFields()

getResultFields	back to summary
public ColumnDefinition getResultFields()

getServerStatementId	back to summary
public long getServerStatementId()

prepareExecutePacket	back to summary
public NativePacketPayload prepareExecutePacket()

readExecuteResult	back to summary
public <T extends Resultset> T readExecuteResult(NativePacketPayload resultPacket, int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory, String queryAsString)

sendExecutePacket	back to summary
public NativePacketPayload sendExecutePacket(NativePacketPayload packet, String queryAsString)

serverExecute back to summary

serverExecute	back to summary
public <T extends Resultset> T serverExecute(int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory) Parameters <T> extends `Resultset` maxRowsToRetrieve:int rows limit createStreamingResultSet:boolean should c/J create a streaming result? metadata:ColumnDefinition use this metadata instead of the one provided on wire resultSetFactory:ProtocolEntityFactory<T, NativePacketPayload> `ProtocolEntityFactory` Returns:T T instance

public <T extends Resultset> T serverExecute(int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T, NativePacketPayload> resultSetFactory)

Parameters

<T>: extends Resultset
maxRowsToRetrieve:int: rows limit
createStreamingResultSet:boolean: should c/J create a streaming result?
metadata:ColumnDefinition: use this metadata instead of the one provided on wire
resultSetFactory:ProtocolEntityFactory<T, NativePacketPayload>: ProtocolEntityFactory

Returns:T

T instance

serverLongData back to summary

serverLongData	back to summary
private void serverLongData(int parameterIndex, BindValue binding) Sends stream-type data parameters to the server. Long data handling: - Server gets the long data in pieces with command type 'COM_LONG_DATA'. - The packet received will have the format: [COM_LONG_DATA: 1][STMT_ID:4][parameter_number:2][type:2][data] - Checks if the type is specified by client, and if yes reads the type, and stores the data in that format. - It is up to the client to check for read data ended. The server does not care; and also server does not notify to the client that it got the data or not; if there is any error; then during execute; the error will be returned Parameters parameterIndex:int parameter index binding:BindValue `containing long data`

private void serverLongData(int parameterIndex, BindValue binding)

Sends stream-type data parameters to the server.

 Long data handling:

 - Server gets the long data in pieces with command type 'COM_LONG_DATA'.
 - The packet received will have the format:
   [COM_LONG_DATA:     1][STMT_ID:4][parameter_number:2][type:2][data]
 - Checks if the type is specified by client, and if yes reads the type,
   and  stores the data in that format.
 - It is up to the client to check for read data ended. The server does not
   care; and also server does not notify to the client that it got the
   data  or not; if there is any error; then during execute; the error
   will  be returned

Parameters

parameterIndex:int: parameter index
binding:BindValue: containing long data

serverPrepare	back to summary
public void serverPrepare(String sql) throws IOException Parameters sql:String query string Exceptions IOException: if an i/o error occurs

serverResetStatement	back to summary
public void serverResetStatement()

setParameterFields	back to summary
public void setParameterFields(Field[] parameterFields)

setResultFields	back to summary
public void setResultFields(ColumnDefinition resultFields)

setServerStatementId	back to summary
public void setServerStatementId(long serverStatementId)

statementBegins	back to summary
public void statementBegins() Overrides com.mysql.cj.AbstractQuery.statementBegins. Implements com.mysql.cj.Query.statementBegins. Annotations @Override

statementBegins

back to summary

public void statementBegins()

Overrides com.mysql.cj.AbstractQuery.statementBegins.

Implements com.mysql.cj.Query.statementBegins.

Annotations

@Override

storeStreamOrReader	back to summary
private void storeStreamOrReader(int parameterIndex, NativePacketPayload packet, Closeable streamOrReader)

truncateQueryToLog	back to summary
private String truncateQueryToLog(String sql)

public Class ServerPreparedQuery

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail