PostgreSQL JDBC Driver 42.7.2 · org.postgresql.core.v3.SimpleQuery

Modifier and Type	Field and Description
private @Nullable Integer	cachedMaxResultRowSize
private @Nullable PhantomReference<?>	cleanupRef
private short	deallocateEpoch
private @Nullable byte[]	encodedStatementName
private @Nullable Field[]	fields The stored fields from previous execution or describe of a prepared statement.
private boolean	hasBinaryFields
private static final Logger	LOGGER
private final NativeQuery	nativeQuery
private boolean	needUpdateFieldFormats
pack-priv static final SimpleParameterList	NO_PARAMETERS
private boolean	portalDescribed
private @Nullable int[]	preparedTypes
private @Nullable Map<String, Integer>	resultSetColumnNameIndexMap
private final boolean	sanitiserDisabled
private boolean	statementDescribed
private @Nullable String	statementName
private final @Nullable TypeTransferModeRegistry	transferModeRegistry
private @Nullable BitSet	unspecifiedParams

Access	Constructor and Description
pack-priv	SimpleQuery(SimpleQuery src)
pack-priv	SimpleQuery(NativeQuery query, @Nullable TypeTransferModeRegistry transferModeRegistry, boolean sanitiserDisabled)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements org.postgresql.core.Query.close. Close this query and free any server-side resources associated with it.
public ParameterList	createParameterList() Implements org.postgresql.core.Query.createParameterList. Create a ParameterList suitable for storing parameters associated with this Query.
public int	getBatchSize() Implements org.postgresql.core.Query.getBatchSize. Get the number of times this Query has been batched.
public final int	getBindCount()
pack-priv @Nullable byte[]	getEncodedStatementName()
pack-priv @Nullable Field[]	Returns: the fields that this query will return. getFields() Returns the fields that this query will return.
public int	Returns: Max size of result data in bytes according to returned fields, 0 if no results, -1 if result is unbounded. getMaxResultRowSize() Return maximum size in bytes that each result row from this query may return.
pack-priv NativeQuery	getNativeQuery()
public String	getNativeSql() Implements org.postgresql.core.Query.getNativeSql. Returns SQL in native for database format.
pack-priv @Nullable int[]	getPrepareTypes()
public @Nullable Map<String, Integer>	getResultSetColumnNameIndexMap() Implements org.postgresql.core.Query.getResultSetColumnNameIndexMap. Get a map that a result set can use to find the index associated to a name.
public SqlCommand	getSqlCommand() Implements org.postgresql.core.Query.getSqlCommand. Returns properties of the query (sql keyword, and some other parsing info).
pack-priv @Nullable String	getStatementName()
public @Nullable SimpleQuery[]	getSubqueries() Implements org.postgresql.core.Query.getSubqueries. Return a list of the Query objects that make up this query.
public boolean	hasBinaryFields()
pack-priv boolean	hasUnresolvedTypes()
public boolean	isEmpty() Implements org.postgresql.core.Query.isEmpty.
pack-priv boolean	isPortalDescribed()
pack-priv boolean	isPreparedFor(int[] paramTypes, short deallocateEpoch)
public boolean	isStatementDescribed() Implements org.postgresql.core.Query.isStatementDescribed.
pack-priv boolean	Returns: true if current query needs field formats be adjusted as per connection configuration needUpdateFieldFormats() Returns true if current query needs field formats be adjusted as per connection configuration.
public void	resetNeedUpdateFieldFormats()
pack-priv void	setCleanupRef(PhantomReference<?> cleanupRef)
pack-priv void	setFields(@Nullable Field[] The fields that this query will return. fields) Sets the fields that this query will return.
public void	setHasBinaryFields(boolean hasBinaryFields)
pack-priv void	setPortalDescribed(boolean portalDescribed)
pack-priv void	setPrepareTypes(int[] paramTypes)
pack-priv void	setStatementDescribed(boolean statementDescribed)
pack-priv void	setStatementName(String statementName, short deallocateEpoch)
public String	toString(@Nullable ParameterList parameters)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv void	unprepare()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

cachedMaxResultRowSize	back to summary
private @Nullable Integer cachedMaxResultRowSize

cleanupRef	back to summary
private @Nullable PhantomReference<?> cleanupRef

deallocateEpoch	back to summary
private short deallocateEpoch

encodedStatementName	back to summary
private @Nullable byte[] encodedStatementName

fields	back to summary
private @Nullable Field[] fields The stored fields from previous execution or describe of a prepared statement. Always null for non-prepared statements.

hasBinaryFields	back to summary
private boolean hasBinaryFields

LOGGER	back to summary
private static final Logger LOGGER

nativeQuery	back to summary
private final NativeQuery nativeQuery

needUpdateFieldFormats	back to summary
private boolean needUpdateFieldFormats

NO_PARAMETERS	back to summary
pack-priv static final SimpleParameterList NO_PARAMETERS

portalDescribed	back to summary
private boolean portalDescribed

preparedTypes	back to summary
private @Nullable int[] preparedTypes

resultSetColumnNameIndexMap	back to summary
private @Nullable Map<String, Integer> resultSetColumnNameIndexMap

sanitiserDisabled	back to summary
private final boolean sanitiserDisabled

statementDescribed	back to summary
private boolean statementDescribed

statementName	back to summary
private @Nullable String statementName

transferModeRegistry	back to summary
private final @Nullable TypeTransferModeRegistry transferModeRegistry

unspecifiedParams	back to summary
private @Nullable BitSet unspecifiedParams

SimpleQuery	back to summary
pack-priv SimpleQuery(SimpleQuery src)

SimpleQuery	back to summary
pack-priv SimpleQuery(NativeQuery query, @Nullable TypeTransferModeRegistry transferModeRegistry, boolean sanitiserDisabled)

Method Detail

close	back to summary
public void close() Implements org.postgresql.core.Query.close. Doc from org.postgresql.core.Query.close. 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. Annotations @Override

back to summary

public void close()

Implements org.postgresql.core.Query.close.

Doc from org.postgresql.core.Query.close.

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.

Annotations

@Override

createParameterList	back to summary
public ParameterList createParameterList() Implements org.postgresql.core.Query.createParameterList. Doc from org.postgresql.core.Query.createParameterList. 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:ParameterList a suitable ParameterList instance for this query Annotations @Override

createParameterList

back to summary

public ParameterList createParameterList()

Implements org.postgresql.core.Query.createParameterList.

Doc from org.postgresql.core.Query.createParameterList.

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:ParameterList

a suitable ParameterList instance for this query

Annotations

@Override

getBatchSize back to summary

getBatchSize	back to summary
public int getBatchSize() Implements org.postgresql.core.Query.getBatchSize. Doc from org.postgresql.core.Query.getBatchSize. Get the number of times this Query has been batched. Returns:int number of times `addBatch()` has been called. Annotations @Override

public int getBatchSize()

Implements org.postgresql.core.Query.getBatchSize.

Doc from org.postgresql.core.Query.getBatchSize.

Get the number of times this Query has been batched.

Returns:int

number of times addBatch() has been called.

Annotations

@Override

getBindCount	back to summary
public final int getBindCount()

getEncodedStatementName	back to summary
pack-priv @Nullable byte[] getEncodedStatementName()

getFields	back to summary
pack-priv @Nullable Field[] getFields() Returns the fields that this query will return. If the result set fields are not known returns null. Returns:@Nullable Field[] the fields that this query will return.

getFields

back to summary

pack-priv @Nullable Field[] getFields()

Returns the fields that this query will return. If the result set fields are not known returns null.

Returns:@Nullable Field[]: the fields that this query will return.

getMaxResultRowSize	back to summary
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:int Max size of result data in bytes according to returned fields, 0 if no results, -1 if result is unbounded. Exceptions IllegalStateException: if the query is not described

getMaxResultRowSize

back to summary

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:int

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

Exceptions

IllegalStateException:: if the query is not described

getNativeQuery	back to summary
pack-priv NativeQuery getNativeQuery()

getNativeSql	back to summary
public String getNativeSql() Implements org.postgresql.core.Query.getNativeSql. Doc from org.postgresql.core.Query.getNativeSql. Returns SQL in native for database format. Returns:String SQL in native for database format Annotations @Override

getNativeSql

back to summary

public String getNativeSql()

Implements org.postgresql.core.Query.getNativeSql.

Doc from org.postgresql.core.Query.getNativeSql.

Returns SQL in native for database format.

Returns:String

SQL in native for database format

Annotations

@Override

getPrepareTypes	back to summary
pack-priv @Nullable int[] getPrepareTypes()

getResultSetColumnNameIndexMap	back to summary
public @Nullable Map<String, Integer> getResultSetColumnNameIndexMap() Implements org.postgresql.core.Query.getResultSetColumnNameIndexMap. Doc from org.postgresql.core.Query.getResultSetColumnNameIndexMap. Get a map that a result set can use to find the index associated to a name. Returns:@Nullable Map<String, Integer> null if the query implementation does not support this method. Annotations @Override

getResultSetColumnNameIndexMap

back to summary

public @Nullable Map<String, Integer> getResultSetColumnNameIndexMap()

Implements org.postgresql.core.Query.getResultSetColumnNameIndexMap.

