case class Query[Doc <: Document[Doc], Model <: DocumentModel[Doc], V](transaction: CollectionTransaction[Doc, Model], conversion: Conversion[Doc, V], filter: Option[Filter[Doc]] = None, sort: List[Sort] = Nil, offset: Int = 0, limit: Option[Int] = None, pageSize: Int = 1000, countTotal: Boolean = false, scoreDocs: Boolean = false, minDocScore: Option[Double] = None, facets: List[FacetQuery[Doc]] = Nil, optimize: Boolean = false) extends Product with Serializable
- Self Type
- Query[Doc, Model, V]
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- Query
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Query(transaction: CollectionTransaction[Doc, Model], conversion: Conversion[Doc, V], filter: Option[Filter[Doc]] = None, sort: List[Sort] = Nil, offset: Int = 0, limit: Option[Int] = None, pageSize: Int = 1000, countTotal: Boolean = false, scoreDocs: Boolean = false, minDocScore: Option[Double] = None, facets: List[FacetQuery[Doc]] = Nil, optimize: Boolean = false)
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 aggregate(f: (Model) => List[AggregateFunction[_, _, Doc]]): AggregateQuery[Doc, Model]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearFilters: Q
- def clearLimit: Q
- def clearSort: Q
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def collection: Collection[Doc, Model]
- def conversion[T](conversion: Conversion[Doc, T]): Query[Doc, Model, T]
- val conversion: Conversion[Doc, V]
- def converted[T](f: (Doc) => T): Query[Doc, Model, T]
- def count: Task[Int]
- def countTotal(b: Boolean): Q
- val countTotal: Boolean
- def distance[G <: Geo](f: (Model) => Field[Doc, List[G]], from: Point, sort: Boolean = true, radius: Option[Distance] = None): Query[Doc, Model, DistanceAndDoc[Doc]]
- def docAndIndexes: Query[Doc, Model, MaterializedAndDoc[Doc, Model]]
- def docs: Query[Doc, Model, Doc]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def facet(f: (Model) => FacetField[Doc], path: List[String] = Nil, childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Q
- def facets(f: (Model) => List[FacetField[Doc]], childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Q
- val facets: List[FacetQuery[Doc]]
- def filter(f: (Model) => Filter[Doc]): Q
- val filter: Option[Filter[Doc]]
- def filterOption(f: (Model) => Option[Filter[Doc]]): Q
- def first: Task[V]
- def firstOption: Task[Option[V]]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def grouped[F](f: (Model) => Field[Doc, F], direction: SortDirection = SortDirection.Ascending): Stream[Grouped[F, Doc]]
- def id: Query[Doc, Model, Id[Doc]]
- def indexes: Query[Doc, Model, MaterializedIndex[Doc, Model]]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def json(f: (Model) => List[Field[Doc, _]] = _ => model.fields): Query[Doc, Model, Json]
- def limit(limit: Int): Q
- val limit: Option[Int]
- def materialized(f: (Model) => List[Field[Doc, _]] = _ => model.indexedFields): Query[Doc, Model, MaterializedIndex[Doc, Model]]
- def minDocScore(min: Double): Q
- val minDocScore: Option[Double]
- def model: Model
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def offset(offset: Int): Q
- val offset: Int
- val optimize: Boolean
- def optimized: Q
- def pageSize(size: Int): Q
- val pageSize: Int
- def process(establishLock: Boolean = true, deleteOnNone: Boolean = true, safeModify: Boolean = true)(f: Forge[Doc, Option[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.
- establishLock
whether to establish an id lock to avoid concurrent modification (defaults to true)
- deleteOnNone
whether to delete the record if the function returns None (defaults to true)
- safeModify
whether to use safe modification. This results in loading the same object twice, but should never risk concurrent modification occurring. (defaults to true)
- f
the processing function for records
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val scoreDocs: Boolean
- def scored: Q
- def search: Task[SearchResults[Doc, Model, V]]
- def sort(sort: Sort*): Q
- val sort: List[Sort]
- def stream: Stream[V]
- def streamPage: Stream[V]
- def streamScored: Stream[(V, Double)]
- def streamScoredPage: Stream[(V, Double)]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toList: Task[List[V]]
- val transaction: CollectionTransaction[Doc, Model]
- def unOptimized: Q
- def value[F](f: (Model) => Field[Doc, F]): Query[Doc, Model, F]
- 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])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)