object SearchCollector
The core part of the $search
pipeline stage of an aggregation pipeline.
SearchCollector
s 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
- Alphabetic
- By Inheritance
- SearchCollector
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def of(collector: Bson): SearchCollector
Creates a
SearchCollector
from aBson
in situations when there is no builder method that better satisfies your needs.Creates a
SearchCollector
from aBson
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 equivalentSearchCollector
s, 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 requiredSearchCollector
.- returns
The requested
SearchCollector
.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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]) @native()
- 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
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: