Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.dialect.pagination.LimitHandler

Method Summary

Modifier and Type	Method and Description
public int	Returns: The number of parameter values bound. bindLimitParametersAtEndOfQuery(RowSelection the selection criteria for rows. selection, PreparedStatement Statement to which to bind limit parameter values. statement, int Index from which to start binding. index) Bind parameter values needed by the LIMIT clause after original SELECT statement.
public int	Returns: The number of parameter values bound. bindLimitParametersAtStartOfQuery(RowSelection the selection criteria for rows. selection, PreparedStatement Statement to which to bind limit parameter values. statement, int Index from which to start binding. index) Bind parameter values needed by the LIMIT clause before original SELECT statement.
public String	Returns: Query statement with LIMIT clause applied. processSql(String the SQL query to process. sql, RowSelection the selection criteria for rows. selection) Return processed SQL query.
public default String	Returns: Query statement with LIMIT clause applied. processSql(String the SQL query to process. sql, QueryParameters the queryParameters. queryParameters) Return processed SQL query.
public void	setMaxRows(RowSelection the selection criteria for rows. selection, PreparedStatement Statement which number of returned rows shall be limited. statement) Use JDBC API to limit the number of rows returned by the SQL query.
public boolean	Returns: True if this handler supports some form of LIMIT. supportsLimit() Does this handler support some form of limiting query results via a SQL clause?
public boolean	Returns: True if the handler supports an offset within the limit support. supportsLimitOffset() Does this handler's LIMIT support (if any) additionally support specifying an offset?

Method Detail

bindLimitParametersAtEndOfQuery	back to summary
public int bindLimitParametersAtEndOfQuery(RowSelection selection, PreparedStatement statement, int index) throws SQLException Bind parameter values needed by the LIMIT clause after original SELECT statement. Parameters selection:RowSelection the selection criteria for rows. statement:PreparedStatement Statement to which to bind limit parameter values. index:int Index from which to start binding. Returns:int The number of parameter values bound. Exceptions SQLException: Indicates problems binding parameter values.

bindLimitParametersAtEndOfQuery

back to summary

public int bindLimitParametersAtEndOfQuery(RowSelection selection, PreparedStatement statement, int index) throws SQLException

Bind parameter values needed by the LIMIT clause after original SELECT statement.

Parameters

selection:RowSelection: the selection criteria for rows.
statement:PreparedStatement: Statement to which to bind limit parameter values.
index:int: Index from which to start binding.

Returns:int

The number of parameter values bound.

Exceptions

SQLException:: Indicates problems binding parameter values.

bindLimitParametersAtStartOfQuery	back to summary
public int bindLimitParametersAtStartOfQuery(RowSelection selection, PreparedStatement statement, int index) throws SQLException Bind parameter values needed by the LIMIT clause before original SELECT statement. Parameters selection:RowSelection the selection criteria for rows. statement:PreparedStatement Statement to which to bind limit parameter values. index:int Index from which to start binding. Returns:int The number of parameter values bound. Exceptions SQLException: Indicates problems binding parameter values.

bindLimitParametersAtStartOfQuery

back to summary

public int bindLimitParametersAtStartOfQuery(RowSelection selection, PreparedStatement statement, int index) throws SQLException

Bind parameter values needed by the LIMIT clause before original SELECT statement.

Parameters

selection:RowSelection: the selection criteria for rows.
statement:PreparedStatement: Statement to which to bind limit parameter values.
index:int: Index from which to start binding.

Returns:int

The number of parameter values bound.

Exceptions

SQLException:: Indicates problems binding parameter values.

processSql	back to summary
public String processSql(String sql, RowSelection selection) Return processed SQL query. Parameters sql:String the SQL query to process. selection:RowSelection the selection criteria for rows. Returns:String Query statement with LIMIT clause applied.

processSql

back to summary

public String processSql(String sql, RowSelection selection)

Return processed SQL query.

Parameters

sql:String: the SQL query to process.
selection:RowSelection: the selection criteria for rows.

Returns:String

Query statement with LIMIT clause applied.

processSql	back to summary
public default String processSql(String sql, QueryParameters queryParameters) Return processed SQL query. Parameters sql:String the SQL query to process. queryParameters:QueryParameters the queryParameters. Returns:String Query statement with LIMIT clause applied.

processSql

back to summary

public default String processSql(String sql, QueryParameters queryParameters)

Return processed SQL query.

Parameters

sql:String: the SQL query to process.
queryParameters:QueryParameters: the queryParameters.

Returns:String

Query statement with LIMIT clause applied.

setMaxRows	back to summary
public void setMaxRows(RowSelection selection, PreparedStatement statement) throws SQLException Use JDBC API to limit the number of rows returned by the SQL query. Typically handlers that do not support LIMIT clause should implement this method. Parameters selection:RowSelection the selection criteria for rows. statement:PreparedStatement Statement which number of returned rows shall be limited. Exceptions SQLException: Indicates problems while limiting maximum rows returned.

setMaxRows

back to summary

public void setMaxRows(RowSelection selection, PreparedStatement statement) throws SQLException

Use JDBC API to limit the number of rows returned by the SQL query. Typically handlers that do not support LIMIT clause should implement this method.

Parameters

selection:RowSelection: the selection criteria for rows.
statement:PreparedStatement: Statement which number of returned rows shall be limited.

Exceptions

SQLException:: Indicates problems while limiting maximum rows returned.

supportsLimit	back to summary
public boolean supportsLimit() Does this handler support some form of limiting query results via a SQL clause? Returns:boolean True if this handler supports some form of LIMIT.

supportsLimit

back to summary

public boolean supportsLimit()

Does this handler support some form of limiting query results via a SQL clause?

Returns:boolean: True if this handler supports some form of LIMIT.

supportsLimitOffset	back to summary
public boolean supportsLimitOffset() Does this handler's LIMIT support (if any) additionally support specifying an offset? Returns:boolean True if the handler supports an offset within the limit support.

supportsLimitOffset

back to summary

public boolean supportsLimitOffset()

Does this handler's LIMIT support (if any) additionally support specifying an offset?

Returns:boolean: True if the handler supports an offset within the limit support.

public Interface LimitHandler

Method Summary

Method Detail