Packages

o

org.mongodb.scala.model.search

SearchCollector

object SearchCollector

The core part of the $search pipeline stage of an aggregation pipeline. SearchCollectors allow returning metadata together with the matching search results. You may use the $$SEARCH_META variable, e.g., via Projections.computedSearchMeta, to extract this metadata.

Annotations
@Beta()
Since

4.7

See also

Search collectors

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SearchCollector
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def facet(operator: SearchOperator, facets: Iterable[_ <: SearchFacet]): FacetSearchCollector

    Returns a SearchCollector that groups results by values or ranges in the specified faceted fields and returns the count for each of those groups.

    Returns a SearchCollector that groups results by values or ranges in the specified faceted fields and returns the count for each of those groups.

    operator

    The search operator to use.

    facets

    The non-empty facet definitions.

    returns

    The requested SearchCollector.

    Annotations
    @Beta()
    See also

    facet collector

  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. def of(collector: Bson): SearchCollector

    Creates a SearchCollector from a Bson in situations when there is no builder method that better satisfies your needs.

    Creates a SearchCollector from a Bson in situations when there is no builder method that better satisfies your needs. This method cannot be used to validate the syntax.

    Example
    The following code creates two functionally equivalent SearchCollectors, though they may not be equal.

    val collector1: SearchCollector = SearchCollector.facet(
  SearchOperator.exists(
    SearchPath.fieldPath("fieldName")),
  Seq(
    SearchFacet.stringFacet(
      "stringFacetName",
      SearchPath.fieldPath("stringFieldName")),
    SearchFacet.numberFacet(
      "numberFacetName",
      SearchPath.fieldPath("numberFieldName"),
      Seq(10, 20, 30))))
val collector2: SearchCollector = SearchCollector.of(Document("facet" ->
  Document("operator" -> SearchOperator.exists(
    SearchPath.fieldPath("fieldName")).toBsonDocument,
    "facets" -> SearchFacet.combineToBson(Seq(
      SearchFacet.stringFacet(
        "stringFacetName",
        SearchPath.fieldPath("stringFieldName")),
      SearchFacet.numberFacet(
        "numberFacetName",
        SearchPath.fieldPath("numberFieldName"),
        Seq(10, 20, 30)))).toBsonDocument)))
    collector

    A Bson representing the required SearchCollector.

    returns

    The requested SearchCollector.

  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped