com.querydsl.sql

Class AbstractSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>

java.lang.Object

com.querydsl.core.support.QueryBase<Q>

com.querydsl.core.support.FetchableQueryBase<T,Q>

com.querydsl.core.support.FetchableSubQueryBase<T,Q>

com.querydsl.sql.ProjectableSQLQuery<T,Q>

com.querydsl.sql.AbstractSQLQuery<T,Q>

Type Parameters:

T - result type

Q - concrete subtype

All Implemented Interfaces:

Fetchable<T>, FetchableQuery<T,Q>, FilteredClause<Q>, Query<Q>, SimpleQuery<Q>, ExtendedSubQuery<T>, Expression<T>, SubQueryExpression<T>, SQLCommonQuery<Q>, java.io.Serializable

Direct Known Subclasses:

AbstractMySQLQuery, AbstractOracleQuery, AbstractPostgreSQLQuery, AbstractSQLServerQuery, AbstractTeradataQuery, SQLQuery

public abstract class AbstractSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>
extends ProjectableSQLQuery<T,Q>

AbstractSQLQuery is the base type for SQL query implementations

Author:

tiwe

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SQLListeners	listeners
protected static java.lang.String	PARENT_CONTEXT
protected boolean	useLiterals

Fields inherited from class com.querydsl.sql.ProjectableSQLQuery

configuration, firstUnionSubQuery, union, unionAll

Fields inherited from class com.querydsl.core.support.QueryBase

MDC_PARAMETERS, MDC_QUERY, queryMixin

Constructor Summary

Constructors

Constructor and Description
AbstractSQLQuery(@Nullable java.sql.Connection conn, Configuration configuration)
AbstractSQLQuery(@Nullable java.sql.Connection conn, Configuration configuration, QueryMetadata metadata)
AbstractSQLQuery(java.util.function.Supplier<java.sql.Connection> connProvider, Configuration configuration)
AbstractSQLQuery(java.util.function.Supplier<java.sql.Connection> connProvider, Configuration configuration, QueryMetadata metadata)

Method Summary

Modifier and Type	Method and Description
void	addListener(SQLListener listener) Add a listener
SimpleExpression<T>	as(Path<?> alias) Create an alias for the expression
SimpleExpression<T>	as(java.lang.String alias) Create an alias for the expression
Q	clone()
abstract Q	clone(java.sql.Connection connection)
protected void	clone(Q query)
protected SQLSerializer	createSerializer()
protected void	endContext(SQLListenerContext context) Called to end a SQL listener context
java.util.List<T>	fetch() Get the projection as a typed List
long	fetchCount() Get the count of matched elements Note: not all QueryDSL modules might optimize fetchCount using a count query.
QueryResults<T>	fetchResults() Get the projection in QueryResults form.
Q	forShare() FOR SHARE causes the rows retrieved by the SELECT statement to be locked as though for update.
Q	forShare(boolean fallbackToForUpdate) FOR SHARE causes the rows retrieved by the SELECT statement to be locked as though for update.
Q	forUpdate() If you use forUpdate() with a backend that uses page or row locks, rows examined by the query are write-locked until the end of the current transaction.
protected Configuration	getConfiguration()
java.sql.ResultSet	getResults() Get the results as a JDBC ResultSet
java.sql.ResultSet	getResults(Expression<?>... exprs) Deprecated. Use @{code select(..)} to define the projection and getResults() to obtain the result set
com.mysema.commons.lang.CloseableIterator<T>	iterate() Get the projection as a typed closeable Iterator
protected void	logQuery(java.lang.String queryString, java.util.Collection<java.lang.Object> parameters)
protected void	onException(SQLListenerContextImpl context, java.lang.Exception e) Called to make the call back to listeners when an exception happens
protected void	setParameters(java.sql.PreparedStatement stmt, java.util.List<?> objects, java.util.List<Path<?>> constantPaths, java.util.Map<ParamExpression<?>,?> params)
void	setStatementOptions(StatementOptions statementOptions) Set the options to be applied to the JDBC statements of this query
void	setUseLiterals(boolean useLiterals) Set whether literals are used in SQL strings instead of parameter bindings (default: false)
protected SQLListenerContextImpl	startContext(java.sql.Connection connection, QueryMetadata metadata) Called to create and start a new SQL Listener context

