lightdb-core
API
Generated with
lightdb-core/lightdb/Query

Query

lightdb.Query
See theQuery companion object
case class Query[Doc <: Document[Doc], Model <: DocumentModel[Doc]](collection: Collection[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

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

Members list

Type members

Classlikes

object search

Attributes

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

Value members

Concrete methods

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

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

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: Query[Doc, Model]
def sort(sort: Sort*): Query[Doc, Model]
def toList(implicit transaction: Transaction[Doc]): List[Doc]

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with