scarango-driver
API
Generated with
scarango-driver/com.outr.arango/com.outr.arango.collection/DocumentCollectionQuery

DocumentCollectionQuery

com.outr.arango.collection.DocumentCollectionQuery
See theDocumentCollectionQuery companion object
class DocumentCollectionQuery[D <: Document[D], M <: DocumentModel[D]](collection: DocumentCollection[D, M]) extends QueryBuilder[D]

Attributes

Companion
object
Graph
Supertypes
class QueryBuilder[D]
trait Serializable
trait Product
trait Equals
trait QueryOptionsSupport[QueryBuilder[D]]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def all(sort: Option[(Field[_], SortDirection)], offset: Option[Int], limit: Option[Int]): QueryBuilder[D]

Creates a QueryBuilder all results with the sorts and limits

Creates a QueryBuilder all results with the sorts and limits

Value parameters

limit

the limit of results

offset

the offset to start

sort

the sorting to use

Attributes

Returns

QueryBuilder[D]

def apply(query: Query): QueryBuilder[D]

Creates a QueryBuilder from the supplied Query

Creates a QueryBuilder from the supplied Query

Value parameters

query

the query to use

Attributes

Returns

QueryBuilder[D]

def byFilter(filter: DocumentRef[D, M] => Filter, sort: Option[(Field[_], SortDirection)], offset: Option[Int], limit: Option[Int]): QueryBuilder[D]

Creates a QueryBuilder from the supplied filter and sorts the results

Creates a QueryBuilder from the supplied filter and sorts the results

Value parameters

filter

the filter to apply to this collection

limit

the limit of results

offset

the offset to start

sort

the sorting to use

Attributes

Returns

QueryBuilder[D]

def withRef(f: DocumentRef[D, M] => Unit): QueryBuilder[D]

Receives a DocumentRef in order to create a DSL query.

Receives a DocumentRef in order to create a DSL query.

Value parameters

f

the function to create the query

Attributes

Returns

QueryBuilder[D]

Inherited methods

def as[T](implicit rw: RW[T]): QueryBuilder[T]

Translates the results to a return type of T

Translates the results to a return type of T

Type parameters

T

return type

Value parameters

rw

the RW for conversion

Attributes

Returns

QueryBuilder[T]

Inherited from:
QueryBuilder
def count: IO[Int]

Streams the result to return a count. A query that generates a count would be more efficient.

Streams the result to return a count. A query that generates a count would be more efficient.

Attributes

Inherited from:
QueryBuilder
def cursor(): IO[Cursor[R]]

Retrieves the results as a Cursor.

Retrieves the results as a Cursor.

Attributes

Inherited from:
QueryBuilder
def cursorNext(cursorId: String): IO[Cursor[R]]

Retrieves the next page of a cursor.

Retrieves the next page of a cursor.

Value parameters

cursorId

the cursor id

Attributes

Inherited from:
QueryBuilder
def first: IO[Option[R]]

The first result from the stream if there are any results.

The first result from the stream if there are any results.

Attributes

Inherited from:
QueryBuilder
def iterator: IO[Iterator[R]]

Attributes

Inherited from:
QueryBuilder
def last: IO[Option[R]]

The last result from the stream if there are any results.

The last result from the stream if there are any results.

Attributes

Inherited from:
QueryBuilder
def one: IO[R]

Retrieves exactly one result from the query. If there is zero or more than one an exception will be thrown.

Retrieves exactly one result from the query. If there is zero or more than one an exception will be thrown.

Attributes

Returns

IO[R]

Inherited from:
QueryBuilder
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def stream(chunkSize: Int): Stream[IO, R]

Creates a Stream to get all the results from the query

Creates a Stream to get all the results from the query

Attributes

Returns

fs2.Stream[IO, R]

Inherited from:
QueryBuilder
def toList: IO[List[R]]

Convenience method to get the results from the stream as a List

Convenience method to get the results from the stream as a List

Attributes

Inherited from:
QueryBuilder
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
QueryBuilder -> Any
Inherited from:
QueryBuilder
def withAllowRetry(retry: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withBatchSize(batchSize: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withCache(cache: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withCount(count: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFailOnWarning(fail: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFillBlockCache(fill: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withFullCount(fullCount: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withIntermediateCommitCount(count: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withIntermediateCommitSize(size: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxNumberOfPlans(plans: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxRuntime(max: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxTransactionSize(max: Long): T

Attributes

Inherited from:
QueryOptionsSupport
def withMaxWarningCount(max: Int): T

Attributes

Inherited from:
QueryOptionsSupport
def withMemoryLimit(limit: Long): T

Attributes

Inherited from:
QueryOptionsSupport
override def withOptions(f: QueryOptions => QueryOptions): QueryBuilder[R]

Attributes

Definition Classes
QueryBuilder -> QueryOptionsSupport
Inherited from:
QueryBuilder
def withProfile(profile: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withSatelliteSyncWait(wait: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport
def withSkipInaccessibleCollections(skip: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withStream(stream: Boolean): T

Attributes

Inherited from:
QueryOptionsSupport
def withTTL(ttl: FiniteDuration): T

Attributes

Inherited from:
QueryOptionsSupport
Generated with