scarango-driver/com.outr.arango.collection/DocumentCollectionQuery

DocumentCollectionQuery

class DocumentCollectionQuery[D <: Document[D]](collection: DocumentCollection[D]) extends QueryBuilder[D] with DocumentQuery[D]
Companion:
object
trait DocumentQuery[D]
class QueryBuilder[D]
class Object
trait Matchable
class Any

Value members

Concrete methods

override 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

Returns:

QueryBuilder[D]

Definition Classes
override def byFilter(filter: => Filter): QueryBuilder[D]

Creates a QueryBuilder from the supplied filter

Creates a QueryBuilder from the supplied filter

Value parameters:
filter

the filter to apply to this collection

Returns:

QueryBuilder[D]

Definition Classes
override def byFilter(filter: => Filter, sort: (Field[_], SortDirection)): 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

sort

the sorting to use

Returns:

QueryBuilder[D]

Definition Classes

Inherited methods

def all: 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

Inherited from:
QueryBuilder
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

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.

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.

Inherited from:
QueryBuilder
def iterator: IO[Iterator[R]]
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.

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.

Returns:

IO[R]

Inherited from:
QueryBuilder
def process(processor: (DBQueue, D) => IO[DBQueue], batchSize: Int): IO[ProcessStats]

Process through the stream with the ability to batch queue db inserts, upserts, and deletes.

Process through the stream with the ability to batch queue db inserts, upserts, and deletes.

Value parameters:
batchSize

the maximum records to hold in memory for a specific collection and operation

processor

the function to handle processing the items in the stream

Returns:

IO[ProcessStats]

Inherited from:
QueryBuilder
def stream: 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

Returns:

fs2.Stream[IO, R]

Inherited from:
QueryBuilder