Methods inherited from class com.querydsl.sql.ProjectableSQLQuery

accept, addFlag, addFlag, addFlag, addFlag, addJoinFlag, addJoinFlag, fetchOne, from, from, from, fullJoin, fullJoin, fullJoin, fullJoin, fullJoin, getSQL, getSQL, innerJoin, innerJoin, innerJoin, innerJoin, innerJoin, join, join, join, join, join, leftJoin, leftJoin, leftJoin, leftJoin, leftJoin, on, on, rightJoin, rightJoin, rightJoin, rightJoin, rightJoin, serialize, toString, union, union, union, unionAll, unionAll, unionAll, with, with, with, withRecursive, withRecursive, withRecursive

Methods inherited from class com.querydsl.core.support.FetchableSubQueryBase

contains, contains, eq, eq, exists, getMetadata, getType, goe, goe, gt, gt, hashCode, in, in, isNotNull, isNull, loe, loe, lt, lt, ne, ne, notExists

Methods inherited from class com.querydsl.core.support.FetchableQueryBase

equals, fetchFirst, transform, uniqueResult

Methods inherited from class com.querydsl.core.support.QueryBase

distinct, groupBy, groupBy, having, having, limit, offset, orderBy, orderBy, restrict, set, where, where

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.querydsl.core.Query

groupBy, having

Methods inherited from interface com.querydsl.core.SimpleQuery

distinct, limit, offset, orderBy, restrict, set

Methods inherited from interface com.querydsl.core.FilteredClause

where

Methods inherited from interface com.querydsl.core.FetchableQuery

select, select, transform

Methods inherited from interface com.querydsl.core.Fetchable

fetchFirst, stream

Field Detail

PARENT_CONTEXT

protected static final java.lang.String PARENT_CONTEXT

listeners

protected SQLListeners listeners

useLiterals

protected boolean useLiterals

Constructor Detail

AbstractSQLQuery

public AbstractSQLQuery(@Nullable
                        @Nullable java.sql.Connection conn,
                        Configuration configuration)

AbstractSQLQuery

public AbstractSQLQuery(@Nullable
                        @Nullable java.sql.Connection conn,
                        Configuration configuration,
                        QueryMetadata metadata)

AbstractSQLQuery

public AbstractSQLQuery(java.util.function.Supplier<java.sql.Connection> connProvider,
                        Configuration configuration)

AbstractSQLQuery

public AbstractSQLQuery(java.util.function.Supplier<java.sql.Connection> connProvider,
                        Configuration configuration,
                        QueryMetadata metadata)

Method Detail

as

public SimpleExpression<T> as(java.lang.String alias)

Create an alias for the expression

Parameters:

alias - alias

Returns:

this as alias

as

public SimpleExpression<T> as(Path<?> alias)

Create an alias for the expression

Parameters:

alias - alias

Returns:

this as alias

addListener

public void addListener(SQLListener listener)

Add a listener

Parameters:

listener - listener to add

fetchCount

public long fetchCount()

Description copied from interface: Fetchable

Get the count of matched elements Note: not all QueryDSL modules might optimize fetchCount using a count query. An implementation is allowed to fall back to fetch().size().

Specified by:

fetchCount in interface Fetchable<T>

Overrides:

fetchCount in class ProjectableSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>

Returns:

row count

forUpdate

public Q forUpdate()

If you use forUpdate() with a backend that uses page or row locks, rows examined by the query are write-locked until the end of the current transaction. Not supported for SQLite and CUBRID

Returns:

the current object

forShare

public Q forShare()

FOR SHARE causes the rows retrieved by the SELECT statement to be locked as though for update. Supported by MySQL, PostgreSQL, SQLServer.

