scarango-driver
API
Generated with
scarango-driver/com.outr.arango/com.outr.arango.pagination/PaginationSupport

PaginationSupport

com.outr.arango.pagination.PaginationSupport
trait PaginationSupport extends Graph

Attributes

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

Members list

Type members

Classlikes

object pagination

Attributes

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

Inherited classlikes

case class AppliedUpgrades(labels: Set[String])

Attributes

Inherited from:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AppliedUpgrades

Attributes

Inherited from:
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any

Value members

Concrete methods

override def init(createDatabase: Boolean, dropDatabase: Boolean): IO[Unit]

Attributes

Definition Classes
protected def paginationMaintenanceSchedule: FiniteDuration

Frequency to run maintenance. Defaults to every 10 minutes.

Frequency to run maintenance. Defaults to every 10 minutes.

Attributes

Inherited methods

protected def afterStartup(upgrades: List[DatabaseUpgrade]): IO[Unit]

Attributes

Inherited from:
Graph
def collections: List[DocumentCollection[_ <: Document[_], _ <: DocumentModel[_]]]

Attributes

Inherited from:
Graph
def databaseName: String

Attributes

Inherited from:
Graph
protected def doUpgrades(allUpgrades: List[DatabaseUpgrade], upgrades: List[DatabaseUpgrade], stillBlocking: Boolean, appliedUpgrades: Set[String]): IO[Unit]

Attributes

Inherited from:
Graph
def drop(): IO[Boolean]

Attributes

Inherited from:
Graph
def edge[E <: Edge[LazyRef(...), From, To], M <: EdgeModel[E, From, To], From, To](model: M, managed: Boolean): EdgeCollection[E, M, From, To]

Attributes

Inherited from:
Graph
def execute(query: Query): IO[Unit]

Executes the query ignoring the result. Useful for queries that modify data but don't return anything useful.

Executes the query ignoring the result. Useful for queries that modify data but don't return anything useful.

Attributes

Inherited from:
Graph
def initialized: Boolean

Attributes

Inherited from:
Graph
protected def initted[Return](f: => Return): Return

Attributes

Inherited from:
Graph
def keyStore(collectionName: String, managed: Boolean): DatabaseStore

Attributes

Inherited from:
Graph
def query[T](query: Query, converter: Json => T): QueryBuilder[T]

Attributes

Inherited from:
Graph
def query[T](query: Query)(implicit rw: RW[T]): QueryBuilder[T]

Creates a QueryBuilder[T] to manage execution of the supplied query.

Creates a QueryBuilder[T] to manage execution of the supplied query.

Type parameters

T

the type of results

Value parameters

query

the query to create the builder for

Attributes

Returns

QueryBuilder[T]

Inherited from:
Graph
def server: ArangoDBServer

Attributes

Inherited from:
Graph
def shutdown(): IO[Unit]

Attributes

Inherited from:
Graph
protected def storeCollectionName: String

Attributes

Inherited from:
Graph
def stores: List[DatabaseStore]

Attributes

Inherited from:
Graph
def truncate(): IO[Unit]

Attributes

Inherited from:
Graph
def upgrades: List[DatabaseUpgrade]

Attributes

Inherited from:
Graph
def vertex[D <: Document[LazyRef(...)], M <: DocumentModel[D]](model: M, managed: Boolean): DocumentCollection[D, M]

Attributes

Inherited from:
Graph
def view(name: String, links: List[ViewLink], managed: Boolean, primarySort: List[Sort], primarySortCompression: SortCompression, consolidationInterval: FiniteDuration, commitInterval: FiniteDuration, cleanupIntervalStep: Int): View

Attributes

Inherited from:
Graph
def views: List[View]

Attributes

Inherited from:
Graph

Concrete fields

val pagedResults: DocumentCollection[PagedResult, PagedResult.type]

Collection representing the pagination cache

Collection representing the pagination cache

Attributes

val pagedResultsMax: Int

Maximum number of results able to be stored in the cache. If this overflows, subsequent queries will fallback to ResultType.Realtime until there is availability to store more. This helps avoid risk of DoS style attacks or overloading leading to storage issues with the database.

Maximum number of results able to be stored in the cache. If this overflows, subsequent queries will fallback to ResultType.Realtime until there is availability to store more. This helps avoid risk of DoS style attacks or overloading leading to storage issues with the database.

Attributes

val pagedResultsQueryMax: Int

Maximum number of results to be cached per query.

Maximum number of results to be cached per query.

Attributes

Inherited fields

val managed: Boolean

Attributes

Inherited from:
Graph
val store: DatabaseStore

Attributes

Inherited from:
Graph
lazy val transaction: ArangoDBTransaction[Collection]

Attributes

Inherited from:
Graph
Generated with