reactivemongo.api.commands.AggregationFramework

GraphLookup

class GraphLookup extends PipelineOperator with Product8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value]] with Serializable

The $graphLookup aggregation stage.

Since

MongoDB 3.4

Linear Supertypes
Serializable, Serializable, Product8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value]], Product, Equals, AggregationFramework.PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GraphLookup
  2. Serializable
  3. Serializable
  4. Product8
  5. Product
  6. Equals
  7. PipelineOperator
  8. AnyRef
  9. 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

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 equals(that: Any): Boolean

    Definition Classes
    GraphLookup → Equals → AnyRef → Any
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. 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()
  22. val from: String

    the target collection for the $graphLookup operation to search

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

    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Definition Classes
    GraphLookup → AnyRef → Any
    Annotations
    @inline()
  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. val makePipe: P.Document

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

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

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

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

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

    Definition Classes
    AnyRef
  31. def productArity: Int

    Definition Classes
    Product8 → Product
  32. def productElement(n: Int): Any

    Definition Classes
    Product8 → Product
    Annotations
    @throws( ... )
  33. def productIterator: Iterator[Any]

    Definition Classes
    Product
  34. def productPrefix: String

    Definition Classes
    Product
  35. val restrictSearchWithMatch: Option[P.Value]

    an optional filter expression

  36. val startWith: P.Value

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

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

    Definition Classes
    AnyRef
  38. def toString(): String

    Definition Classes
    GraphLookup → AnyRef → Any
  39. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. 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 _1: String

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  2. def _2: P.Value

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  3. def _3: String

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  4. def _4: String

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  5. def _5: String

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  6. def _6: Option[Int]

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  7. def _7: Option[String]

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  8. def _8: Option[P.Value]

    Definition Classes
    GraphLookup → Product8
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 0.20.3) No longer a case class

  9. def canEqual(that: Any): Boolean

    Definition Classes
    GraphLookup → Equals
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.3) No longer a case class

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

  11. 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 Product8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value]]

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