com.mysql.cj.protocol.a

Class NativeProtocol

java.lang.Object

com.mysql.cj.protocol.AbstractProtocol<NativePacketPayload>

com.mysql.cj.protocol.a.NativeProtocol

All Implemented Interfaces:

RuntimeProperty.RuntimePropertyListener, Protocol<NativePacketPayload>, Protocol.ProtocolEventHandler

public class NativeProtocol
extends AbstractProtocol<NativePacketPayload>
implements Protocol<NativePacketPayload>, RuntimeProperty.RuntimePropertyListener

Nested Class Summary

Nested classes/interfaces inherited from interface com.mysql.cj.protocol.Protocol

Protocol.ProtocolEventHandler, Protocol.ProtocolEventListener

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	COMP_HEADER_LENGTH
protected CompressedPacketSender	compressedPacketSender Track this to manually shut down.
protected boolean	hadWarnings
protected static int	INITIAL_PACKET_SIZE
protected static int	MAX_QUERY_SIZE_TO_EXPLAIN
protected MessageReader<NativePacketHeader,NativePacketPayload>	packetReader
protected MessageSender<NativePacketPayload>	packetSender
protected byte	packetSequence
protected java.util.Map<java.lang.Class<? extends ProtocolEntity>,ProtocolEntityReader<? extends ProtocolEntity,? extends Message>>	PROTOCOL_ENTITY_CLASS_TO_BINARY_READER
protected java.util.Map<java.lang.Class<? extends ProtocolEntity>,ProtocolEntityReader<? extends ProtocolEntity,? extends Message>>	PROTOCOL_ENTITY_CLASS_TO_TEXT_READER
protected NativePacketPayload	reusablePacket Use this when reading in rows to avoid thousands of new() calls, because the byte arrays just get copied out of the packet anyway
protected NativeServerSession	serverSession
protected NativePacketPayload	sharedSendPacket
protected static int	SSL_REQUEST_LENGTH
protected boolean	useCompression

Fields inherited from class com.mysql.cj.protocol.AbstractProtocol

authProvider, exceptionInterceptor, log, messageBuilder, packetDebugRingBuffer, propertySet, queryTimingUnits, session, socketConnection, transactionManager, useNanosForElapsedTime

Constructor Summary

Constructors

Constructor and Description
NativeProtocol(Log logger)

Method Summary

Modifier and Type	Method and Description
void	afterHandshake()
void	applyPacketDecorators(MessageSender<NativePacketPayload> sender, MessageReader<NativePacketHeader,NativePacketPayload> messageReader) Apply optional decorators to configured PacketSender and PacketReader.
void	beforeHandshake()
void	changeDatabase(java.lang.String database)
void	changeUser(java.lang.String user, java.lang.String password, java.lang.String database) Re-authenticates as the given user and password
NativePacketPayload	checkErrorMessage() Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading
void	checkErrorMessage(NativePacketPayload resultPacket)
void	checkForOutstandingStreamingData()
void	checkTransactionState()
void	clearInputStream()
void	close()
void	configureTimeZone() Configures the client's timezone if required.
void	connect(java.lang.String user, java.lang.String password, java.lang.String database) Create a new session.
java.sql.SQLWarning	convertShowWarningsToSQLWarnings(boolean forTruncationOnly) Turns output of 'SHOW WARNINGS' into JDBC SQLWarning instances.
void	dumpPacketRingBuffer()
void	explainSlowQuery(java.lang.String query, java.lang.String truncatedQuery) Runs an 'EXPLAIN' on the given query and dumps the results to the log
static MysqlType	findMysqlType(PropertySet propertySet, int mysqlTypeId, short colFlag, long length, LazyString tableName, LazyString originalTableName, int collationIndex, java.lang.String encoding)
java.lang.StringBuilder	generateQueryCommentBlock(java.lang.StringBuilder buf)
int	getCommandCount()
long	getCurrentTimeNanosOrMillis()
static NativeProtocol	getInstance(Session session, SocketConnection socketConnection, PropertySet propertySet, Log log, TransactionEventHandler transactionManager)
java.io.InputStream	getLocalInfileInputStream() Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement.
MessageBuilder<NativePacketPayload>	getMessageBuilder()
BaseMetricsHolder	getMetricsHolder()
MessageReader<NativePacketHeader,NativePacketPayload>	getPacketReader()
MessageSender<NativePacketPayload>	getPacketSender()
java.lang.String	getQueryComment() Returns the comment that will be prepended to all statements sent to the server.
java.util.List<QueryInterceptor>	getQueryInterceptors()
NativePacketPayload	getReusablePacket()
NativeServerSession	getServerSession()
NativePacketPayload	getSharedSendPacket() Returns the packet used for sending data (used by PreparedStatement) with position set to 0.
long	getSlowQueryThreshold()
ResultsetRows	getStreamingData()
java.util.function.Supplier<ValueEncoder>	getValueEncoderSupplier(java.lang.Object obj)
int	getWarningCount()
boolean	hadWarnings()
void	handlePropertyChange(RuntimeProperty<?> prop)
void	init(Session sess, SocketConnection phConnection, PropertySet propSet, TransactionEventHandler trManager) Init method takes the place of constructor.
void	initServerSession()
<M extends Message> M	invokeQueryInterceptorsPost(M queryPacket, M originalResponsePacket, boolean forceExecute)
<T extends Resultset> T	invokeQueryInterceptorsPost(java.util.function.Supplier<java.lang.String> sql, Query interceptedQuery, T originalResultSet, boolean forceExecute)
<M extends Message> M	invokeQueryInterceptorsPre(M queryPacket, boolean forceExecute)
<T extends Resultset> T	invokeQueryInterceptorsPre(java.util.function.Supplier<java.lang.String> sql, Query interceptedQuery, boolean forceExecute)
protected boolean	isDataAvailable()
void	negotiateSSLConnection() Negotiates the SSL communications channel used when connecting to a MySQL server that understands SSL.
NativePacketPayload	probeMessage(NativePacketPayload reuse)
void	quit() Log-off of the MySQL server and close the socket.
<T extends ProtocolEntity> T	read(java.lang.Class<Resultset> requiredClass, int maxRows, boolean streamResults, NativePacketPayload resultPacket, boolean isBinaryEncoded, ColumnDefinition metadata, ProtocolEntityFactory<T,NativePacketPayload> protocolEntityFactory) Read protocol entity.
<T extends ProtocolEntity> T	read(java.lang.Class<T> requiredClass, ProtocolEntityFactory<T,NativePacketPayload> protocolEntityFactory)
<T extends Resultset> T	readAllResults(int maxRows, boolean streamResults, NativePacketPayload resultPacket, boolean isBinaryEncoded, ColumnDefinition metadata, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
NativePacketPayload	readMessage(NativePacketPayload reuse) Read one message from the MySQL server into the reusable buffer if provided or into the new one.
ColumnDefinition	readMetadata()
<T extends ProtocolEntity> T	readNextResultset(T currentProtocolEntity, int maxRows, boolean streamResults, boolean isBinaryEncoded, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory) Read next result set from multi-result chain.
<T extends QueryResult> T	readQueryResult(ResultBuilder<T> resultBuilder) Read messages from server and deliver them to resultBuilder.
NativeCapabilities	readServerCapabilities() Retrieve ServerCapabilities from server.
<T> T	readServerStatusForResultSets(NativePacketPayload rowPacket, boolean saveOldStatus)
void	reclaimLargeReusablePacket() Don't hold on to overly-large packets
void	rejectProtocol(NativePacketPayload msg)
void	releaseResources()
void	scanForAndThrowDataTruncation()
void	send(Message packet, int packetLen)
NativePacketPayload	sendCommand(Message queryPacket, boolean skipCheck, int timeoutMillis) Send a command to the MySQL server.
NativePacketPayload	sendFileToServer(java.lang.String fileName) Reads and sends a file to the server for LOAD DATA LOCAL INFILE
<T extends Resultset> T	sendQueryPacket(Query callingQuery, NativePacketPayload queryPacket, int maxRows, boolean streamResults, ColumnDefinition cachedMetadata, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory) Send a query stored in a packet to the server.
<T extends Resultset> T	sendQueryString(Query callingQuery, java.lang.String query, java.lang.String characterEncoding, int maxRows, boolean streamResults, ColumnDefinition cachedMetadata, ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory) Build a query packet from the given string and send it to the server.
void	setHadWarnings(boolean hadWarnings)
void	setLocalInfileInputStream(java.io.InputStream stream) Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement.
void	setQueryComment(java.lang.String comment) Sets the comment that will be prepended to all statements sent to the server.
void	setQueryInterceptors(java.util.List<QueryInterceptor> queryInterceptors)
void	setSocketTimeout(int milliseconds)
void	setStreamingData(ResultsetRows streamingData)
void	setWarningCount(int warningCount)
void	skipPacket() Reads and discards a single MySQL packet from the input stream.
void	unsetStreamingData(ResultsetRows streamer)
protected boolean	useNanosForElapsedTime()
boolean	versionMeetsMinimum(int major, int minor, int subminor)

Methods inherited from class com.mysql.cj.protocol.AbstractProtocol

addListener, getAuthenticationProvider, getExceptionInterceptor, getPacketReceivedTimeHolder, getPacketSentTimeHolder, getPropertySet, getQueryTimingUnits, getSocketConnection, invokeListeners, removeListener, reset, setPacketReceivedTimeHolder, setPacketSentTimeHolder, setPropertySet

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.protocol.Protocol

getAuthenticationProvider, getExceptionInterceptor, getPacketReceivedTimeHolder, getPacketSentTimeHolder, getPropertySet, getQueryTimingUnits, getSocketConnection, reset, setPacketReceivedTimeHolder, setPacketSentTimeHolder, setPropertySet

Field Detail

INITIAL_PACKET_SIZE

protected static final int INITIAL_PACKET_SIZE

See Also:

Constant Field Values

COMP_HEADER_LENGTH

protected static final int COMP_HEADER_LENGTH

See Also:

Constant Field Values

MAX_QUERY_SIZE_TO_EXPLAIN

protected static final int MAX_QUERY_SIZE_TO_EXPLAIN

See Also:

Constant Field Values

SSL_REQUEST_LENGTH

protected static final int SSL_REQUEST_LENGTH

See Also:

Constant Field Values

packetSender

protected MessageSender<NativePacketPayload> packetSender

packetReader

protected MessageReader<NativePacketHeader,NativePacketPayload> packetReader

serverSession

protected NativeServerSession serverSession

compressedPacketSender

protected CompressedPacketSender compressedPacketSender

Track this to manually shut down.

sharedSendPacket

protected NativePacketPayload sharedSendPacket

reusablePacket

protected NativePacketPayload reusablePacket

Use this when reading in rows to avoid thousands of new() calls, because the byte arrays just get copied out of the packet anyway

packetSequence

protected byte packetSequence

useCompression

protected boolean useCompression

hadWarnings

protected boolean hadWarnings

PROTOCOL_ENTITY_CLASS_TO_TEXT_READER

protected java.util.Map<java.lang.Class<? extends ProtocolEntity>,ProtocolEntityReader<? extends ProtocolEntity,? extends Message>> PROTOCOL_ENTITY_CLASS_TO_TEXT_READER

PROTOCOL_ENTITY_CLASS_TO_BINARY_READER

protected java.util.Map<java.lang.Class<? extends ProtocolEntity>,ProtocolEntityReader<? extends ProtocolEntity,? extends Message>> PROTOCOL_ENTITY_CLASS_TO_BINARY_READER

Constructor Detail

NativeProtocol

public NativeProtocol(Log logger)

Method Detail

getInstance

public static NativeProtocol getInstance(Session session,
                                         SocketConnection socketConnection,
                                         PropertySet propertySet,
                                         Log log,
                                         TransactionEventHandler transactionManager)

init

public void init(Session sess,
                 SocketConnection phConnection,
                 PropertySet propSet,
                 TransactionEventHandler trManager)

Description copied from interface: Protocol

Init method takes the place of constructor. A constructor should be used unless the encapsulation of ProtocolFactory is necessary.

Specified by:

init in interface Protocol<NativePacketPayload>

Overrides:

init in class AbstractProtocol<NativePacketPayload>

Parameters:

sess - Session

phConnection - SocketConnection

propSet - PropertySet

trManager - TransactionEventHandler

getMessageBuilder

public MessageBuilder<NativePacketPayload> getMessageBuilder()

Specified by:

getMessageBuilder in interface Protocol<NativePacketPayload>

Overrides:

getMessageBuilder in class AbstractProtocol<NativePacketPayload>

getPacketSender

public MessageSender<NativePacketPayload> getPacketSender()

getPacketReader

public MessageReader<NativePacketHeader,NativePacketPayload> getPacketReader()

getValueEncoderSupplier

public java.util.function.Supplier<ValueEncoder> getValueEncoderSupplier(java.lang.Object obj)

Specified by:

getValueEncoderSupplier in interface Protocol<NativePacketPayload>

negotiateSSLConnection

public void negotiateSSLConnection()

Negotiates the SSL communications channel used when connecting to a MySQL server that understands SSL.

Specified by:

negotiateSSLConnection in interface Protocol<NativePacketPayload>

rejectProtocol

public void rejectProtocol(NativePacketPayload msg)

beforeHandshake

public void beforeHandshake()

Specified by:

beforeHandshake in interface Protocol<NativePacketPayload>

afterHandshake

public void afterHandshake()

Specified by:

afterHandshake in interface Protocol<NativePacketPayload>

handlePropertyChange

public void handlePropertyChange(RuntimeProperty<?> prop)

Specified by:

handlePropertyChange in interface RuntimeProperty.RuntimePropertyListener

applyPacketDecorators

public void applyPacketDecorators(MessageSender<NativePacketPayload> sender,
                                  MessageReader<NativePacketHeader,NativePacketPayload> messageReader)

Apply optional decorators to configured PacketSender and PacketReader.

Parameters:

sender - MessageSender

messageReader - MessageReader

readServerCapabilities

public NativeCapabilities readServerCapabilities()

Description copied from interface: Protocol

Retrieve ServerCapabilities from server.

Specified by:

readServerCapabilities in interface Protocol<NativePacketPayload>

Returns:

ServerCapabilities

getServerSession

public NativeServerSession getServerSession()

Specified by:

getServerSession in interface Protocol<NativePacketPayload>

changeDatabase

public void changeDatabase(java.lang.String database)

Specified by:

changeDatabase in interface Protocol<NativePacketPayload>

readMessage

public final NativePacketPayload readMessage(NativePacketPayload reuse)

Description copied from interface: Protocol

Read one message from the MySQL server into the reusable buffer if provided or into the new one.

Specified by:

readMessage in interface Protocol<NativePacketPayload>

Parameters:

reuse - Message instance to read into, may be null

Returns:

the message from the server.

probeMessage

public final NativePacketPayload probeMessage(NativePacketPayload reuse)

send

public final void send(Message packet,
                       int packetLen)

Specified by:

send in interface Protocol<NativePacketPayload>

Parameters:

packet - Message

packetLen - length of header + payload

sendCommand

public final NativePacketPayload sendCommand(Message queryPacket,
                                             boolean skipCheck,
                                             int timeoutMillis)

Description copied from interface: Protocol

Send a command to the MySQL server.

Specified by:

sendCommand in interface Protocol<NativePacketPayload>

Parameters:

queryPacket - a packet pre-loaded with data for the protocol (eg. from a client-side prepared statement). The first byte of this packet is the MySQL protocol 'command' from MysqlDefs

skipCheck - do not call checkErrorPacket() if true

timeoutMillis - timeout

Returns:

the response packet from the server

checkTransactionState

public void checkTransactionState()

checkErrorMessage

public NativePacketPayload checkErrorMessage()

Description copied from interface: Protocol

Read one message from the MySQL server, checks for errors in it, and if none, returns the message, ready for reading

Specified by:

checkErrorMessage in interface Protocol<NativePacketPayload>

Returns:

a message ready for reading.

checkErrorMessage

public void checkErrorMessage(NativePacketPayload resultPacket)

clearInputStream

public void clearInputStream()

reclaimLargeReusablePacket

public void reclaimLargeReusablePacket()

Don't hold on to overly-large packets

sendQueryString

public final <T extends Resultset> T sendQueryString(Query callingQuery,
                                                     java.lang.String query,
                                                     java.lang.String characterEncoding,
                                                     int maxRows,
                                                     boolean streamResults,
                                                     ColumnDefinition cachedMetadata,
                                                     ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
                                              throws java.io.IOException

Build a query packet from the given string and send it to the server.

Type Parameters:

T - extends Resultset

Parameters:

callingQuery - Query

query - query string

characterEncoding - Java encoding name

maxRows - rows limit

streamResults - whether a stream result should be created

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

resultSetFactory - ProtocolEntityFactory

Returns:

T instance

Throws:

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

sendQueryPacket

public final <T extends Resultset> T sendQueryPacket(Query callingQuery,
                                                     NativePacketPayload queryPacket,
                                                     int maxRows,
                                                     boolean streamResults,
                                                     ColumnDefinition cachedMetadata,
                                                     ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
                                              throws java.io.IOException

Send a query stored in a packet to the server.

Type Parameters:

T - extends Resultset

Parameters:

callingQuery - Query

queryPacket - NativePacketPayload containing query

maxRows - rows limit

streamResults - whether a stream result should be created

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

resultSetFactory - ProtocolEntityFactory

Returns:

T instance

Throws:

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

invokeQueryInterceptorsPre

public <T extends Resultset> T invokeQueryInterceptorsPre(java.util.function.Supplier<java.lang.String> sql,
                                                          Query interceptedQuery,
                                                          boolean forceExecute)

invokeQueryInterceptorsPre

public <M extends Message> M invokeQueryInterceptorsPre(M queryPacket,
                                                        boolean forceExecute)

Type Parameters:

M - extends Message

Parameters:

queryPacket - NativePacketPayload containing query

forceExecute - currently ignored

Returns:

M instance

invokeQueryInterceptorsPost

public <T extends Resultset> T invokeQueryInterceptorsPost(java.util.function.Supplier<java.lang.String> sql,
                                                           Query interceptedQuery,
                                                           T originalResultSet,
                                                           boolean forceExecute)

invokeQueryInterceptorsPost

public <M extends Message> M invokeQueryInterceptorsPost(M queryPacket,
                                                         M originalResponsePacket,
                                                         boolean forceExecute)

Type Parameters:

M - extends Message

Parameters:

queryPacket - NativePacketPayload containing query

originalResponsePacket - NativePacketPayload containing response

forceExecute - currently ignored

Returns:

T instance

getCurrentTimeNanosOrMillis

public long getCurrentTimeNanosOrMillis()

hadWarnings

public boolean hadWarnings()

setHadWarnings

public void setHadWarnings(boolean hadWarnings)

explainSlowQuery

public void explainSlowQuery(java.lang.String query,
                             java.lang.String truncatedQuery)

Runs an 'EXPLAIN' on the given query and dumps the results to the log

Parameters:

query - full query string

truncatedQuery - query string truncated for profiling

skipPacket

public final void skipPacket()

Reads and discards a single MySQL packet from the input stream.

Throws:

CJException - if the network fails while skipping the packet.

quit

public final void quit()

Log-off of the MySQL server and close the socket.

getSharedSendPacket

public NativePacketPayload getSharedSendPacket()

Returns the packet used for sending data (used by PreparedStatement) with position set to 0. Guarded by external synchronization on a mutex.

Returns:

A packet to send data with

changeUser

public void changeUser(java.lang.String user,
                       java.lang.String password,
                       java.lang.String database)

Re-authenticates as the given user and password

Specified by:

changeUser in interface Protocol<NativePacketPayload>

Parameters:

user - user name

password - password

database - database name

useNanosForElapsedTime

protected boolean useNanosForElapsedTime()

getSlowQueryThreshold

public long getSlowQueryThreshold()

getCommandCount

public int getCommandCount()

setQueryInterceptors

public void setQueryInterceptors(java.util.List<QueryInterceptor> queryInterceptors)

getQueryInterceptors

public java.util.List<QueryInterceptor> getQueryInterceptors()

setSocketTimeout

public void setSocketTimeout(int milliseconds)

releaseResources

public void releaseResources()

connect

public void connect(java.lang.String user,
                    java.lang.String password,
                    java.lang.String database)

Description copied from interface: Protocol

Create a new session. This generally happens once at the beginning of a connection.

Specified by:

connect in interface Protocol<NativePacketPayload>

Parameters:

user - DB user name

password - DB user password

database - database name

isDataAvailable

protected boolean isDataAvailable()

getReusablePacket

public NativePacketPayload getReusablePacket()

getWarningCount

public int getWarningCount()

setWarningCount

public void setWarningCount(int warningCount)

dumpPacketRingBuffer

public void dumpPacketRingBuffer()

versionMeetsMinimum

public boolean versionMeetsMinimum(int major,
                                   int minor,
                                   int subminor)

Specified by:

versionMeetsMinimum in interface Protocol<NativePacketPayload>

findMysqlType

public static MysqlType findMysqlType(PropertySet propertySet,
                                      int mysqlTypeId,
                                      short colFlag,
                                      long length,
                                      LazyString tableName,
                                      LazyString originalTableName,
                                      int collationIndex,
                                      java.lang.String encoding)

read

public <T extends ProtocolEntity> T read(java.lang.Class<T> requiredClass,
                                         ProtocolEntityFactory<T,NativePacketPayload> protocolEntityFactory)
                                  throws java.io.IOException

Specified by:

read in interface Protocol<NativePacketPayload>

Throws:

java.io.IOException

read

public <T extends ProtocolEntity> T read(java.lang.Class<Resultset> requiredClass,
                                         int maxRows,
                                         boolean streamResults,
                                         NativePacketPayload resultPacket,
                                         boolean isBinaryEncoded,
                                         ColumnDefinition metadata,
                                         ProtocolEntityFactory<T,NativePacketPayload> protocolEntityFactory)
                                  throws java.io.IOException

Description copied from interface: Protocol

Read protocol entity.

Specified by:

read in interface Protocol<NativePacketPayload>

Type Parameters:

T - object extending the ProtocolEntity

Parameters:

requiredClass - required Resultset class

maxRows - the maximum number of rows to read (-1 means all rows)

streamResults - should the driver leave the results on the wire, and read them only when needed?

resultPacket - the first packet of information in the result set

isBinaryEncoded - true if the binary protocol is used (for server prepared statements)

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

protocolEntityFactory - ProtocolEntityFactory instance

Returns:

ProtocolEntity instance

Throws:

java.io.IOException - if an error occurs

readNextResultset

public <T extends ProtocolEntity> T readNextResultset(T currentProtocolEntity,
                                                      int maxRows,
                                                      boolean streamResults,
                                                      boolean isBinaryEncoded,
                                                      ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
                                               throws java.io.IOException

Read next result set from multi-result chain.

Type Parameters:

T - extends ProtocolEntity

Parameters:

currentProtocolEntity - T instance

maxRows - rows limit

streamResults - whether a stream result should be created

isBinaryEncoded - true for binary protocol

resultSetFactory - ProtocolEntityFactory

Returns:

T instance

Throws:

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

readAllResults

public <T extends Resultset> T readAllResults(int maxRows,
                                              boolean streamResults,
                                              NativePacketPayload resultPacket,
                                              boolean isBinaryEncoded,
                                              ColumnDefinition metadata,
                                              ProtocolEntityFactory<T,NativePacketPayload> resultSetFactory)
                                       throws java.io.IOException

Throws:

java.io.IOException

readServerStatusForResultSets

public final <T> T readServerStatusForResultSets(NativePacketPayload rowPacket,
                                                 boolean saveOldStatus)

readQueryResult

public <T extends QueryResult> T readQueryResult(ResultBuilder<T> resultBuilder)

Description copied from interface: Protocol

Read messages from server and deliver them to resultBuilder.

Specified by:

readQueryResult in interface Protocol<NativePacketPayload>

Type Parameters:

T - result type

Parameters:

resultBuilder - ResultBuilder instance

Returns:

QueryResult

getLocalInfileInputStream

public java.io.InputStream getLocalInfileInputStream()

Description copied from interface: Protocol

Returns the InputStream instance that will be used to send data in response to a "LOAD DATA LOCAL INFILE" statement. This method returns NULL if no such stream has been set via setLocalInfileInputStream().

Specified by:

getLocalInfileInputStream in interface Protocol<NativePacketPayload>

Returns:

input stream

setLocalInfileInputStream

public void setLocalInfileInputStream(java.io.InputStream stream)

Description copied from interface: Protocol

Sets an InputStream instance that will be used to send data to the MySQL server for a "LOAD DATA LOCAL INFILE" statement rather than a FileInputStream or URLInputStream that represents the path given as an argument to the statement. This stream will be read to completion upon execution of a "LOAD DATA LOCAL INFILE" statement, and will automatically be closed by the driver, so it needs to be reset before each call to execute*() that would cause the MySQL server to request data to fulfill the request for "LOAD DATA LOCAL INFILE". If this value is set to NULL, the driver will revert to using a FileInputStream or URLInputStream as required.

Specified by:

setLocalInfileInputStream in interface Protocol<NativePacketPayload>

Parameters:

stream - input stream

sendFileToServer

public final NativePacketPayload sendFileToServer(java.lang.String fileName)

Reads and sends a file to the server for LOAD DATA LOCAL INFILE

Parameters:

fileName - the file name to send.

Returns:

NativePacketPayload

getStreamingData

public ResultsetRows getStreamingData()

setStreamingData

public void setStreamingData(ResultsetRows streamingData)

checkForOutstandingStreamingData

public void checkForOutstandingStreamingData()

unsetStreamingData

public void unsetStreamingData(ResultsetRows streamer)

scanForAndThrowDataTruncation

public void scanForAndThrowDataTruncation()

generateQueryCommentBlock

public java.lang.StringBuilder generateQueryCommentBlock(java.lang.StringBuilder buf)

getMetricsHolder

public BaseMetricsHolder getMetricsHolder()

getQueryComment

public java.lang.String getQueryComment()

Description copied from interface: Protocol

Returns the comment that will be prepended to all statements sent to the server.

Specified by:

getQueryComment in interface Protocol<NativePacketPayload>

Returns:

query comment string

setQueryComment

public void setQueryComment(java.lang.String comment)

Description copied from interface: Protocol

Sets the comment that will be prepended to all statements sent to the server. Do not use slash-star or star-slash tokens in the comment as these will be added by the driver itself.

Specified by:

setQueryComment in interface Protocol<NativePacketPayload>

Parameters:

comment - query comment string

convertShowWarningsToSQLWarnings

public java.sql.SQLWarning convertShowWarningsToSQLWarnings(boolean forTruncationOnly)

Turns output of 'SHOW WARNINGS' into JDBC SQLWarning instances. If 'forTruncationOnly' is true, only looks for truncation warnings, and actually throws DataTruncation as an exception.

Parameters:

forTruncationOnly - if this method should only scan for data truncation warnings

Returns:

the SQLWarning chain (or null if no warnings)

readMetadata

public ColumnDefinition readMetadata()

Specified by:

readMetadata in interface Protocol<NativePacketPayload>

close

public void close()
           throws java.io.IOException

Specified by:

close in interface Protocol<NativePacketPayload>

Throws:

java.io.IOException

configureTimeZone

public void configureTimeZone()

Configures the client's timezone if required.

Specified by:

configureTimeZone in interface Protocol<NativePacketPayload>

Throws:

CJException - if the timezone the server is configured to use can't be mapped to a Java timezone.

initServerSession

public void initServerSession()

Specified by:

initServerSession in interface Protocol<NativePacketPayload>