Package org.apache.juneau.beanquery.sql

Class SqlBeanQueryContext.Builder<T>

java.lang.Object

org.apache.juneau.commons.beanquery.BeanQueryContext.Builder<T,SqlBeanQueryContext.Builder<T>>

org.apache.juneau.beanquery.sql.SqlBeanQueryContext.Builder<T>

Type Parameters:

T - The row type.

Enclosing class:

SqlBeanQueryContext<T>

public static final class SqlBeanQueryContext.Builder<T>
extends BeanQueryContext.Builder<T,SqlBeanQueryContext.Builder<T>>

Builder for SqlBeanQueryContext. See the class Javadoc for an example.

Method Summary

Modifier and Type	Method	Description
SqlBeanQueryContext<T>	build()	Builds the immutable context.
SqlBeanQueryContext.Builder<T>	columnSql(String column, String sqlName)	Maps a declared column to a different raw SQL column name (otherwise the column name is used).
SqlBeanQueryContext.Builder<T>	connectionReleaser(Consumer<Connection> value)	Sets how a session gives back a connection it got from the supplier.
SqlBeanQueryContext.Builder<T>	connectionSupplier(Supplier<Connection> value)	Sets where sessions get a connection when none is passed to SqlBeanQuerySession.Builder.connection(Connection).
SqlBeanQueryContext.Builder<T>	dataSource(DataSource value)	Shorthand for connectionSupplier(ds::getConnection), with a SQLException wrapped as a BeanQueryExecutionException.
SqlBeanQueryContext.Builder<T>	dialect(SqlDialect value)	Sets the SQL dialect.
SqlBeanQueryContext.Builder<T>	fetchSize(int value)	Sets the JDBC fetch size for every statement.
SqlBeanQueryContext.Builder<T>	guard(SqlFragment value)	Sets a server-only SQL predicate AND-ed into every statement.
SqlBeanQueryContext.Builder<T>	queryTimeout(Duration value)	Sets the JDBC query timeout for every statement, rounded up to whole seconds.
SqlBeanQueryContext.Builder<T>	rowMapper(SqlRowMapper<T> value)	Sets how find and stream turn a row into a bean, overriding the default build() would pick from the row type.
SqlBeanQueryContext.Builder<T>	table(String value)	Sets the table (or view) to query.

Methods inherited from class org.apache.juneau.commons.beanquery.BeanQueryContext.Builder

allowRegex, column, columnOperators, columns, countPolicy, declared, defaultLimit, exclude, maxExpressionDepth, maxLimit, maxSearchClauses, maxSearchLength, maxSortKeys, operators, regexTimeout, self

Methods inherited from class java.lang.Object

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

Method Details

dialect

public SqlBeanQueryContext.Builder<T> dialect(SqlDialect value)

Sets the SQL dialect. Required.

Parameters:

value - The dialect. Must not be null.

Returns:

This object.

table

public SqlBeanQueryContext.Builder<T> table(String value)

Sets the table (or view) to query. Required.

Parameters:

value - The raw table name; the dialect quotes it. Must not be blank.

Returns:

This object.

rowMapper

public SqlBeanQueryContext.Builder<T> rowMapper(SqlRowMapper<T> value)

Sets how find and stream turn a row into a bean, overriding the default build() would pick from the row type. Not needed for findValues, streamValues or count.

Parameters:

value - The row mapper. Must not be null.

Returns:

This object.

columnSql

public SqlBeanQueryContext.Builder<T> columnSql(String column,
 String sqlName)

Maps a declared column to a different raw SQL column name (otherwise the column name is used).

Parameters:

column - The column name. Must be declared.

sqlName - The raw SQL column name; the dialect quotes it. Must not be blank.

Returns:

This object.

guard

public SqlBeanQueryContext.Builder<T> guard(SqlFragment value)

Sets a server-only SQL predicate AND-ed into every statement. A request can neither see nor remove it.

Parameters:

value - The guard, or null for none.

Returns:

This object.

connectionSupplier

public SqlBeanQueryContext.Builder<T> connectionSupplier(Supplier<Connection> value)

Sets where sessions get a connection when none is passed to SqlBeanQuerySession.Builder.connection(Connection). This or dataSource(DataSource) is required.

Parameters:

value - The supplier. Must not be null. Exceptions it throws become BeanQueryExecutionExceptions.

Returns:

This object.

connectionReleaser

public SqlBeanQueryContext.Builder<T> connectionReleaser(Consumer<Connection> value)

Sets how a session gives back a connection it got from the supplier. Default: Connection.close().

Parameters:

value - The releaser. Must not be null.

Returns:

This object.

dataSource

public SqlBeanQueryContext.Builder<T> dataSource(DataSource value)

Shorthand for connectionSupplier(ds::getConnection), with a SQLException wrapped as a BeanQueryExecutionException.

Parameters:

value - The data source. Must not be null.

Returns:

This object.

fetchSize

public SqlBeanQueryContext.Builder<T> fetchSize(int value)

Sets the JDBC fetch size for every statement. Default: 500.

Parameters:

value - The fetch size. Must be positive.

Returns:

This object.

queryTimeout

public SqlBeanQueryContext.Builder<T> queryTimeout(Duration value)

Sets the JDBC query timeout for every statement, rounded up to whole seconds. Default: none.

Leave unset and this still bounds any statement whose search includes $regex, at a shorter built-in default — set this explicitly to control that bound instead of accepting the default.

Parameters:

value - The timeout, or null for none. Must be positive if set.

Returns:

This object.

build

public SqlBeanQueryContext<T> build()

Builds the immutable context.

Specified by:

build in class BeanQueryContext.Builder<T,SqlBeanQueryContext.Builder<T>>

Returns:

A new context.

Throws:

IllegalStateException - If the dialect, the table, the connection source or every column is missing.