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

Inherited methods

def all: IO[List[D]]

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: ReaderWriter[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 ReaderWriter for conversion

Returns:

QueryBuilder[T]

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

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 last: IO[Option[D]]

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[D]

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, D]

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