Constructor Detail

Method Detail

• project

   <NewEntity extends Any> PanacheQuery<NewEntity> project(Class<NewEntity> type)

  Defines a projection class: the getters, and the public fields, will be used to restrict which fields should be retrieved from the database.

• page

   PanacheQuery<Entity> page(Page page)

  Sets the current page.

  Parameters:

  page - the new page

• page

   PanacheQuery<Entity> page(Integer pageIndex, Integer pageSize)

  Sets the current page.

  Parameters:

  pageIndex - the page index

  pageSize - the page size

• page

   Page page()

  Returns the current page.

• nextPage

   PanacheQuery<Entity> nextPage()

  Sets the current page to the next page

• previousPage

   PanacheQuery<Entity> previousPage()

  Sets the current page to the previous page (or the first page if there is no previous page)

• firstPage

   PanacheQuery<Entity> firstPage()

  Sets the current page to the first page

• lastPage

   PanacheQuery<Entity> lastPage()

  Sets the current page to the last page. This will cause reading of the entity count.

• hasNextPage

   Boolean hasNextPage()

  Returns true if there is another page to read after the current one. This will cause reading of the entity count.

• hasPreviousPage

   Boolean hasPreviousPage()

  Returns true if there is a page to read before the current one.

• pageCount

   Integer pageCount()

  Returns the total number of pages to be read using the current page size. This will cause reading of the entity count.

• range

   PanacheQuery<Entity> range(Integer startIndex, Integer lastIndex)

  Switch the query to use a fixed range (start index - last index) instead of a page. As the range is fixed, subsequent pagination of the query is not possible.

  Parameters:

  startIndex - the index of the first element, starting at 0

  lastIndex - the index of the last element

• withLock

   PanacheQuery<Entity> withLock(LockModeType lockModeType)

  Define the locking strategy used for this query.

  Parameters:

  lockModeType - the locking strategy to be used for this query.

• withHint

   PanacheQuery<Entity> withHint(String hintName, Object value)

  Set a query property or hint on the underlying JPA Query.

  Parameters:

  hintName - name of the property or hint.

  value - value for the property or hint.

• filter

   PanacheQuery<Entity> filter(String filterName, Parameters parameters)

  <p> Enables a Hibernate filter during fetching of results for this query. Your filter must be declared with [FilterDef] on your entity or package, and enabled with [Filter] on your entity. <p> WARNING: setting filters can only be done on the underlying Hibernate [Session] and so this will modify the session's filters for the duration of obtaining the results (not while building the query). Enabled filters will be removed from the session afterwards, but no effort is made to preserve filters enabled on the session outside of this API.

  Parameters:

  filterName - The name of the filter to enable

  parameters - The set of parameters for the filter, if the filter requires parameters

• filter

   PanacheQuery<Entity> filter(String filterName, Map<String, Object> parameters)

  <p> Enables a Hibernate filter during fetching of results for this query. Your filter must be declared with [FilterDef] on your entity or package, and enabled with [Filter] on your entity. <p> WARNING: setting filters can only be done on the underlying Hibernate [Session] and so this will modify the session's filters for the duration of obtaining the results (not while building the query). Enabled filters will be removed from the session afterwards, but no effort is made to preserve filters enabled on the session outside of this API.

  Parameters:

  filterName - The name of the filter to enable

  parameters - The set of parameters for the filter, if the filter requires parameters

• filter

   PanacheQuery<Entity> filter(String filterName)

  <p> Enables a Hibernate filter during fetching of results for this query. Your filter must be declared with [FilterDef] on your entity or package, and enabled with [Filter] on your entity. <p> WARNING: setting filters can only be done on the underlying Hibernate [Session] and so this will modify the session's filters for the duration of obtaining the results (not while building the query). Enabled filters will be removed from the session afterwards, but no effort is made to preserve filters enabled on the session outside of this API.

  Parameters:

  filterName - The name of the filter to enable

• count

   Long count()

  Reads and caches the total number of entities this query operates on. This causes a database query with <code>SELECT COUNT(*)</code> and a query equivalent to the current query, minus ordering.

• list

   List<Entity> list()

  Returns the current page of results as a List.

• stream

   Stream<Entity> stream()

  Returns the current page of results as a Stream.

• firstResult

   Entity firstResult()

  Returns the first result of the current page index. This ignores the current page size to fetch a single result.

• singleResult

   Entity singleResult()

  Executes this query for the current page and return a single result.