Packages

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

Self Type
Query[Doc, Model, V]
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(model: Model, collection: Collection[Doc, Model], conversion: Conversion[Doc, V], filter: Option[Filter[Doc]] = None, sort: List[Sort] = Nil, offset: Int = 0, limit: Option[Int] = None, pageSize: Int = 1_000, countTotal: Boolean = false, scoreDocs: Boolean = false, minDocScore: Option[Double] = None, facets: List[FacetQuery[Doc]] = Nil, arbitraryQuery: Option[ArbitraryQuery] = None, optimize: Boolean = false)

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. val arbitraryQuery: Option[ArbitraryQuery]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearFilters: Q
  8. def clearLimit: Q
  9. def clearSort: Q
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  11. val collection: Collection[Doc, Model]
  12. def conversion[T](conversion: Conversion[Doc, T]): Query[Doc, Model, T]
  13. val conversion: Conversion[Doc, V]
  14. def converted[T](f: (Doc) => T): Query[Doc, Model, T]
  15. def count(implicit transaction: Transaction[Doc]): Task[Int]
  16. def countTotal(b: Boolean): Q
  17. val countTotal: Boolean
  18. def distance[G <: Geo](f: (Model) => Field[Doc, List[G]], from: Point, sort: Boolean = true, radius: Option[Distance] = None): Query[Doc, Model, DistanceAndDoc[Doc]]
  19. def docAndIndexes: Query[Doc, Model, MaterializedAndDoc[Doc, Model]]
  20. def docs: Query[Doc, Model, Doc]
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def facet(f: (Model) => FacetField[Doc], path: List[String] = Nil, childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Q
  23. def facets(f: (Model) => List[FacetField[Doc]], childrenLimit: Option[Int] = Some(10), dimsLimit: Option[Int] = Some(10)): Q
  24. val facets: List[FacetQuery[Doc]]
  25. def filter(f: (Model) => Filter[Doc]): Q
  26. val filter: Option[Filter[Doc]]
  27. def filterOption(f: (Model) => Option[Filter[Doc]]): Q
  28. def first(implicit transaction: Transaction[Doc]): Task[V]
  29. def firstOption(implicit transaction: Transaction[Doc]): Task[Option[V]]
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  31. def grouped[F](f: (Model) => Field[Doc, F], direction: SortDirection = SortDirection.Ascending)(implicit transaction: Transaction[Doc]): Stream[Grouped[F, Doc]]
  32. def id: Query[Doc, Model, Id[Doc]]
  33. def indexes: Query[Doc, Model, MaterializedIndex[Doc, Model]]
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def json(f: (Model) => List[Field[Doc, _]] = _ => model.fields): Query[Doc, Model, Json]
  36. def limit(limit: Int): Q
  37. val limit: Option[Int]
  38. def materialized(f: (Model) => List[Field[Doc, _]] = _ => model.indexedFields): Query[Doc, Model, MaterializedIndex[Doc, Model]]
  39. def minDocScore(min: Double): Q
  40. val minDocScore: Option[Double]
  41. val model: Model
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  45. def offset(offset: Int): Q
  46. val offset: Int
  47. val optimize: Boolean
  48. def optimized: Q
  49. def pageSize(size: Int): Q
  50. val pageSize: Int
  51. def process(establishLock: Boolean = true, deleteOnNone: Boolean = true, safeModify: Boolean = true)(f: Forge[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

  52. def productElementNames: Iterator[String]
    Definition Classes
    Product
  53. val scoreDocs: Boolean
  54. def scored: Q
  55. def search(implicit transaction: Transaction[Doc]): Task[SearchResults[Doc, Model, V]]
  56. def sort(sort: Sort*): Q
  57. val sort: List[Sort]
  58. def stream(implicit transaction: Transaction[Doc]): Stream[V]
  59. def streamPage(implicit transaction: Transaction[Doc]): Stream[V]
  60. def streamScored(implicit transaction: Transaction[Doc]): Stream[(V, Double)]
  61. def streamScoredPage(implicit transaction: Transaction[Doc]): Stream[(V, Double)]
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toList(implicit transaction: Transaction[Doc]): Task[List[V]]
  64. def unOptimized: Q
  65. def value[F](f: (Model) => Field[Doc, F]): Query[Doc, Model, F]
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. def withArbitraryQuery(query: ArbitraryQuery): Q

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