Package org.mariadb.jdbc.message.client

Class QueryWithParametersPacket

java.lang.Object

org.mariadb.jdbc.message.client.QueryWithParametersPacket

All Implemented Interfaces:

RedoableClientMessage, ClientMessage

public final class QueryWithParametersPacket
extends Object
implements RedoableClientMessage

Query client packet COM_QUERY see https://mariadb.com/kb/en/com_query/ same than QueryPacket, but with parameters that will be escaped

Constructor Summary

Constructors

Constructor	Description
QueryWithParametersPacket(String preSqlCmd, ClientParser parser, Parameters parameters, InputStream localInfileInputStream)	Constructor

Method Summary

Modifier and Type	Method	Description
int	batchUpdateLength()	Number of parameter rows, and so expected return length
String	description()	Message description
int	encode(Writer encoder, Context context)	Encode client message to socket.
void	ensureReplayable(Context context)	Ensure that command can be replayed
InputStream	getLocalInfileInputStream()	Get current local infile input stream.
void	saveParameters()	Save parameters of command that can be re-executed
boolean	validateLocalFileName(String fileName, Context context)	Request for local file to be validated from current query.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mariadb.jdbc.message.ClientMessage

binaryProtocol, canSkipMeta, mightBeBulkResult, readPacket

Methods inherited from interface org.mariadb.jdbc.message.client.RedoableClientMessage

encode, reEncode

Constructor Details

QueryWithParametersPacket

public QueryWithParametersPacket(String preSqlCmd,
 ClientParser parser,
 Parameters parameters,
 InputStream localInfileInputStream)

Constructor

Parameters:

preSqlCmd - additional pre command

parser - command parser result

parameters - parameters

localInfileInputStream - local infile input stream

Method Details

ensureReplayable

public void ensureReplayable(Context context)
                      throws IOException,
SQLException

Description copied from interface: RedoableClientMessage

Ensure that command can be replayed

Specified by:

ensureReplayable in interface RedoableClientMessage

Parameters:

context - connection context

Throws:

IOException - If socket error occurs

SQLException - for other type of issue

saveParameters

public void saveParameters()

Description copied from interface: RedoableClientMessage

Save parameters of command that can be re-executed

Specified by:

saveParameters in interface RedoableClientMessage

encode

public int encode(Writer encoder,
 Context context)
           throws IOException,
SQLException

Description copied from interface: ClientMessage

Encode client message to socket.

Specified by:

encode in interface ClientMessage

Parameters:

encoder - socket writer

context - connection context

Returns:

number of client message written

Throws:

IOException - if socket error occur

SQLException - if any issue occurs

batchUpdateLength

public int batchUpdateLength()

Description copied from interface: ClientMessage

Number of parameter rows, and so expected return length

Specified by:

batchUpdateLength in interface ClientMessage

Returns:

batch update length

validateLocalFileName

public boolean validateLocalFileName(String fileName,
 Context context)

Description copied from interface: ClientMessage

Request for local file to be validated from current query.

Specified by:

validateLocalFileName in interface ClientMessage

Parameters:

fileName - server file request path

context - current connection context

Returns:

true if file name correspond to demand and query is a load local infile

getLocalInfileInputStream

public InputStream getLocalInfileInputStream()

Description copied from interface: ClientMessage

Get current local infile input stream.

Specified by:

getLocalInfileInputStream in interface ClientMessage

Returns:

default to null

description

public String description()

Description copied from interface: ClientMessage

Message description

Specified by:

description in interface ClientMessage

Returns:

description