Returns:

the current object

Throws:

QueryException - if the FOR SHARE is not supported.

forShare

public Q forShare(boolean fallbackToForUpdate)

FOR SHARE causes the rows retrieved by the SELECT statement to be locked as though for update. Supported by MySQL, PostgreSQL, SQLServer.

Parameters:

fallbackToForUpdate - if the FOR SHARE is not supported and this parameter is true, the forUpdate() functionality will be used.

Returns:

the current object

Throws:

QueryException - if the FOR SHARE is not supported and fallbackToForUpdate is set to false.

createSerializer

protected SQLSerializer createSerializer()

Specified by:

createSerializer in class ProjectableSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>

startContext

protected SQLListenerContextImpl startContext(java.sql.Connection connection,
                                              QueryMetadata metadata)

Called to create and start a new SQL Listener context

Parameters:

connection - the database connection

metadata - the meta data for that context

Returns:

the newly started context

onException

protected void onException(SQLListenerContextImpl context,
                           java.lang.Exception e)

Called to make the call back to listeners when an exception happens

Parameters:

context - the current context in play

e - the exception

endContext

protected void endContext(SQLListenerContext context)

Called to end a SQL listener context

Parameters:

context - the listener context to end

getResults

@Deprecated
public java.sql.ResultSet getResults(Expression<?>... exprs)

Deprecated. Use @{code select(..)} to define the projection and getResults() to obtain the result set

Get the results as a JDBC ResultSet

Parameters:

exprs - the expression arguments to retrieve

Returns:

results as ResultSet

getResults

public java.sql.ResultSet getResults()

Get the results as a JDBC ResultSet

Returns:

results as ResultSet

getConfiguration

protected Configuration getConfiguration()

iterate

public com.mysema.commons.lang.CloseableIterator<T> iterate()

Description copied from interface: Fetchable

Get the projection as a typed closeable Iterator

Returns:

closeable iterator

fetch

public java.util.List<T> fetch()

Description copied from interface: Fetchable

Get the projection as a typed List

Specified by:

fetch in interface Fetchable<T>

Overrides:

fetch in class FetchableQueryBase<T,Q extends AbstractSQLQuery<T,Q>>

Returns:

results in list form

fetchResults

public QueryResults<T> fetchResults()

Description copied from interface: Fetchable

Get the projection in QueryResults form. Make sure to use Fetchable.fetch() instead if you do not rely on the QueryResults.getOffset() or QueryResults.getLimit(), because it will be more performant. Also, count queries cannot be properly generated for all dialects. For example: in JPA count queries can't be generated for queries that have multiple group by expressions or a having clause. Get the projection in QueryResults form. Use Fetchable.fetch() instead if you do not need the total count of rows in the query result.

Returns:

results

See Also:

Fetchable.fetch()

setParameters

protected void setParameters(java.sql.PreparedStatement stmt,
                             java.util.List<?> objects,
                             java.util.List<Path<?>> constantPaths,
                             java.util.Map<ParamExpression<?>,?> params)

logQuery

protected void logQuery(java.lang.String queryString,
                        java.util.Collection<java.lang.Object> parameters)

setUseLiterals

public void setUseLiterals(boolean useLiterals)

Set whether literals are used in SQL strings instead of parameter bindings (default: false)

Warning: When literals are used, prepared statement won't have any parameter bindings and also batch statements will only be simulated, but not executed as actual batch statements.

Parameters:

useLiterals - true for literals and false for bindings

clone

protected void clone(Q query)

Overrides:

clone in class ProjectableSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>

clone

public Q clone()

Specified by:

clone in class ProjectableSQLQuery<T,Q extends AbstractSQLQuery<T,Q>>

clone

public abstract Q clone(java.sql.Connection connection)

setStatementOptions

public void setStatementOptions(StatementOptions statementOptions)

Set the options to be applied to the JDBC statements of this query

Parameters:

statementOptions - options to be applied to statements