Trait

org.opencypher.okapi.api.graph

CypherResult

Related Doc: package graph

Permalink

trait CypherResult extends CypherPrintable

Describes the result of executing a Cypher query.

The result of a Cypher query consists of a table of records and a set of named graphs.

Linear Supertypes
CypherPrintable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CypherResult
  2. CypherPrintable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def graph: Option[PropertyGraph]

    Permalink

    Retrieves the graph if one is returned by the query.

    Retrieves the graph if one is returned by the query. If the query returns a table, None is returned.

    returns

    a graph if the query returned one, None otherwise

  2. abstract def plans: CypherQueryPlans

    Permalink

    API for printable plans.

    API for printable plans. This is used for explaining the execution plan of a Cypher query.

  3. abstract def records: Option[CypherRecords]

    Permalink

    The table of records if one was returned by the query.

    The table of records if one was returned by the query. Returns None if the query returned a graph.

    returns

    a table of records, None otherwise.

  4. abstract def show(implicit options: PrintOptions): Unit

    Permalink
    Definition Classes
    CypherPrintable

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getGraph: PropertyGraph

    Permalink

    Retrieves the graph if one is returned by the query, otherwise an exception is thrown.

    Retrieves the graph if one is returned by the query, otherwise an exception is thrown.

    returns

    graph as returned by the query.

  11. def getRecords: CypherRecords

    Permalink

    The table of records if one was returned by the query, otherwise an exception is thrown.

    The table of records if one was returned by the query, otherwise an exception is thrown.

    returns

    a table of records.

  12. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. final def printTo(stream: PrintStream)(implicit options: PrintOptions): Unit

    Permalink
    Definition Classes
    CypherPrintable
  18. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CypherPrintable

Inherited from AnyRef

Inherited from Any

Ungrouped