Class/Object

reactivemongo.api.commands.AggregationFramework

GraphLookup

Related Docs: object GraphLookup | package AggregationFramework

Permalink

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

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    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
  4. def ->[B](y: B): (GraphLookup, B)

    Permalink
    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()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. val as: String

    Permalink

    the name of the array field added to each output document

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

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

    Permalink

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

  10. val connectToField: String

    Permalink

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

  11. val depthField: Option[String]

    Permalink

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

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

    Permalink
    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
  13. def ensuring(cond: (GraphLookup) ⇒ Boolean): GraphLookup

    Permalink
    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
  14. def ensuring(cond: Boolean, msg: ⇒ Any): GraphLookup

    Permalink
    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
  15. def ensuring(cond: Boolean): GraphLookup

    Permalink
    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
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(that: Any): Boolean

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

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

    Permalink
    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()
  20. val from: String

    Permalink

    the target collection for the $graphLookup operation to search

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

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

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

    Permalink
    Definition Classes
    Any
  24. val makePipe: P.Document

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

    Permalink

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  29. def productArity: Int

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

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

    Permalink
    Definition Classes
    Product
  32. def productPrefix: String

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

    Permalink

    an optional filter expression

  34. val startWith: P.Value

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  36. def toString(): String

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

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

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

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

    Permalink
    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

Deprecated Value Members

  1. def _1: String

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

    (Since version 0.20.3) No longer a case class

  2. def _2: P.Value

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

    (Since version 0.20.3) No longer a case class

  3. def _3: String

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

    (Since version 0.20.3) No longer a case class

  4. def _4: String

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

    (Since version 0.20.3) No longer a case class

  5. def _5: String

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

    (Since version 0.20.3) No longer a case class

  6. def _6: Option[Int]

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

    (Since version 0.20.3) No longer a case class

  7. def _7: Option[String]

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

    (Since version 0.20.3) No longer a case class

  8. def _8: Option[P.Value]

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

    (Since version 0.20.3) No longer a case class

  9. def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    GraphLookup → Equals
    Annotations
    @deprecated
    Deprecated

    (Since version 0.20.3) No longer a case class

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