Class JdbcOperations.SelectBuilder

java.lang.Object

org.hibernate.sql.exec.spi.JdbcOperations.SelectBuilder

Enclosing class:

JdbcOperations

@SPI(USE)
public static final class JdbcOperations.SelectBuilder
extends Object

Builder for a JdbcSelect.

The default result mapping is derived from the request's select statement and SessionFactory. Override it only when the JDBC driver returns a result shape which differs from that statement's standard mapping.

Since:

8.0

Method Summary

Modifier and Type	Method	Description
JdbcOperations.SelectBuilder	affectedQuerySpaces(Set<String> affectedQuerySpaces)	Set the relational tables or backend-equivalent query spaces affected by the command.
JdbcOperations.SelectBuilder	appliedParameterBindings(Map<JdbcParameter, JdbcParameterBinding> appliedParameterBindings)	Record parameter values which were incorporated into the generated command and therefore participate in operation-cache compatibility.
JdbcSelect	build()	Build the immutable operation description consumed by Hibernate's JDBC executor.
JdbcOperations.SelectBuilder	command(String command)	Set the command text understood by the configured JDBC driver.
JdbcOperations.SelectBuilder	jdbcValuesMappingProducer(JdbcValuesMappingProducer jdbcValuesMappingProducer)	Supply a custom JDBC result mapping instead of deriving the standard one.
JdbcOperations.SelectBuilder	limitParameter(JdbcParameter limitParameter)	Identify the parameter rendered for the query limit, if any.
JdbcOperations.SelectBuilder	lockingApplication(JdbcLockingApplication lockingApplication)	Describe which stage owns pessimistic-lock application.
JdbcOperations.SelectBuilder	maxRows(int maxRows)	Set the maximum number of rows the executor should consume.
JdbcOperations.SelectBuilder	offsetParameter(JdbcParameter offsetParameter)	Identify the parameter rendered for the query offset, if any.
JdbcOperations.SelectBuilder	paginationApplication(JdbcPaginationApplication paginationApplication)	Describe which stage owns pagination application.
JdbcOperations.SelectBuilder	parameterBinders(List<? extends JdbcParameterBinder> parameterBinders)	Set binders in command-placeholder order.
JdbcOperations.SelectBuilder	rowsToSkip(int rowsToSkip)	Set the number of result rows the executor should skip.
JdbcOperations.SelectBuilder	scrollExecution(boolean scrollExecution)	Indicate that the selection is being translated for scroll execution.

Methods inherited from class Object

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

Method Details

command

public JdbcOperations.SelectBuilder command(String command)

Set the command text understood by the configured JDBC driver.

parameterBinders

public JdbcOperations.SelectBuilder parameterBinders(List<? extends JdbcParameterBinder> parameterBinders)

Set binders in command-placeholder order.

affectedQuerySpaces

public JdbcOperations.SelectBuilder affectedQuerySpaces(Set<String> affectedQuerySpaces)

Set the relational tables or backend-equivalent query spaces affected by the command.

appliedParameterBindings

public JdbcOperations.SelectBuilder appliedParameterBindings(Map<JdbcParameter, JdbcParameterBinding> appliedParameterBindings)

Record parameter values which were incorporated into the generated command and therefore participate in operation-cache compatibility.

jdbcValuesMappingProducer

public JdbcOperations.SelectBuilder jdbcValuesMappingProducer(JdbcValuesMappingProducer jdbcValuesMappingProducer)

Supply a custom JDBC result mapping instead of deriving the standard one.

rowsToSkip

public JdbcOperations.SelectBuilder rowsToSkip(int rowsToSkip)

Set the number of result rows the executor should skip.

maxRows

public JdbcOperations.SelectBuilder maxRows(int maxRows)

Set the maximum number of rows the executor should consume.

lockingApplication

public JdbcOperations.SelectBuilder lockingApplication(JdbcLockingApplication lockingApplication)

Describe which stage owns pessimistic-lock application.

paginationApplication

public JdbcOperations.SelectBuilder paginationApplication(JdbcPaginationApplication paginationApplication)

Describe which stage owns pagination application.

offsetParameter

public JdbcOperations.SelectBuilder offsetParameter(JdbcParameter offsetParameter)

Identify the parameter rendered for the query offset, if any.

Create the standard query-options-backed parameter with JdbcParameterFactory.queryOffset(org.hibernate.type.spi.TypeConfiguration). Its parameter binder must occur in parameterBinders at the corresponding command-placeholder position, and this must be the same parameter instance whose placeholder was rendered.

limitParameter

public JdbcOperations.SelectBuilder limitParameter(JdbcParameter limitParameter)

Identify the parameter rendered for the query limit, if any.

Create the standard query-options-backed parameter with JdbcParameterFactory.queryLimit(org.hibernate.type.spi.TypeConfiguration). Its parameter binder must occur in parameterBinders at the corresponding command-placeholder position, and this must be the same parameter instance whose placeholder was rendered.

scrollExecution

public JdbcOperations.SelectBuilder scrollExecution(boolean scrollExecution)

Indicate that the selection is being translated for scroll execution.

build

public JdbcSelect build()

Build the immutable operation description consumed by Hibernate's JDBC executor.