Interface QueryOptions

    • Method Detail

      • getFlushMode

        FlushMode getFlushMode()
        The flush mode to use for the query execution
      • isReadOnly

        Boolean isReadOnly()
        Should entities returned from the query be marked read-only.
      • getAppliedGraph

        AppliedGraph getAppliedGraph()
        JPA EntityGraph explicitly applied to the query.
      • getTupleTransformer

        TupleTransformer getTupleTransformer()
        Transformer applied to the query to transform the structure of each "row" in the results
      • getResultListTransformer

        ResultListTransformer getResultListTransformer()
        Transformer applied to the query to transform the structure of the overall results
      • getCacheRetrieveMode

        jakarta.persistence.CacheRetrieveMode getCacheRetrieveMode()
        Controls whether query results are read from the cache. No effect unless isResultCachingEnabled() returns true
        See Also:
        CacheMode
      • getCacheStoreMode

        jakarta.persistence.CacheStoreMode getCacheStoreMode()
        Controls whether query results are put into the cache. No effect unless isResultCachingEnabled() returns true
        See Also:
        CacheMode
      • getCacheMode

        default CacheMode getCacheMode()
      • getResultCacheRegionName

        String getResultCacheRegionName()
        The query cache region in which the results should be cached. No effect unless isResultCachingEnabled() returns true
      • getLockOptions

        LockOptions getLockOptions()
        Describes the locking to apply to the query results
      • getComment

        String getComment()
        The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments
      • getDatabaseHints

        List<String> getDatabaseHints()
        Hints to apply to the interpreted SQL query
      • getFirstRow

        default Integer getFirstRow()
        The first row from the results to return
        See Also:
        getLimit()
      • getMaxRows

        default Integer getMaxRows()
        The maximum number of rows to return from the results
        See Also:
        getLimit()
      • getEffectiveLimit

        default Limit getEffectiveLimit()
        Determine the effective paging limit to apply to the query. If the application did not explicitly specify paging limits, Limit.NONE is returned
        See Also:
        getLimit()
      • hasLimit

        default boolean hasLimit()
        Did the application explicitly request paging limits?
        See Also:
        getLimit()