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
connectFromFieldwith which to start the recursive search- connectFromField
the field name whose value
$graphLookupuses to recursively match against theconnectToFieldof other documents in the collection- connectToField
the field name in other documents against which to match the value of the field specified by the
connectFromFieldparameter- 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
- Alphabetic
- By Inheritance
- GraphLookup
- Serializable
- Product
- Equals
- PipelineOperator
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- 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
connectFromFieldwith which to start the recursive search- connectFromField
the field name whose value
$graphLookupuses to recursively match against theconnectToFieldof other documents in the collection- connectToField
the field name in other documents against which to match the value of the field specified by the
connectFromFieldparameter- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from GraphLookup toany2stringadd[GraphLookup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (GraphLookup, B)
- Implicit
- This member is added by an implicit conversion from GraphLookup toArrowAssoc[GraphLookup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val as: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val connectFromField: String
- val connectToField: String
- val depthField: Option[String]
- def ensuring(cond: (GraphLookup) => Boolean, msg: => Any): GraphLookup
- Implicit
- This member is added by an implicit conversion from GraphLookup toEnsuring[GraphLookup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (GraphLookup) => Boolean): GraphLookup
- Implicit
- This member is added by an implicit conversion from GraphLookup toEnsuring[GraphLookup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): GraphLookup
- Implicit
- This member is added by an implicit conversion from GraphLookup toEnsuring[GraphLookup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): GraphLookup
- Implicit
- This member is added by an implicit conversion from GraphLookup toEnsuring[GraphLookup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from GraphLookup toStringFormat[GraphLookup] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- val from: String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val makePipe: P.Document
- Definition Classes
- GraphLookup → PipelineOperator
- val maxDepth: Option[Int]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val restrictSearchWithMatch: Option[P.Value]
- val startWith: P.Value
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (GraphLookup, B)
- Implicit
- This member is added by an implicit conversion from GraphLookup toArrowAssoc[GraphLookup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.