reactivemongo.api.commands.AggregationFramework

GraphLookup

case class GraphLookup(from: String, startWith: P.Value, connectFromField: String, connectToField: String, as: String, maxDepth: Option[Int] = scala.None, depthField: Option[String] = scala.None, restrictSearchWithMatch: Option[P.Value] = scala.None) extends PipelineOperator with Product with Serializable

The $graphLookup aggregation stage (since MongoDB 3.4)

from

the target collection for the $graphLookup operation to search

startWith

the expression that specifies the value of the connectFromField with which to start the recursive search

connectFromField

the field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection

connectToField

the field name in other documents against which to match the value of the field specified by the connectFromField parameter

as

the name of the array field added to each output document

maxDepth

an optional non-negative integral number specifying the maximum recursion depth

depthField

an optional name for a field to add to each traversed document in the search path

restrictSearchWithMatch

an optional filter expression

Linear Supertypes
Serializable, Serializable, Product, Equals, AggregationFramework.PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GraphLookup
  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 GraphLookup(from: String, startWith: P.Value, connectFromField: String, connectToField: String, as: String, maxDepth: Option[Int] = scala.None, depthField: Option[String] = scala.None, restrictSearchWithMatch: Option[P.Value] = scala.None)

    from

    the target collection for the $graphLookup operation to search

    startWith

    the expression that specifies the value of the connectFromField with which to start the recursive search

    connectFromField

    the field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection

    connectToField

    the field name in other documents against which to match the value of the field specified by the connectFromField parameter

    as

    the name of the array field added to each output document

    maxDepth

    an optional non-negative integral number specifying the maximum recursion depth

    depthField

    an optional name for a field to add to each traversed document in the search path

    restrictSearchWithMatch

    an optional filter expression

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 GraphLookup to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (GraphLookup, B)

    Implicit information
    This member is added by an implicit conversion from GraphLookup to ArrowAssoc[GraphLookup] 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. val as: String

    the name of the array field added to each output document

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. val connectFromField: String

    the field name whose value $graphLookup uses to recursively match against the connectToField of other documents in the collection

  12. val connectToField: String

    the field name in other documents against which to match the value of the field specified by the connectFromField parameter

  13. val depthField: Option[String]

    an optional name for a field to add to each traversed document in the search path

  14. def ensuring(cond: (GraphLookup) ⇒ Boolean, msg: ⇒ Any): GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: (GraphLookup) ⇒ Boolean): GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean, msg: ⇒ Any): GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean): GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def formatted(fmtstr: String): String

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

    the target collection for the $graphLookup operation to search

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

    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. val makePipe: P.Document

    Definition Classes
    GraphLookup → PipelineOperator
  25. val maxDepth: Option[Int]

    an optional non-negative integral number specifying the maximum recursion depth

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

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. val restrictSearchWithMatch: Option[P.Value]

    an optional filter expression

  30. val startWith: P.Value

    the expression that specifies the value of the connectFromField with which to start the recursive search

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

    Definition Classes
    AnyRef
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (GraphLookup, B)

    Implicit information
    This member is added by an implicit conversion from GraphLookup to ArrowAssoc[GraphLookup] 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 GraphLookup 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:
    (graphLookup: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GraphLookup 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:
    (graphLookup: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to ArrowAssoc[GraphLookup] 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:
    (graphLookup: ArrowAssoc[GraphLookup]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GraphLookup

    Implicit information
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] 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:
    (graphLookup: Ensuring[GraphLookup]).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 GraphLookup to StringAdd

Inherited by implicit conversion any2stringfmt from GraphLookup to StringFormat

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

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

Ungrouped