SimpleQuery

java.lang.Object
- org.postgresql.core.v3.SimpleQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

BatchedQuery
```
class SimpleQuery
extends java.lang.Object
implements Query
```
V3 Query implementation for a single-statement query. This also holds the state of any associated server-side named statement. We use a PhantomReference managed by the QueryExecutor to handle statement cleanup.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.Integer`	`cachedMaxResultRowSize`
`private java.lang.ref.PhantomReference<?>`	`cleanupRef`
`private short`	`deallocateEpoch`
`private byte[]`	`encodedStatementName`
`private Field[]`	`fields` The stored fields from previous execution or describe of a prepared statement.
`private boolean`	`hasBinaryFields`
`private static java.util.logging.Logger`	`LOGGER`
`private NativeQuery`	`nativeQuery`
`private boolean`	`needUpdateFieldFormats`
`(package private) static SimpleParameterList`	`NO_PARAMETERS`
`private boolean`	`portalDescribed`
`private int[]`	`preparedTypes`
`private java.util.Map<java.lang.String,java.lang.Integer>`	`resultSetColumnNameIndexMap`
`private boolean`	`sanitiserDisabled`
`private boolean`	`statementDescribed`
`private java.lang.String`	`statementName`
`private TypeTransferModeRegistry`	`transferModeRegistry`
`private java.util.BitSet`	`unspecifiedParams`

Constructor Summary

Constructors
Constructor and Description
`SimpleQuery(NativeQuery query, TypeTransferModeRegistry transferModeRegistry, boolean sanitiserDisabled)`
`SimpleQuery(SimpleQuery src)`

Method Summary

All Methods Instance Methods Concrete 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.
`int`	`getBatchSize()` Get the number of times this Query has been batched.
`int`	`getBindCount()`
`(package private) byte[]`	`getEncodedStatementName()`
`(package private) Field[]`	`getFields()` Returns the fields that this query will return.
`int`	`getMaxResultRowSize()` Return maximum size in bytes that each result row from this query may return.
`(package private) NativeQuery`	`getNativeQuery()`
`java.lang.String`	`getNativeSql()` Returns SQL in native for database format.
`(package private) int[]`	`getPrepareTypes()`
`java.util.Map<java.lang.String,java.lang.Integer>`	`getResultSetColumnNameIndexMap()` Get a map that a result set can use to find the index associated to a name.
`SqlCommand`	`getSqlCommand()` Returns properties of the query (sql keyword, and some other parsing info).
`(package private) java.lang.String`	`getStatementName()`
`SimpleQuery[]`	`getSubqueries()` Return a list of the Query objects that make up this query.
`boolean`	`hasBinaryFields()`
`(package private) boolean`	`hasUnresolvedTypes()`
`boolean`	`isEmpty()`
`(package private) boolean`	`isPortalDescribed()`
`(package private) boolean`	`isPreparedFor(int[] paramTypes, short deallocateEpoch)`
`boolean`	`isStatementDescribed()`
`(package private) boolean`	`needUpdateFieldFormats()` Returns true if current query needs field formats be adjusted as per connection configuration.
`void`	`resetNeedUpdateFieldFormats()`
`(package private) void`	`setCleanupRef(java.lang.ref.PhantomReference<?> cleanupRef)`
`(package private) void`	`setFields(Field[] fields)` Sets the fields that this query will return.
`void`	`setHasBinaryFields(boolean hasBinaryFields)`
`(package private) void`	`setPortalDescribed(boolean portalDescribed)`
`(package private) void`	`setPrepareTypes(int[] paramTypes)`
`(package private) void`	`setStatementDescribed(boolean statementDescribed)`
`(package private) void`	`setStatementName(java.lang.String statementName, short deallocateEpoch)`
`java.lang.String`	`toString()`
`java.lang.String`	`toString(ParameterList parameters)` Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.
`(package private) void`	`unprepare()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOGGER
```
private static final java.util.logging.Logger LOGGER
```
  - resultSetColumnNameIndexMap
```
private java.util.Map<java.lang.String,java.lang.Integer> resultSetColumnNameIndexMap
```
  - nativeQuery
```
private final NativeQuery nativeQuery
```
  - transferModeRegistry
```
private final TypeTransferModeRegistry transferModeRegistry
```
  - statementName
```
private java.lang.String statementName
```
  - encodedStatementName
```
private byte[] encodedStatementName
```
  - fields
```
private Field[] fields
```
    The stored fields from previous execution or describe of a prepared statement. Always null for non-prepared statements.
  - needUpdateFieldFormats
```
private boolean needUpdateFieldFormats
```
  - hasBinaryFields
```
private boolean hasBinaryFields
```
  - portalDescribed
```
private boolean portalDescribed
```
  - statementDescribed
```
private boolean statementDescribed
```
  - sanitiserDisabled
```
private final boolean sanitiserDisabled
```
  - cleanupRef
```
private java.lang.ref.PhantomReference<?> cleanupRef
```
  - preparedTypes
```
private int[] preparedTypes
```
  - unspecifiedParams
```
private java.util.BitSet unspecifiedParams
```
  - deallocateEpoch
```
private short deallocateEpoch
```
  - cachedMaxResultRowSize
```
private java.lang.Integer cachedMaxResultRowSize
```
  - NO_PARAMETERS
```
static final SimpleParameterList NO_PARAMETERS
```
- Constructor Detail
  - SimpleQuery
```
SimpleQuery(SimpleQuery src)
```
  - SimpleQuery
```
SimpleQuery(NativeQuery query,
            TypeTransferModeRegistry transferModeRegistry,
            boolean sanitiserDisabled)
```
- Method Detail
  - 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.
    
    Specified by:
    
    createParameterList in interface Query
    
    Returns:
    
    a suitable ParameterList instance for this query
  - toString
```
public java.lang.String toString(ParameterList parameters)
```
    Description copied from interface: Query
    
    Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.
    
    Specified by:
    
    toString in interface Query
    
    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
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - 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.
    
    Specified by:
    
    close in interface Query
  - getSubqueries
```
public SimpleQuery[] getSubqueries()
```
    Description copied from interface: Query
    
    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).
    
    Specified by:
    
    getSubqueries in interface Query
    
    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:
    
    java.lang.IllegalStateException - if the query is not described
  - getNativeSql
```
public java.lang.String getNativeSql()
```
    Description copied from interface: Query
    
    Returns SQL in native for database format.
    
    Specified by:
    
    getNativeSql in interface Query
    
    Returns:
    
    SQL in native for database format
  - setStatementName
```
void setStatementName(java.lang.String statementName,
                      short deallocateEpoch)
```
  - setPrepareTypes
```
void setPrepareTypes(int[] paramTypes)
```
  - getPrepareTypes
```
int[] getPrepareTypes()
```
  - getStatementName
```
java.lang.String getStatementName()
```
  - isPreparedFor
```
boolean isPreparedFor(int[] paramTypes,
                      short deallocateEpoch)
```
  - hasUnresolvedTypes
```
boolean hasUnresolvedTypes()
```
  - getEncodedStatementName
```
byte[] getEncodedStatementName()
```
  - setFields
```
void setFields(Field[] fields)
```
    Sets the fields that this query will return.
    
    Parameters:
    
    fields - The fields that this query will return.
  - getFields
```
Field[] getFields()
```
    Returns the fields that this query will return. If the result set fields are not known returns null.
    
    Returns:
    
    the fields that this query will return.
  - needUpdateFieldFormats
```
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:
    
    true if current query needs field formats be adjusted as per connection configuration
  - resetNeedUpdateFieldFormats
```
public void resetNeedUpdateFieldFormats()
```
  - hasBinaryFields
```
public boolean hasBinaryFields()
```
  - setHasBinaryFields
```
public void setHasBinaryFields(boolean hasBinaryFields)
```
  - isPortalDescribed
```
boolean isPortalDescribed()
```
  - setPortalDescribed
```
void setPortalDescribed(boolean portalDescribed)
```
  - isStatementDescribed
```
public boolean isStatementDescribed()
```
    Specified by:
    
    isStatementDescribed in interface Query
  - setStatementDescribed
```
void setStatementDescribed(boolean statementDescribed)
```
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Query
  - setCleanupRef
```
void setCleanupRef(java.lang.ref.PhantomReference<?> cleanupRef)
```
  - unprepare
```
void unprepare()
```
  - getBatchSize
```
public int getBatchSize()
```
    Description copied from interface: Query
    
    Get the number of times this Query has been batched.
    
    Specified by:
    
    getBatchSize in interface Query
    
    Returns:
    
    number of times addBatch() has been called.
  - getNativeQuery
```
NativeQuery getNativeQuery()
```
  - getBindCount
```
public final int getBindCount()
```
  - getResultSetColumnNameIndexMap
```
public java.util.Map<java.lang.String,java.lang.Integer> getResultSetColumnNameIndexMap()
```
    Description copied from interface: Query
    
    Get a map that a result set can use to find the index associated to a name.
    
    Specified by:
    
    getResultSetColumnNameIndexMap in interface Query
    
    Returns:
    
    null if the query implementation does not support this method.
  - getSqlCommand
```
public SqlCommand getSqlCommand()
```
    Description copied from interface: Query
    
    Returns properties of the query (sql keyword, and some other parsing info).
    
    Specified by:
    
    getSqlCommand in interface Query
    
    Returns:
    
    returns properties of the query (sql keyword, and some other parsing info) or null if not applicable

Class SimpleQuery

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOGGER

resultSetColumnNameIndexMap

nativeQuery

transferModeRegistry

statementName

encodedStatementName

fields

needUpdateFieldFormats

hasBinaryFields

portalDescribed

statementDescribed

sanitiserDisabled

cleanupRef

preparedTypes

unspecifiedParams

deallocateEpoch

cachedMaxResultRowSize

NO_PARAMETERS

Constructor Detail

SimpleQuery

SimpleQuery

Method Detail

createParameterList

toString

toString

close

getSubqueries

getMaxResultRowSize

getNativeSql

setStatementName

setPrepareTypes

getPrepareTypes

getStatementName

isPreparedFor

hasUnresolvedTypes

getEncodedStatementName

setFields

getFields

needUpdateFieldFormats

resetNeedUpdateFieldFormats

hasBinaryFields

setHasBinaryFields

isPortalDescribed

setPortalDescribed

isStatementDescribed

setStatementDescribed

isEmpty

setCleanupRef

unprepare

getBatchSize

getNativeQuery

getBindCount

getResultSetColumnNameIndexMap

getSqlCommand