Packages

class Facet extends PipelineOperator with Product1[Iterable[(String, Pipeline)]] with Serializable

Processes multiple aggregation pipelines within a single stage on the same set of input documents.

Each sub-pipeline has its own field in the output document where its results are stored as an array of documents.

See also

https://docs.mongodb.com/manual/reference/operator/aggregation/facet/

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Facet
  2. Serializable
  3. Product1
  4. Product
  5. Equals
  6. PipelineOperator
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Facet toany2stringadd[Facet] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Facet, B)
    Implicit
    This member is added by an implicit conversion from Facet toArrowAssoc[Facet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (Facet) => Boolean, msg: => Any): Facet
    Implicit
    This member is added by an implicit conversion from Facet toEnsuring[Facet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Facet) => Boolean): Facet
    Implicit
    This member is added by an implicit conversion from Facet toEnsuring[Facet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Facet
    Implicit
    This member is added by an implicit conversion from Facet toEnsuring[Facet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Facet
    Implicit
    This member is added by an implicit conversion from Facet toEnsuring[Facet] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(that: Any): Boolean
    Definition Classes
    Facet → Equals → AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Facet toStringFormat[Facet] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    Facet → AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val makePipe: P.Document
    Definition Classes
    Facet → PipelineOperator
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def productArity: Int
    Definition Classes
    Product1 → Product
  23. def productElement(n: Int): Any
    Definition Classes
    Product1 → Product
    Annotations
    @throws(classOf[java.lang.IndexOutOfBoundsException])
  24. def productElementName(n: Int): String
    Definition Classes
    Product
  25. def productElementNames: Iterator[String]
    Definition Classes
    Product
  26. def productIterator: Iterator[Any]
    Definition Classes
    Product
  27. def productPrefix: String
    Definition Classes
    Product
  28. val specifications: Iterable[(String, AggregationFramework.Pipeline)]
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Facet → AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def _1: Iterable[(String, AggregationFramework.Pipeline)]
    Definition Classes
    Facet → Product1
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  2. def canEqual(that: Any): Boolean
    Definition Classes
    Facet → Equals
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.3) No longer a case class

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

    (Since version ) see corresponding Javadoc for more information.

  4. def [B](y: B): (Facet, B)
    Implicit
    This member is added by an implicit conversion from Facet toArrowAssoc[Facet] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product1[Iterable[(String, AggregationFramework.Pipeline)]]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFacet to any2stringadd[Facet]

Inherited by implicit conversion StringFormat fromFacet to StringFormat[Facet]

Inherited by implicit conversion Ensuring fromFacet to Ensuring[Facet]

Inherited by implicit conversion ArrowAssoc fromFacet to ArrowAssoc[Facet]

Ungrouped