com.mysql.cj

Class ServerPreparedQuery

java.lang.Object

com.mysql.cj.AbstractQuery

com.mysql.cj.ClientPreparedQuery

com.mysql.cj.ServerPreparedQuery

All Implemented Interfaces:

PreparedQuery, Query

Direct Known Subclasses:

ServerPreparedQueryTestcaseGenerator

public class ServerPreparedQuery
extends ClientPreparedQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.Query

Query.CancelStatus

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOB_STREAM_READ_BUF_SIZE
protected NativeMessageBuilder	commandBuilder
protected RuntimeProperty<java.lang.Boolean>	explainSlowQueries
protected boolean	gatherPerfMetrics The "gatherPerfMetrics" connection property value
protected boolean	logSlowQueries The "logSlowQueries" connection property value
static byte	OPEN_CURSOR_FLAG
static 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<java.lang.Integer>	slowQueryThresholdMillis
private boolean	useAutoSlowLog
protected boolean	useCursorFetch

Fields inherited from class com.mysql.cj.ClientPreparedQuery

autoClosePStmtStreams, batchCommandIndex, originalSql, parameterCount, queryBindings, queryInfo, useStreamLengthsInPrepStmts

Fields inherited from class com.mysql.cj.AbstractQuery

batchedArgs, cancelTimeoutMutex, charEncoding, clearWarningsCalled, currentDb, fetchSize, maxAllowedPacket, queryAttributesBindings, resultSetType, session, statementCounter, statementExecuting, statementId, timeoutInMillis

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerPreparedQuery(NativeSession sess)

Method Summary

Modifier and Type	Method and Description
void	clearParameters(boolean clearServerParameters)
void	closeQuery()
protected long[]	computeMaxParameterSetSizeAndBatchSize(int numBatchedArgs) Computes the maximum parameter set size and the size of the entire batch given the number of arguments in the batch.
<M extends Message> M	fillSendPacket(QueryBindings bindings)
static ServerPreparedQuery	getInstance(NativeSession sess)
Field[]	getParameterFields()
ColumnDefinition	getResultFields()
long	getServerStatementId()
NativePacketPayload	prepareExecutePacket()
<T extends Resultset> T	readExecuteResult(NativePacketPayload resultPacket, int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory, java.lang.String queryAsString)
NativePacketPayload	sendExecutePacket(NativePacketPayload packet, java.lang.String queryAsString)
<T extends Resultset> T	serverExecute(int maxRowsToRetrieve, boolean createStreamingResultSet, ColumnDefinition metadata, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
private void	serverLongData(int parameterIndex, BindValue binding) Sends stream-type data parameters to the server.
void	serverPrepare(java.lang.String sql)
void	serverResetStatement()
void	setParameterFields(Field[] parameterFields)
void	setResultFields(ColumnDefinition resultFields)
void	setServerStatementId(long serverStatementId)
void	statementBegins()
private void	storeStreamOrReader(int parameterIndex, NativePacketPayload packet, java.io.Closeable streamOrReader)
private java.lang.String	truncateQueryToLog(java.lang.String sql)

Methods inherited from class com.mysql.cj.ClientPreparedQuery

asSql, checkNullOrEmptyQuery, computeBatchSize, getBatchCommandIndex, getOriginalSql, getParameterCount, getQueryBindings, getQueryInfo, setBatchCommandIndex, setOriginalSql, setParameterCount, setQueryBindings, setQueryInfo

Methods inherited from class com.mysql.cj.AbstractQuery

addBatch, checkCancelTimeout, clearBatchedArgs, getBatchedArgs, getCancelTimeoutMutex, getCurrentDatabase, getExecuteTime, getId, getQueryAttributesBindings, getResultFetchSize, getResultSetFactory, getResultType, getSession, getStatementExecuting, getTimeoutInMillis, isClearWarningsCalled, resetCancelledState, setCancelStatus, setClearWarningsCalled, setCurrentDatabase, setExecuteTime, setResultFetchSize, setResultType, setTimeoutInMillis, startQueryTimer, stopQueryTimer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mysql.cj.Query

addBatch, checkCancelTimeout, clearBatchedArgs, getBatchedArgs, getCancelTimeoutMutex, getCurrentDatabase, getExecuteTime, getId, getQueryAttributesBindings, getResultFetchSize, getResultSetFactory, getResultType, getSession, getStatementExecuting, getTimeoutInMillis, isClearWarningsCalled, resetCancelledState, setCancelStatus, setClearWarningsCalled, setCurrentDatabase, setExecuteTime, setResultFetchSize, setResultType, setTimeoutInMillis, startQueryTimer, stopQueryTimer

Field Detail

BLOB_STREAM_READ_BUF_SIZE

public static final int BLOB_STREAM_READ_BUF_SIZE

See Also:

Constant Field Values

OPEN_CURSOR_FLAG

public static final byte OPEN_CURSOR_FLAG

See Also:

Constant Field Values

PARAMETER_COUNT_AVAILABLE

public static final byte PARAMETER_COUNT_AVAILABLE

See Also:

Constant Field Values

serverStatementId

private long serverStatementId

The ID that the server uses to identify this PreparedStatement

parameterFields

private Field[] parameterFields

Field-level metadata for parameters

resultFields

private ColumnDefinition resultFields

Field-level metadata for result sets. From statement prepare.

profileSQL

protected boolean profileSQL

The "profileSQL" connection property value

gatherPerfMetrics

protected boolean gatherPerfMetrics

The "gatherPerfMetrics" connection property value

logSlowQueries

protected boolean logSlowQueries

The "logSlowQueries" connection property value

useAutoSlowLog

private boolean useAutoSlowLog

slowQueryThresholdMillis

protected RuntimeProperty<java.lang.Integer> slowQueryThresholdMillis

explainSlowQueries

protected RuntimeProperty<java.lang.Boolean> explainSlowQueries

useCursorFetch

protected boolean useCursorFetch

queryWasSlow

protected boolean queryWasSlow

commandBuilder

protected NativeMessageBuilder commandBuilder

Constructor Detail

ServerPreparedQuery

protected ServerPreparedQuery(NativeSession sess)

Method Detail

getInstance

public static ServerPreparedQuery getInstance(NativeSession sess)

serverPrepare

public void serverPrepare(java.lang.String sql)
                   throws java.io.IOException

Parameters:

sql - query string

Throws:

java.io.IOException - if an i/o error occurs

statementBegins

public void statementBegins()

Specified by:

statementBegins in interface Query

Overrides:

statementBegins in class AbstractQuery

serverExecute

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

Type Parameters:

T - extends Resultset

Parameters:

maxRowsToRetrieve - rows limit

createStreamingResultSet - should c/J create a streaming result?

metadata - use this metadata instead of the one provided on wire

resultSetFactory - ProtocolEntityFactory

Returns:

T instance

prepareExecutePacket

public NativePacketPayload prepareExecutePacket()

sendExecutePacket

public NativePacketPayload sendExecutePacket(NativePacketPayload packet,
                                             java.lang.String queryAsString)

readExecuteResult

public <T extends Resultset> T readExecuteResult(NativePacketPayload resultPacket,
                                                 int maxRowsToRetrieve,
                                                 boolean createStreamingResultSet,
                                                 ColumnDefinition metadata,
                                                 ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory,
                                                 java.lang.String queryAsString)

serverLongData

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 - parameter index

binding - containing long data

closeQuery

public void closeQuery()

Specified by:

closeQuery in interface Query

Overrides:

closeQuery in class ClientPreparedQuery

getServerStatementId

public long getServerStatementId()

setServerStatementId

public void setServerStatementId(long serverStatementId)

getParameterFields

public Field[] getParameterFields()

setParameterFields

public void setParameterFields(Field[] parameterFields)

getResultFields

public ColumnDefinition getResultFields()

setResultFields

public void setResultFields(ColumnDefinition resultFields)

storeStreamOrReader

private void storeStreamOrReader(int parameterIndex,
                                 NativePacketPayload packet,
                                 java.io.Closeable streamOrReader)

clearParameters

public void clearParameters(boolean clearServerParameters)

Parameters:

clearServerParameters - flag indicating whether we need an additional clean up

serverResetStatement

public void serverResetStatement()

computeMaxParameterSetSizeAndBatchSize

protected long[] computeMaxParameterSetSizeAndBatchSize(int numBatchedArgs)

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

Overrides:

computeMaxParameterSetSizeAndBatchSize in class ClientPreparedQuery

Parameters:

numBatchedArgs - number of batched arguments

Returns:

new long[] { maxSizeOfParameterSet, sizeOfEntireBatch }

truncateQueryToLog

private java.lang.String truncateQueryToLog(java.lang.String sql)

fillSendPacket

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

Specified by:

fillSendPacket in interface PreparedQuery

Overrides:

fillSendPacket in class ClientPreparedQuery