Enum Class JdbcPaginationApplication

java.lang.Object

java.lang.Enum<JdbcPaginationApplication>

org.hibernate.sql.exec.spi.JdbcPaginationApplication

All Implemented Interfaces:

Serializable, Comparable<JdbcPaginationApplication>, Constable

@SPI
@Incubating(since="6.0",
            group="sql-execution")
public enum JdbcPaginationApplication
extends Enum<JdbcPaginationApplication>

Records which stage owns pagination for a JDBC select plan.

Exactly one stage must own an effective limit or offset. Execution finalization uses this value to avoid applying a LimitHandler to a plan whose translator or JDBC metadata already represents pagination.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JDBC	Pagination is represented entirely by JDBC maximum-row or result-set skipping instructions.
NONE	The plan has no effective limit or offset.
RAW_SQL	Pagination must still be applied to the completed SQL by a LimitHandler.
RENDERED	Pagination syntax and parameters were rendered by the SQL AST translator.

Method Summary

Modifier and Type	Method	Description
static JdbcPaginationApplication	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JdbcPaginationApplication[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final JdbcPaginationApplication NONE

The plan has no effective limit or offset.

RENDERED

public static final JdbcPaginationApplication RENDERED

Pagination syntax and parameters were rendered by the SQL AST translator.

JDBC

public static final JdbcPaginationApplication JDBC

Pagination is represented entirely by JDBC maximum-row or result-set skipping instructions.

RAW_SQL

public static final JdbcPaginationApplication RAW_SQL

Pagination must still be applied to the completed SQL by a LimitHandler.

Method Details

values

public static JdbcPaginationApplication[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JdbcPaginationApplication valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null