sirius.db.jdbc

Class SQLQuery

java.lang.Object

sirius.db.jdbc.BaseSQLQuery

sirius.db.jdbc.SQLQuery

public class SQLQuery
extends BaseSQLQuery

Represents a flexible way of executing parameterized SQL queries without thinking too much about resource management.

Supports named parameters in form of ${name}. Also #{name} can be used in LIKE expressions and will be surrounded by % signs (if not empty).

Optional blocks can be surrounded with angular braces: SELECT * FROM x WHERE test = 1[ AND test2=${val}] The surrounded block will only be added to the query, if the parameter within has a non-null value.

Field Summary

Fields inherited from class sirius.db.jdbc.BaseSQLQuery

dbs, fieldNames

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SQLQuery(Database ds, String sql)

Method Summary

Modifier and Type	Method and Description
protected void	applyFetchSize(PreparedStatement stmt, sirius.kernel.commons.Limit effectiveLimit)
protected void	applyMaxRows(PreparedStatement stmt, sirius.kernel.commons.Limit effectiveLimit)
protected PreparedStatement	createPreparedStatement(Connection c)
int	executeUpdate() Executes the query as update.
Row	executeUpdateReturnKeys() Executes the update and returns the generated keys.
void	iterate(Function<Row,Boolean> handler, sirius.kernel.commons.Limit limit) Executes the given query by invoking the given handler for each result row.
protected void	processResultSet(Function<Row,Boolean> handler, sirius.kernel.commons.Limit effectiveLimit, ResultSet resultSet, sirius.kernel.async.TaskContext taskContext)
SQLQuery	set(Map<String,Object> ctx) Sets all parameters of the given context.
SQLQuery	set(String parameter, Object value) Adds a parameter.
String	toString()
protected void	writeBlobToParameter(String name, Blob blob)

Methods inherited from class sirius.db.jdbc.BaseSQLQuery

first, iterateAll, loadIntoRow, queryFirst, queryList, queryList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SQLQuery

protected SQLQuery(Database ds,
                   String sql)

Method Detail

set

public SQLQuery set(String parameter,
                    Object value)

Adds a parameter.

Parameters:

parameter - the name of the parameter as referenced in the SQL statement (${name} or #{name}).

value - the value of the parameter

Returns:

the query itself to support fluent calls

set

public SQLQuery set(Map<String,Object> ctx)

Sets all parameters of the given context.

Parameters:

ctx - the containing pairs of names and values to add to the query

Returns:

the query itself to support fluent calls

iterate

public void iterate(Function<Row,Boolean> handler,
                    @Nullable
                    sirius.kernel.commons.Limit limit)
             throws SQLException

Description copied from class: BaseSQLQuery

Executes the given query by invoking the given handler for each result row.

Consider using the method instead of BaseSQLQuery.queryList() if a large result set is expected as this method. As this method only processes one row at a time, this might be much more memory efficient.

Specified by:

iterate in class BaseSQLQuery

Parameters:

handler - the row handler invoked for each row

limit - the limit which controls which and how many rows are output. Can be null to indicate that there is no limit.

Throws:

SQLException - in case of a database error

applyMaxRows

protected void applyMaxRows(PreparedStatement stmt,
                            sirius.kernel.commons.Limit effectiveLimit)
                     throws SQLException

Throws:

SQLException

applyFetchSize

protected void applyFetchSize(PreparedStatement stmt,
                              sirius.kernel.commons.Limit effectiveLimit)
                       throws SQLException

Throws:

SQLException

processResultSet

protected void processResultSet(Function<Row,Boolean> handler,
                                sirius.kernel.commons.Limit effectiveLimit,
                                ResultSet resultSet,
                                sirius.kernel.async.TaskContext taskContext)
                         throws SQLException

Overrides:

processResultSet in class BaseSQLQuery

Throws:

SQLException

createPreparedStatement

protected PreparedStatement createPreparedStatement(Connection c)
                                             throws SQLException

Throws:

SQLException

writeBlobToParameter

protected void writeBlobToParameter(String name,
                                    Blob blob)
                             throws SQLException

Specified by:

writeBlobToParameter in class BaseSQLQuery

Throws:

SQLException

executeUpdate

public int executeUpdate()
                  throws SQLException

Executes the query as update.

Requires the SQL statement to be an UPDATE or DELETE statement.

Returns:

the number of rows changed

Throws:

SQLException - in case of a database error

executeUpdateReturnKeys

public Row executeUpdateReturnKeys()
                            throws SQLException

Executes the update and returns the generated keys.

Requires the SQL statement to be an UPDATE or DELETE statement.

Returns:

the a row representing all generated keys

Throws:

SQLException - in case of a database error

toString

public String toString()

Overrides:

toString in class Object