Packages

case class Query[Doc <: Document[Doc], Model <: DocumentModel[Doc]](collection: Collection[Doc, Model], filter: Option[Filter[Doc]] = None, sort: List[Sort] = Nil, offset: Int = 0, limit: Option[Int] = None, countTotal: Boolean = false, scoreDocs: Boolean = false, minDocScore: Option[Double] = None, facets: List[FacetQuery[Doc]] = Nil) extends Product with Serializable

Self Type
Query[Doc, Model]
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Query
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Query(collection: Collection[Doc, Model], filter: Option[Filter[Doc]] = None, sort: List[Sort] = Nil, offset: Int = 0, limit: Option[Int] = None, countTotal: Boolean = false, scoreDocs: Boolean = false, minDocScore: Option[Double] = None, facets: List[FacetQuery[Doc]] = Nil)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def aggregate(f: (Model) => List[AggregateFunction[_, _, Doc]]): AggregateQuery[Doc, Model]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clearFilters: Query[Doc, Model]
  7. def clearLimit: Query[Doc, Model]
  8. def clearSort: Query[Doc, Model]
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. val collection: Collection[Doc, Model]
  11. def count(implicit transaction: Transaction[Doc]): Int
  12. def countTotal(b: Boolean): Query[Doc, Model]
  13. val countTotal: Boolean
  14. def distanceSearch[G <: Geo](field: Field[Doc, List[G]], from: Point, sort: Boolean, radius: Option[Distance])(implicit transaction: Transaction[Doc]): SearchResults[Doc, Model, DistanceAndDoc[Doc]]
    Attributes
    protected
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def facet(f: (Model) => FacetField[Doc], path: List[String] = Nil, childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Query[Doc, Model]
  17. def facets(f: (Model) => List[FacetField[Doc]], childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Query[Doc, Model]
  18. val facets: List[FacetQuery[Doc]]
  19. def filter(f: (Model) => Filter[Doc]): Query[Doc, Model]
  20. val filter: Option[Filter[Doc]]
  21. def first(implicit transaction: Transaction[Doc]): Option[Doc]
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. def grouped[F](f: (Model) => Field[Doc, F], direction: SortDirection = SortDirection.Ascending)(implicit transaction: Transaction[Doc]): GroupedIterator[Doc, F]
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def iterator(implicit transaction: Transaction[Doc]): Iterator[Doc]
  26. def limit(limit: Int): Query[Doc, Model]
  27. val limit: Option[Int]
  28. def minDocScore(min: Double): Query[Doc, Model]
  29. val minDocScore: Option[Double]
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. def offset(offset: Int): Query[Doc, Model]
  34. val offset: Int
  35. def one(implicit transaction: Transaction[Doc]): Doc
  36. def process(establishLock: Boolean = true, deleteOnNone: Boolean = true, safeModify: Boolean = true)(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.

    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

  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. val scoreDocs: Boolean
  39. def scored: Query[Doc, Model]
  40. def sort(sort: Sort*): Query[Doc, Model]
  41. val sort: List[Sort]
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def toList(implicit transaction: Transaction[Doc]): List[Doc]
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. object search

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped