Abstraction of a generic Query, hiding the details of any protocol-version-specific data needed to execute the query efficiently.
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 |
|---|---|
| public void | |
| public ParameterList | Returns: a suitable ParameterList instance for this queryCreate a ParameterList suitable for storing parameters associated with this Query. |
| public int | Returns: number of timesaddBatch() has been called.Get the number of times this Query has been batched. |
| public String | |
| public @Nullable Map | Returns: null if the query implementation does not support this method.Get a map that a result set can use to find the index associated to a name. |
| public @Nullable SqlCommand | Returns: returns properties of the query (sql keyword, and some other parsing info) or null if not applicableReturns properties of the query (sql keyword, and some other parsing info). |
| public @Nullable Query[] | Returns: an array of single-statement queries, ornull if this object is already a
single-statement query.Return a list of the Query objects that make up this query. |
| public boolean | |
| public boolean | |
| public String | Returns: a human-readable representation of this querya ParameterList returned by this Query's parameters)createParameterList method,
or null to leave the parameter placeholders unsubstituted.Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders. |
| close | back to summary |
|---|---|
| public void 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. | |
| createParameterList | back to summary |
|---|---|
| public ParameterList 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.
| |
| getBatchSize | back to summary |
|---|---|
| public int getBatchSize() Get the number of times this Query has been batched.
| |
| getNativeSql | back to summary |
|---|---|
| public String getNativeSql() Returns SQL in native for database format.
| |
| getResultSetColumnNameIndexMap | back to summary |
|---|---|
| public @Nullable Map Get a map that a result set can use to find the index associated to a name. | |
| getSqlCommand | back to summary |
|---|---|
| public @Nullable SqlCommand getSqlCommand() Returns properties of the query (sql keyword, and some other parsing info).
| |
| getSubqueries | back to summary |
|---|---|
| public @Nullable 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). | |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty() | |
| isStatementDescribed | back to summary |
|---|---|
| public boolean isStatementDescribed() | |
| toString | back to summary |
|---|---|
| public String toString(@Nullable ParameterList parameters) Stringize this query to a human-readable form, substituting particular parameter values for parameter placeholders.
| |