quarkus-hibernate-orm-panache-kotlin/io.quarkus.hibernate.orm.panache.kotlin/PanacheQuery

PanacheQuery

Interface representing an entity query, which abstracts the use of paging, getting the number of results, and operating on List or java.util.Stream.

Instances of this interface cannot mutate the query itself or its parameters: only paging information can be modified, and instances of this interface can be reused to obtain multiple pages of results.

Parameters

Entity

The entity type being queried

Inheritors

PanacheQueryImpl

Functions

count

abstract fun count(): Long

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

filter

abstract fun filter(filterName: String): PanacheQuery<Entity>

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

abstract fun filter(filterName: String, parameters: Map<String, Any>): PanacheQuery<Entity>

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.

firstPage

abstract fun firstPage(): PanacheQuery<Entity>

Sets the current page to the first page

firstResult

abstract fun firstResult(): Entity?

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

hasNextPage

abstract fun hasNextPage(): Boolean

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

hasPreviousPage

abstract fun hasPreviousPage(): Boolean

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

lastPage

abstract fun lastPage(): PanacheQuery<Entity>

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

list

abstract fun list(): List<Entity>

Returns the current page of results as a List.

abstract fun nextPage(): PanacheQuery<Entity>

Sets the current page to the next page

page

abstract fun page(): Page

Returns the current page.

abstract fun page(page: Page): PanacheQuery<Entity>

abstract fun page(pageIndex: Int, pageSize: Int): PanacheQuery<Entity>

Sets the current page.

pageCount

abstract fun pageCount(): Int

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

abstract fun previousPage(): PanacheQuery<Entity>

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

project

abstract fun <NewEntity : Any> project(type: Class<NewEntity>): PanacheQuery<NewEntity>

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

range

abstract fun range(startIndex: Int, lastIndex: Int): PanacheQuery<Entity>

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.

singleResult

abstract fun singleResult(): Entity

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

stream

abstract fun stream(): Stream<Entity>

Returns the current page of results as a Stream.

withHint

abstract fun withHint(hintName: String, value: Any): PanacheQuery<Entity>

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

withLock

abstract fun withLock(lockModeType: LockModeType): PanacheQuery<Entity>

Define the locking strategy used for this query.