sirius.db.jdbc

Class BaseSQLQuery

java.lang.Object

sirius.db.jdbc.BaseSQLQuery

Direct Known Subclasses:

BatchSQLQuery, SQLQuery

public abstract class BaseSQLQuery
extends Object

Abstract class to provide common functionality when executing a query and iterating over its result set.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Databases	dbs
protected List<String>	fieldNames

Constructor Summary

Constructors

Constructor and Description
BaseSQLQuery()

Method Summary

Modifier and Type	Method and Description
Optional<Row>	first() Executes the given query returning the first matching row wrapped as Optional.
abstract void	iterate(Function<Row,Boolean> handler, sirius.kernel.commons.Limit limit) Executes the given query by invoking the given handler for each result row.
void	iterateAll(Consumer<Row> consumer, sirius.kernel.commons.Limit limit) Executes the given query by invoking the Consumer for each result row.
protected Row	loadIntoRow(ResultSet rs)
protected void	processResultSet(Function<Row,Boolean> handler, sirius.kernel.commons.Limit effectiveLimit, ResultSet resultSet, sirius.kernel.async.TaskContext taskContext)
Row	queryFirst() Executes the given query returning the first matching row.
List<Row>	queryList() Executes the given query returning the result as list
List<Row>	queryList(sirius.kernel.commons.Limit limit) Executes the given query returning the result as list with at most maxRows entries
protected abstract void	writeBlobToParameter(String name, Blob blob)

Methods inherited from class java.lang.Object

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

Field Detail

dbs

protected static Databases dbs

fieldNames

protected List<String> fieldNames

Constructor Detail

BaseSQLQuery

public BaseSQLQuery()

Method Detail

queryList

@Nonnull
public List<Row> queryList()
                             throws SQLException

Executes the given query returning the result as list

Returns:

a list of Rows

Throws:

SQLException - in case of a database error

queryList

@Nonnull
public List<Row> queryList(sirius.kernel.commons.Limit limit)
                             throws SQLException

Executes the given query returning the result as list with at most maxRows entries

Parameters:

limit - the limit which controls which and how many rows are output

Returns:

a list of Rows

Throws:

SQLException - in case of a database error

iterate

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

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

Consider using the method instead of 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.

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

iterateAll

public void iterateAll(Consumer<Row> consumer,
                       @Nullable
                       sirius.kernel.commons.Limit limit)
                throws SQLException

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

Parameters:

consumer - 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

processResultSet

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

Throws:

SQLException

first

@Nonnull
public Optional<Row> first()
                             throws SQLException

Executes the given query returning the first matching row wrapped as Optional.

This method behaves like queryFirst() but returns an optional value instead of null.

Returns:

the resulting row wrapped as optional, or an empty optional if no matching row was found.

Throws:

SQLException - in case of a database error

queryFirst

@Nullable
public Row queryFirst()
                         throws SQLException

Executes the given query returning the first matching row.

If the resulting row contains a Blob an OutputStream as to be passed in as parameter with the name name as the column. The contents of the blob will then be written into the given output stream (without closing it).

Returns:

the first matching row for the given query or null if no matching row was found

Throws:

SQLException - in case of a database error

loadIntoRow

protected Row loadIntoRow(ResultSet rs)
                   throws SQLException

Throws:

SQLException

writeBlobToParameter

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

Throws:

SQLException