Class

reactivemongo.api.commands.AggregationFramework

Lookup

Related Doc: package AggregationFramework

Permalink

case class Lookup(from: String, localField: String, foreignField: String, as: String) extends PipelineOperator with Product with Serializable

_Since MongoDB 3.2:_ Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing. https://docs.mongodb.com/v3.2/reference/operator/aggregation/lookup/#pipe._S_lookup

from

the collection to perform the join with

localField

the field from the documents input

foreignField

the field from the documents in the from collection

as

the name of the new array field to add to the input documents

Linear Supertypes
Serializable, Serializable, Product, Equals, PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Lookup
  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 Lookup(from: String, localField: String, foreignField: String, as: String)

    Permalink

    from

    the collection to perform the join with

    localField

    the field from the documents input

    foreignField

    the field from the documents in the from collection

    as

    the name of the new array field to add to the input documents

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 Lookup to any2stringadd[Lookup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. val as: String

    Permalink

    the name of the new array field to add to the input documents

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def clone(): AnyRef

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

  9. def ensuring(cond: (Lookup) ⇒ Boolean, msg: ⇒ Any): Lookup

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

  10. def ensuring(cond: (Lookup) ⇒ Boolean): Lookup

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

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Lookup

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

  12. def ensuring(cond: Boolean): Lookup

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

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

    Permalink
    Definition Classes
    AnyRef

  14. def finalize(): Unit

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

  15. val foreignField: String

    Permalink

    the field from the documents in the from collection

  16. def formatted(fmtstr: String): String

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

  17. val from: String

    Permalink

    the collection to perform the join with

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

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. val localField: String

    Permalink

    the field from the documents input

  21. val makePipe: P.Document

    Permalink
    Definition Classes
    Lookup → PipelineOperator

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

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  26. final def wait(): Unit

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

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

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

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

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

  29. def →[B](y: B): (Lookup, B)

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PipelineOperator

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped