GraphLookup

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

Since: MongoDB 3.4

Linear Supertypes

Serializable, Serializable, Product, Equals, AggregationFramework.PipelineOperator, AnyRef, Any

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 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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from GraphLookup to any2stringadd[GraphLookup] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (GraphLookup, B)

Implicit information
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()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val as: String

the name of the array field added to each output document
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

the field name in other documents against which to match the value of the field specified by the connectFromField parameter
val depthField: Option[String]

an optional name for a field to add to each traversed document in the search path
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (GraphLookup) ⇒ Boolean): GraphLookup

Implicit information
This member is added by an implicit conversion from GraphLookup to Ensuring[GraphLookup] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): GraphLookup

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

the target collection for the $graphLookup operation to search
final def getClass(): Class[_]

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

Definition Classes
Any
val makePipe: P.Document

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

an optional non-negative integral number specifying the maximum recursion depth
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

an optional filter expression
val startWith: P.Value

the expression that specifies the value of the connectFromField with which to start the recursive search
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

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

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

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

Implicit information
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

Related Doc: package AggregationFramework

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

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)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (GraphLookup, B)

final def ==(arg0: Any): Boolean

val as: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val connectFromField: String

val connectToField: String

val depthField: Option[String]

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

def ensuring(cond: (GraphLookup) ⇒ Boolean): GraphLookup

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

def ensuring(cond: Boolean): GraphLookup

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

val from: String

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val makePipe: P.Document

val maxDepth: Option[Int]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val restrictSearchWithMatch: Option[P.Value]

val startWith: P.Value

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def →[B](y: B): (GraphLookup, B)

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 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