quarkus-mongodb-panache-kotlin/io.quarkus.mongodb.panache.kotlin.runtime/PanacheQueryImpl

PanacheQueryImpl

class PanacheQueryImpl<Entity : Any> : PanacheQuery<Entity>

Functions

open override 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.

firstPage

open override fun firstPage(): PanacheQuery<Entity>

Sets the current page to the first page

firstResult

open override fun firstResult(): Entity?

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

hasNextPage

open override 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

open override fun hasPreviousPage(): Boolean

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

lastPage

open override fun lastPage(): PanacheQuery<Entity>

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

list

open override fun list(): List<Entity>

Returns the current page of results as a List.

open override fun nextPage(): PanacheQuery<Entity>

Sets the current page to the next page

page

open override fun page(): Page

Returns the current page.

open override fun page(page: Page): PanacheQuery<Entity>

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

Sets the current page.

pageCount

open override 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.

open override fun previousPage(): PanacheQuery<Entity>

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

project

open override fun <T : Any> project(type: Class<T>): PanacheQuery<T>

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

range

open override 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

open override fun singleResult(): Entity?

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

stream

open override fun stream(): Stream<Entity>

Returns the current page of results as a Stream.

withBatchSize

open override fun withBatchSize(batchSize: Int): PanacheQuery<Entity>

Define the batch size for this query.

withCollation

open override fun withCollation(collation: Collation): PanacheQuery<Entity>

Define the collation used for this query.

withReadPreference

open override fun withReadPreference(readPreference: ReadPreference?): PanacheQuery<Entity>

Define the read preference used for this query.