public interface Query
Query objects should be explicitly closed when no longer needed; if resources are allocated on the server for this query, their cleanup is triggered by closing the Query.
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.
|
java.lang.String |
getNativeSql()
Returns SQL in native for database format.
|
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).
|
Query[] |
getSubqueries()
Return a list of the Query objects that make up this query.
|
boolean |
isEmpty() |
boolean |
isStatementDescribed() |
java.lang.String |
toString(ParameterList parameters)
Returns string representation of the query, substituting particular parameter values for
parameter placeholders.
|
java.lang.String |
toString(ParameterList parameters,
SqlSerializationContext context)
Returns string representation of the query, substituting particular parameter values for
parameter placeholders.
|
ParameterList createParameterList()
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.
java.lang.String toString(ParameterList parameters)
Note: the method replaces the values on a best-effort basis as it might omit the replacements
for parameters that can't be processed several times. For instance, InputStream
can be processed only once.
parameters
- a ParameterList returned by this Query's createParameterList()
method,
or null
to leave the parameter placeholders unsubstituted.java.lang.String toString(ParameterList parameters, SqlSerializationContext context)
parameters
- a ParameterList returned by this Query's createParameterList()
method,
or null
to leave the parameter placeholders unsubstituted.context
- specifies configuration for converting the parameters to stringjava.lang.String getNativeSql()
SqlCommand getSqlCommand()
void close()
A closed Query should not be executed.
boolean isStatementDescribed()
boolean isEmpty()
int getBatchSize()
addBatch()
has been called.java.util.Map<java.lang.String,java.lang.Integer> getResultSetColumnNameIndexMap()
Query[] getSubqueries()
null
if this object is already a
single-statement query.Copyright © 2025 PostgreSQL Global Development Group. All rights reserved.