Record Class PaginationResult

java.lang.Object
java.lang.Record
org.hibernate.dialect.pagination.spi.PaginationResult
Record Components:
sql - completed, possibly rewritten SQL
jdbcInstructions - JDBC binding, maximum-row, and row-skipping work
@SPI public record PaginationResult(String sql, PaginationJdbcInstructions jdbcInstructions) extends Record

Immutable result returned by LimitHandler.processSql(PaginationRequest), pairing completed SQL with all JDBC and result-set work required by its pagination.

The SQL and instructions form one protocol result and must remain consistent. In particular, values represented by SQL parameters must appear in the appropriate instruction list.

Since:
8.0

  • Constructor Details

    • PaginationResult

      public PaginationResult(String sql, PaginationJdbcInstructions jdbcInstructions)
      Creates an instance of a PaginationResult record class.
      Parameters:
      sql - the value for the sql record component
      jdbcInstructions - the value for the jdbcInstructions record component

  • Method Details

    • unchanged

      public static PaginationResult unchanged(String sql)
      Return the given SQL with no pagination-specific JDBC work.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • sql

      public String sql()
      Returns the value of the sql record component.
      Returns:
      the value of the sql record component

    • jdbcInstructions

      public PaginationJdbcInstructions jdbcInstructions()
      Returns the value of the jdbcInstructions record component.
      Returns:
      the value of the jdbcInstructions record component