Doc from org.postgresql.core.Query.getResultSetColumnNameIndexMap.

Get a map that a result set can use to find the index associated to a name.

Returns:@Nullable Map<String, Integer>

null if the query implementation does not support this method.

Annotations

@Override

getSqlCommand	back to summary
public SqlCommand getSqlCommand() Implements org.postgresql.core.Query.getSqlCommand. Doc from org.postgresql.core.Query.getSqlCommand. Returns properties of the query (sql keyword, and some other parsing info). Returns:SqlCommand returns properties of the query (sql keyword, and some other parsing info) or null if not applicable Annotations @Override

getSqlCommand

back to summary

public SqlCommand getSqlCommand()

Implements org.postgresql.core.Query.getSqlCommand.

Doc from org.postgresql.core.Query.getSqlCommand.

Returns properties of the query (sql keyword, and some other parsing info).

Returns:SqlCommand

returns properties of the query (sql keyword, and some other parsing info) or null if not applicable

Annotations

@Override

getStatementName	back to summary
pack-priv @Nullable String getStatementName()

getSubqueries back to summary

getSubqueries	back to summary
public @Nullable SimpleQuery[] getSubqueries() Implements org.postgresql.core.Query.getSubqueries. Doc from org.postgresql.core.Query.getSubqueries. Return a list of the Query 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:@Nullable SimpleQuery[] an array of single-statement queries, or `null` if this object is already a single-statement query. Annotations @Override

public @Nullable SimpleQuery[] getSubqueries()

Implements org.postgresql.core.Query.getSubqueries.

Doc from org.postgresql.core.Query.getSubqueries.

Return a list of the Query 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:@Nullable SimpleQuery[]

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

Annotations

@Override

hasBinaryFields	back to summary
public boolean hasBinaryFields()

hasUnresolvedTypes	back to summary
pack-priv boolean hasUnresolvedTypes()

isEmpty	back to summary
public boolean isEmpty() Implements org.postgresql.core.Query.isEmpty. Annotations @Override

isEmpty

back to summary

public boolean isEmpty()

Implements org.postgresql.core.Query.isEmpty.

Annotations

@Override

isPortalDescribed	back to summary
pack-priv boolean isPortalDescribed()

isPreparedFor	back to summary
pack-priv boolean isPreparedFor(int[] paramTypes, short deallocateEpoch)

isStatementDescribed	back to summary
public boolean isStatementDescribed() Implements org.postgresql.core.Query.isStatementDescribed. Annotations @Override

isStatementDescribed

back to summary

public boolean isStatementDescribed()

Implements org.postgresql.core.Query.isStatementDescribed.

Annotations

@Override

needUpdateFieldFormats back to summary

needUpdateFieldFormats	back to summary
pack-priv boolean needUpdateFieldFormats() Returns true if current query needs field formats be adjusted as per connection configuration. Subsequent invocations would return `false`. The idea is to perform adjustments only once, not for each `QueryExecutorImpl#sendBind(SimpleQuery, SimpleParameterList, Portal, boolean)`. Returns:boolean true if current query needs field formats be adjusted as per connection configuration

pack-priv boolean needUpdateFieldFormats()

Returns true if current query needs field formats be adjusted as per connection configuration. Subsequent invocations would return false. The idea is to perform adjustments only once, not for each QueryExecutorImpl#sendBind(SimpleQuery, SimpleParameterList, Portal, boolean).

Returns:boolean: true if current query needs field formats be adjusted as per connection configuration

resetNeedUpdateFieldFormats	back to summary
public void resetNeedUpdateFieldFormats()

setCleanupRef	back to summary
pack-priv void setCleanupRef(PhantomReference<?> cleanupRef)

setFields	back to summary
pack-priv void setFields(@Nullable Field[] fields) Sets the fields that this query will return. Parameters fields:@Nullable Field[] The fields that this query will return.

setFields

back to summary

pack-priv void setFields(@Nullable Field[] fields)

Sets the fields that this query will return.

Parameters

fields:@Nullable Field[]: The fields that this query will return.

setHasBinaryFields	back to summary
public void setHasBinaryFields(boolean hasBinaryFields)

setPortalDescribed	back to summary
pack-priv void setPortalDescribed(boolean portalDescribed)

setPrepareTypes	back to summary
pack-priv void setPrepareTypes(int[] paramTypes)

setStatementDescribed	back to summary
pack-priv void setStatementDescribed(boolean statementDescribed)

setStatementName	back to summary
pack-priv void setStatementName(String statementName, short deallocateEpoch)

toString	back to summary
public String toString(@Nullable ParameterList parameters) Annotations @Override

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

unprepare	back to summary
pack-priv void unprepare()

pack-priv Class SimpleQuery

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail