org.mariadb.jdbc.internal.packet.dao.parameters

Class StreamParameter

java.lang.Object

org.mariadb.jdbc.internal.packet.dao.parameters.LongDataParameter

org.mariadb.jdbc.internal.packet.dao.parameters.StreamParameter

All Implemented Interfaces:

ParameterHolder

public class StreamParameter
extends LongDataParameter

Constructor Summary

Constructors

Constructor and Description
StreamParameter(InputStream is, boolean noBackSlashEscapes)
StreamParameter(InputStream is, long length, boolean noBackslashEscapes) Constructor.

Method Summary

Modifier and Type	Method and Description
long	getApproximateTextProtocolLength() Return approximated data calculated length.
MariaDbType	getMariaDbType()
boolean	isNullData()
void	sendComLongData(int statementId, short parameterId, PacketOutputStream writer) Send stream in one or many COM_STMT_LONG_DATA.
String	toString()
void	writeTo(PacketOutputStream os) Write stream in text format.
void	writeUnsafeTo(PacketOutputStream os) Write stream in text format without checking buffer size.

Methods inherited from class org.mariadb.jdbc.internal.packet.dao.parameters.LongDataParameter

isLongData

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamParameter

public StreamParameter(InputStream is,
                       long length,
                       boolean noBackslashEscapes)

Constructor.

Parameters:

is - stream to write

length - max length to write (if null the whole stream will be send)

noBackslashEscapes - must backslash be escape

StreamParameter

public StreamParameter(InputStream is,
                       boolean noBackSlashEscapes)

Method Detail

writeTo

public void writeTo(PacketOutputStream os)
             throws IOException

Write stream in text format.

Parameters:

os - database outputStream

Throws:

IOException - if any error occur when reader stream

writeUnsafeTo

public void writeUnsafeTo(PacketOutputStream os)
                   throws IOException

Write stream in text format without checking buffer size.

Parameters:

os - database outputStream

Throws:

IOException - if any error occur when reader stream

getApproximateTextProtocolLength

public long getApproximateTextProtocolLength()
                                      throws IOException

Return approximated data calculated length.

Returns:

approximated data length.

Throws:

IOException - if error reading stream

sendComLongData

public void sendComLongData(int statementId,
                            short parameterId,
                            PacketOutputStream writer)
                     throws IOException,
                            QueryException

Send stream in one or many COM_STMT_LONG_DATA. (stream read is using a big buffer to avoid having a lot of packet, because server will allocate/deallocate array each send)

Specified by:

sendComLongData in class LongDataParameter

Parameters:

statementId - statement id

parameterId - parameter number

writer - writer

Throws:

IOException - if any connection exception occur

QueryException - if query size is to big according to server max_allowed_size

toString

public String toString()

Specified by:

toString in interface ParameterHolder

Overrides:

toString in class Object

getMariaDbType

public MariaDbType getMariaDbType()

isNullData

public boolean isNullData()

Specified by:

isNullData in interface ParameterHolder

Overrides:

isNullData in class LongDataParameter