lightdb-async
API
Generated with
lightdb-async/lightdb.async/AsyncQuery

AsyncQuery

lightdb.async.AsyncQuery
case class AsyncQuery[Doc <: Document[Doc], Model <: DocumentModel[Doc]](asyncCollection: AsyncCollection[Doc, Model], filter: Option[Filter[Doc]], sort: List[Sort], offset: Int, limit: Option[Int], countTotal: Boolean, scoreDocs: Boolean, minDocScore: Option[Double], facets: List[FacetQuery[Doc]])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
AsyncQuery[Doc, Model]

Members list

Type members

Classlikes

object search

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
search.type
object stream

Attributes

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

Value members

Concrete methods

def aggregate(f: Model => List[AggregateFunction[_, _, Doc]]): AsyncAggregateQuery[Doc, Model]
def clearFilters: AsyncQuery[Doc, Model]
def clearLimit: AsyncQuery[Doc, Model]
def clearSort: AsyncQuery[Doc, Model]
def count(implicit transaction: Transaction[Doc]): IO[Int]
def countTotal(b: Boolean): AsyncQuery[Doc, Model]
def facet(f: Model => FacetField[Doc], path: List[String], childrenLimit: Option[Int], dimsLimit: Option[Int]): AsyncQuery[Doc, Model]
def facets(f: Model => List[FacetField[Doc]], childrenLimit: Option[Int], dimsLimit: Option[Int]): AsyncQuery[Doc, Model]
def filter(f: Model => Filter[Doc]): AsyncQuery[Doc, Model]
def first(implicit transaction: Transaction[Doc]): IO[Option[Doc]]
def grouped[F](f: Model => Field[Doc, F], direction: SortDirection)(implicit transaction: Transaction[Doc]): Stream[IO, (F, List[Doc])]
def limit(limit: Int): AsyncQuery[Doc, Model]
def minDocScore(min: Double): AsyncQuery[Doc, Model]
def offset(offset: Int): AsyncQuery[Doc, Model]
def one(implicit transaction: Transaction[Doc]): IO[Doc]
def process(establishLock: Boolean, deleteOnNone: Boolean, safeModify: Boolean, maxConcurrent: Int)(f: Doc => IO[Option[Doc]])(implicit transaction: Transaction[Doc]): IO[Int]

Processes through each result record from the query modifying the data in the database.

Processes through each result record from the query modifying the data in the database.

Value parameters

deleteOnNone

whether to delete the record if the function returns None (defaults to true)

establishLock

whether to establish an id lock to avoid concurrent modification (defaults to true)

f

the processing function for records

maxConcurrent

the number of concurrent threads to process with (defaults to 1 for single-threaded)

safeModify

whether to use safe modification. This results in loading the same object twice, but should never risk concurrent modification occurring. (defaults to true)

Attributes

def scored: AsyncQuery[Doc, Model]
def sort(sort: Sort*): AsyncQuery[Doc, Model]
def toList(implicit transaction: Transaction[Doc]): IO[List[Doc]]
def toQuery: Query[Doc, Model]

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with