Class

reactivemongo.api.commands.AggregationFramework

Sample

Related Doc: package AggregationFramework

Permalink

case class Sample(size: Int) extends PipelineOperator with Product with Serializable

$sample aggregation stage, that randomly selects the specified number of documents from its input.

size

the number of documents to return

Linear Supertypes
Serializable, Serializable, Product, Equals, AggregationFramework.PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Sample
  2. Serializable
  3. Serializable
  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. All

Instance Constructors

  1. new Sample(size: Int)

    Permalink

    size

    the number of documents to return

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to any2stringadd[Sample] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Sample, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to ArrowAssoc[Sample] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (Sample) ⇒ Boolean, msg: ⇒ Any): Sample

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (Sample) ⇒ Boolean): Sample

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Sample

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): Sample

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to StringFormat[Sample] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. val makePipe: P.Document

    Permalink
    Definition Classes
    Sample → PipelineOperator

  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. val size: Int

    Permalink

    the number of documents to return

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. def →[B](y: B): (Sample, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Sample to ArrowAssoc[Sample] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AggregationFramework.PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Sample to any2stringadd[Sample]

Inherited by implicit conversion StringFormat from Sample to StringFormat[Sample]

Inherited by implicit conversion Ensuring from Sample to Ensuring[Sample]

Inherited by implicit conversion ArrowAssoc from Sample to ArrowAssoc[Sample]

Ungrouped