reactivemongo.api.commands.AggregationFramework

Sample

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Sample(size: Int)

    size

    the number of documents to return

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

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

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

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

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

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

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

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

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

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

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

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

  13. def ensuring(cond: Boolean): Sample

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

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

    Definition Classes
    AnyRef

  15. def finalize(): Unit

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

  16. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. val makePipe: P.Document

    Definition Classes
    Sample → PipelineOperator

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

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. val size: Int

    the number of documents to return

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

    Definition Classes
    AnyRef

  25. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Sample to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sample: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Sample to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sample: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Sample

    Implicit information
    This member is added by an implicit conversion from Sample to ArrowAssoc[Sample] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sample: ArrowAssoc[Sample]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Sample

    Implicit information
    This member is added by an implicit conversion from Sample to Ensuring[Sample] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sample: Ensuring[Sample]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from Sample to StringFormat

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

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

Ungrouped