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

_Since MongoDB 3.4:_ The $graphLookup aggregation stage.

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

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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GraphLookup(from: String, startWith: P.Value, connectFromField: String, connectToField: String, as: String, maxDepth: Option[Int] = None, depthField: Option[String] = None, restrictSearchWithMatch: Option[P.Value] = 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: 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 GraphLookup to any2stringadd[GraphLookup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GraphLookup, B)
    Implicit
    This member is added by an implicit conversion from GraphLookup to ArrowAssoc[GraphLookup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val as: String
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. val connectFromField: String
  10. val connectToField: String
  11. val depthField: Option[String]
  12. def ensuring(cond: (GraphLookup) ⇒ Boolean, msg: ⇒ Any): GraphLookup
    Implicit
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (GraphLookup) ⇒ Boolean): GraphLookup
    Implicit
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): GraphLookup
    Implicit
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): GraphLookup
    Implicit
    This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GraphLookup to StringFormat[GraphLookup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. val from: String
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. val makePipe: P.Document
    Definition Classes
    GraphLookup → PipelineOperator
  23. val maxDepth: Option[Int]
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val restrictSearchWithMatch: Option[P.Value]
  28. val startWith: P.Value
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  33. def [B](y: B): (GraphLookup, B)
    Implicit
    This member is added by an implicit conversion from GraphLookup to ArrowAssoc[GraphLookup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped