pagination

com.outr.arango.pagination.PaginationSupport.pagination
object pagination

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
pagination.type

Members list

Value members

Concrete methods

def apply[R](query: Query, pageSize: Int, resultType: ResultType, ttl: FiniteDuration)(implicit rw: RW[R]): IO[Option[Page[R]]]

Creates a new pagination cache and returns the first page.

Creates a new pagination cache and returns the first page.

Value parameters

pageSize

the size of each page

query

the query to paginate

resultType

the result type

ttl

the time to live from now

Attributes

def doMaintenance(): IO[Unit]

Execute maintenance now. Does not affect the scheduled maintenance time.

Execute maintenance now. Does not affect the scheduled maintenance time.

Attributes

def load[R](queryId: Id[Query], page: Int, pageSize: Int)(implicit rw: RW[R]): IO[Option[Page[R]]]

Loads a previously cached query.

Loads a previously cached query.

Value parameters

page

the page number starting at 0

pageSize

the page size

queryId

the existing query id to load

Attributes

def overflowing: IO[Boolean]

True if the number of currently cached results is above the pagedResultsMax threshold. Calls to create a new pagination cache will return None if this is true.

True if the number of currently cached results is above the pagedResultsMax threshold. Calls to create a new pagination cache will return None if this is true.

Attributes

def renew(queryId: Id[Query], ttl: FiniteDuration): IO[Unit]

Renews the expiration on a query.

Renews the expiration on a query.

Value parameters

queryId

the query id to renew

ttl

the time from now the query will remain active

Attributes