class DocumentCollectionQuery[D <: Document[D], M <: DocumentModel[D]] extends QueryBuilder[D] with DocumentQuery[D]
- Alphabetic
- By Inheritance
- DocumentCollectionQuery
- DocumentQuery
- QueryBuilder
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DocumentCollectionQuery(collection: DocumentCollection[D, M])
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- Definition Classes
- QueryBuilder
- def apply(query: Query): QueryBuilder[D]
Creates a QueryBuilder from the supplied Query
Creates a QueryBuilder from the supplied Query
- query
the query to use
- returns
QueryBuilder[D]
- Definition Classes
- DocumentCollectionQuery → DocumentQuery
- 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
- T
return type
- rw
the RW for conversion
- returns
QueryBuilder[T]
- Definition Classes
- QueryBuilder
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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
- filter
the filter to apply to this collection
- sort
the sorting to use
- returns
QueryBuilder[D]
- Definition Classes
- DocumentCollectionQuery → DocumentQuery
- def byFilter(filter: => Filter): QueryBuilder[D]
Creates a QueryBuilder from the supplied filter
Creates a QueryBuilder from the supplied filter
- filter
the filter to apply to this collection
- returns
QueryBuilder[D]
- Definition Classes
- DocumentCollectionQuery → DocumentQuery
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- val converter: (Json) => D
- Definition Classes
- QueryBuilder
- def count: IO[Int]
Streams the result to return a count.
Streams the result to return a count. A query that generates a count would be more efficient.
- Definition Classes
- QueryBuilder
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- Definition Classes
- QueryBuilder
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def iterator: IO[Iterator[D]]
- Definition Classes
- 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.
- Definition Classes
- QueryBuilder
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def one: IO[D]
Retrieves exactly one result from the query.
Retrieves exactly one result from the query. If there is zero or more than one an exception will be thrown.
- returns
IO[R]
- Definition Classes
- QueryBuilder
- def process(processor: (DBQueue, D) => IO[DBQueue], batchSize: Int = 1000): 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.
- processor
the function to handle processing the items in the stream
- batchSize
the maximum records to hold in memory for a specific collection and operation
- returns
IO[ProcessStats]
- Definition Classes
- QueryBuilder
- val query: Query
- Definition Classes
- 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]
- Definition Classes
- QueryBuilder
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- QueryBuilder → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withRef(f: (DocumentRef[D, DocumentModel[D]]) => Unit): QueryBuilder[D]
Receives a DocumentRef in order to create a DSL query.
Receives a DocumentRef in order to create a DSL query.
- f
the function to create the query
- returns
QueryBuilder[D]
- Definition Classes
- DocumentCollectionQuery → DocumentQuery
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated