public interface QueryTranslator
Defines the contract of an HQL→SQL translator.
Modifier and Type | Field and Description |
---|---|
static String |
ERROR_CANNOT_DETERMINE_TYPE |
static String |
ERROR_CANNOT_FETCH_WITH_ITERATE |
static String |
ERROR_CANNOT_FORMAT_LITERAL |
static String |
ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED |
static String |
ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR |
static String |
ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR |
Modifier and Type | Method and Description |
---|---|
List<String> |
collectSqlStrings() |
void |
compile(Map replacements,
boolean shallow)
Compile a "normal" query.
|
boolean |
containsCollectionFetches()
Does the translated query contain collection fetches?
|
int |
executeUpdate(QueryParameters queryParameters,
SharedSessionContractImplementor session)
Perform a bulk update/delete operation given the underlying query definition.
|
String[][] |
getColumnNames()
Returns the column names in the generated SQL.
|
Class |
getDynamicInstantiationResultType() |
Map |
getEnabledFilters()
Returns the filters enabled for this query translator.
|
ParameterTranslations |
getParameterTranslations()
Return information about any parameters encountered during
translation.
|
String |
getQueryIdentifier()
Retrieve the query identifier for this translator.
|
Set<Serializable> |
getQuerySpaces()
Returns the set of query spaces (table names) that the query refers to.
|
String |
getQueryString()
Returns the HQL string processed by the translator.
|
String[] |
getReturnAliases()
Returns an array of HQL aliases
|
Type[] |
getReturnTypes()
Returns an array of Types represented in the query result.
|
String |
getSQLString()
Returns the SQL string generated by the translator.
|
boolean |
isManipulationStatement() |
default boolean |
isUpdateStatement() |
Iterator |
iterate(QueryParameters queryParameters,
EventSource session)
Perform an iterate operation given the underlying query definition.
|
List |
list(SharedSessionContractImplementor session,
QueryParameters queryParameters)
Perform a list operation given the underlying query definition.
|
ScrollableResultsImplementor |
scroll(QueryParameters queryParameters,
SharedSessionContractImplementor session)
Perform a scroll operation given the underlying query definition.
|
void |
validateScrollability()
Validate the scrollability of the translated query.
|
static final String ERROR_CANNOT_FETCH_WITH_ITERATE
static final String ERROR_NAMED_PARAMETER_DOES_NOT_APPEAR
static final String ERROR_ORDINAL_PARAMETER_DOES_NOT_APPEAR
static final String ERROR_LEGACY_ORDINAL_PARAMS_NO_LONGER_SUPPORTED
static final String ERROR_CANNOT_DETERMINE_TYPE
static final String ERROR_CANNOT_FORMAT_LITERAL
void compile(Map replacements, boolean shallow) throws QueryException, MappingException
Compile a "normal" query. This method may be called multiple times. Subsequent invocations are no-ops.
replacements
- Defined query substitutions.shallow
- Does this represent a shallow (scalar or entity-id) select?QueryException
- There was a problem parsing the query string.MappingException
- There was a problem querying defined mappings.List list(SharedSessionContractImplementor session, QueryParameters queryParameters) throws HibernateException
Perform a list operation given the underlying query definition.
session
- The session owning this query.queryParameters
- The query bind parameters.HibernateException
Iterator iterate(QueryParameters queryParameters, EventSource session) throws HibernateException
Perform an iterate operation given the underlying query definition.
queryParameters
- The query bind parameters.session
- The session owning this query.HibernateException
ScrollableResultsImplementor scroll(QueryParameters queryParameters, SharedSessionContractImplementor session) throws HibernateException
Perform a scroll operation given the underlying query definition.
queryParameters
- The query bind parameters.session
- The session owning this query.HibernateException
int executeUpdate(QueryParameters queryParameters, SharedSessionContractImplementor session) throws HibernateException
Perform a bulk update/delete operation given the underlying query definition.
queryParameters
- The query bind parameters.session
- The session owning this query.HibernateException
Set<Serializable> getQuerySpaces()
Returns the set of query spaces (table names) that the query refers to.
String getQueryIdentifier()
Retrieve the query identifier for this translator. The query identifier is used in states collection.
String getSQLString()
Returns the SQL string generated by the translator.
String getQueryString()
Returns the HQL string processed by the translator.
Map getEnabledFilters()
Returns the filters enabled for this query translator.
Type[] getReturnTypes()
Returns an array of Types represented in the query result.
String[] getReturnAliases()
Returns an array of HQL aliases
String[][] getColumnNames()
Returns the column names in the generated SQL.
ParameterTranslations getParameterTranslations()
Return information about any parameters encountered during translation.
void validateScrollability() throws HibernateException
Validate the scrollability of the translated query.
HibernateException
boolean containsCollectionFetches()
Does the translated query contain collection fetches?
boolean isManipulationStatement()
default boolean isUpdateStatement()
Class getDynamicInstantiationResultType()
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.