Record Class QueryOption.ResultSetCache

java.lang.Object
java.lang.Record
org.hibernate.query.QueryOption.ResultSetCache
Record Components:
region - The second-level cache region to use, or null for the default query cache region
All Implemented Interfaces:
TypedQuery.Option
Enclosing interface:
QueryOption
public static record QueryOption.ResultSetCache(@Nullable String region) extends Record implements TypedQuery.Option

Specifies that the query result set should be cached in the given region.

This is different to second-level caching of any returned entities and collections, which is controlled by the CacheMode.

The query being "eligible" for caching does not necessarily mean its results will be cached; second-level query caching must also be explicitly enabled by setting the configuration property "hibernate.cache.use_query_cache".

Since:
8.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResultSetCache(String region)
    Creates an instance of a ResultSetCache record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    region()
    Returns the value of the region record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ResultSetCache

      public ResultSetCache(@Nullable String region)
      Creates an instance of a ResultSetCache record class.
      Parameters:
      region - the value for the region record component

  • Method Details

    • 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.

    • region

      @Nullable public String region()
      Returns the value of the region record component.
      Returns:
      the value of the region record component