org.postgresql.core.v3

Class BatchedQuery

java.lang.Object

org.postgresql.core.v3.BatchedQuery

public class BatchedQuery
extends Object

Purpose of this object is to support batched query re write behaviour. Responsibility for tracking the batch size and implement the clean up of the query fragments after the batch execute is complete. Intended to be used to wrap a Query that is present in the batchStatements collection.

Author:

Jeremy Whiting [email protected], Christopher Deckers ([email protected])

Constructor Summary

Constructors

Constructor and Description
BatchedQuery(NativeQuery query, org.postgresql.core.v3.ProtocolConnectionImpl protoConnection, int valuesBraceOpenPosition, int valuesBraceClosePosition)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this query and free any server-side resources associated with it.
ParameterList	createParameterList() Create a ParameterList suitable for storing parameters associated with this Query.
BatchedQuery	deriveForMultiBatch(int valueBlock)
int	getBatchSize() Get the number of times this Query has been batched.
int	getBindCount()
int	getMaxResultRowSize() Return maximum size in bytes that each result row from this query may return.
org.postgresql.core.v3.SimpleQuery[]	getSubqueries() Return a list of the SimpleQuery objects that make up this query.
boolean	hasBinaryFields()
boolean	isEmpty()
boolean	isStatementDescribed()
void	setHasBinaryFields(boolean hasBinaryFields)
String	toString()
String	toString(ParameterList parameters) Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchedQuery

public BatchedQuery(NativeQuery query,
            org.postgresql.core.v3.ProtocolConnectionImpl protoConnection,
            int valuesBraceOpenPosition,
            int valuesBraceClosePosition)

Method Detail

deriveForMultiBatch

public BatchedQuery deriveForMultiBatch(int valueBlock)

getBatchSize

public int getBatchSize()

Description copied from interface: Query

Get the number of times this Query has been batched.

Returns:

number of times addBatch() has been called.

toString

public String toString()

createParameterList

public ParameterList createParameterList()

Description copied from interface: Query

Create a ParameterList suitable for storing parameters associated with this Query.

If this query has no parameters, a ParameterList will be returned, but it may be a shared immutable object. If this query does have parameters, the returned ParameterList is a new list, unshared by other callers.

Returns:

a suitable ParameterList instance for this query

toString

public String toString(ParameterList parameters)

Description copied from interface: Query

Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.

Parameters:

parameters - a ParameterList returned by this Query's Query.createParameterList() method, or null to leave the parameter placeholders unsubstituted.

Returns:

a human-readable representation of this query

close

public void close()

Description copied from interface: Query

Close this query and free any server-side resources associated with it. The resources may not be immediately deallocated, but closing a Query may make the deallocation more prompt.

A closed Query should not be executed.

getSubqueries

public org.postgresql.core.v3.SimpleQuery[] getSubqueries()

Return a list of the SimpleQuery objects that make up this query. If this object is already a SimpleQuery, returns null (avoids an extra array construction in the common case).

Returns:

an array of single-statement queries, or null if this object is already a single-statement query.

getMaxResultRowSize

public int getMaxResultRowSize()

Return maximum size in bytes that each result row from this query may return. Mainly used for batches that return results. Results are cached until/unless the query is re-described.

Returns:

Max size of result data in bytes according to returned fields, 0 if no results, -1 if result is unbounded.

Throws:

IllegalStateException - if the query is not described

hasBinaryFields

public boolean hasBinaryFields()

setHasBinaryFields

public void setHasBinaryFields(boolean hasBinaryFields)

isStatementDescribed

public boolean isStatementDescribed()

isEmpty

public boolean isEmpty()

getBindCount

public final int getBindCount()