com.github.fabienbarbero.sql

Class SQLRunner

java.lang.Object

com.github.fabienbarbero.sql.SQLRunner

Direct Known Subclasses:

AbstractDAO

public class SQLRunner
extends Object

Author:

Fabien Barbero

Constructor Summary

Constructors

Constructor and Description
SQLRunner(Connection conn)
SQLRunner(HasSQLConnection tx)

Method Summary

Modifier and Type	Method and Description
long	count(SQLQueryBuilder query) Execute a "count" query
int	execute(SQLQueryBuilder query) Execute a query for UPDATE, INSERT or DELETE
<T> List<T>	query(SQLRecordMapper<T> mapper, SQLQueryBuilder query) Select entities from a given SQL query
<T> Stream<T>	queryAsStream(SQLRecordMapper<T> mapper, Integer fetchSize, SQLQueryBuilder query) Select entities from a given SQL query.
<T> SQLIterator<T>	queryIterator(SQLRecordMapper<T> mapper, Integer fetchSize, boolean updatable, SQLQueryBuilder query) Select entities from a given SQL query.
<T> T	querySingle(SQLRecordMapper<T> mapper, SQLQueryBuilder query) Select a single entity from a given SQL query

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLRunner

public SQLRunner(Connection conn)

SQLRunner

public SQLRunner(HasSQLConnection tx)

Method Detail

query

public <T> List<T> query(SQLRecordMapper<T> mapper,
                         SQLQueryBuilder query)
                  throws SQLFaultException

Select entities from a given SQL query

Type Parameters:

T - The entity type to return

Parameters:

mapper - The mapper used to build Java entities

query - The query to select entities

Returns:

The entities found

Throws:

SQLFaultException - Query error

querySingle

public <T> T querySingle(SQLRecordMapper<T> mapper,
                         SQLQueryBuilder query)
                  throws SQLFaultException

Select a single entity from a given SQL query

Type Parameters:

T - The entity type to return

Parameters:

mapper - The mapper used to build Java entity

query - The query to select the entity

Returns:

The optional entity found

Throws:

SQLFaultException - Query error

queryIterator

public <T> SQLIterator<T> queryIterator(SQLRecordMapper<T> mapper,
                                        Integer fetchSize,
                                        boolean updatable,
                                        SQLQueryBuilder query)

Select entities from a given SQL query. The results are returned via an iterator to limit memory usage. It is useful when getting large entities count.

Type Parameters:

T - The entities type

Parameters:

mapper - The mapper used to build Java entities

fetchSize - The fetch size. Limits the memory usage. The value depends on the SQL driver. If null, the whole entities will be stored in the memory.

updatable - true to indicate if the iterator can change entities during iteration (this consumes more memory)

query - The query to select the entities

Returns:

The iterator handling the entities. Do not forget to close the iterator after the process.

queryAsStream

public <T> Stream<T> queryAsStream(SQLRecordMapper<T> mapper,
                                   Integer fetchSize,
                                   SQLQueryBuilder query)

Select entities from a given SQL query. The results are returned via an iterator to limit memory usage. It is useful when getting large entities count.

Type Parameters:

T - The entities type

Parameters:

mapper - The mapper used to build Java entities

fetchSize - The fetch size. Limits the memory usage. The value depends on the SQL driver. If null, the whole entities will be stored in the memory.

query - The query to select the entities

Returns:

The iterator handling the entities. Do not forget to close the iterator after the process.

count

public long count(SQLQueryBuilder query)
           throws SQLFaultException

Execute a "count" query

Parameters:

query - The query to count entities. It must starts with "select count(...)".

Returns:

The counted entities

Throws:

SQLFaultException - Query error

execute

public int execute(SQLQueryBuilder query)
            throws SQLFaultException

Execute a query for UPDATE, INSERT or DELETE

Parameters:

query - The query to execute

Returns:

The modified record count

Throws:

SQLFaultException - Query error