Trait

org.opencypher.okapi.api.graph

CypherSession

Related Doc: package graph

Permalink

trait CypherSession extends AnyRef

The Cypher Session is the main API for a Cypher-based application. It manages graphs which can be queried using Cypher. Graphs can be read from / written to different data sources (e.g. CSV) and also stored in / retrieved from the session-local storage.

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

Abstract Value Members

  1. abstract def cypher(query: String, parameters: CypherMap = CypherMap.empty, drivingTable: Option[CypherRecords] = None): CypherResult

    Permalink

    Executes a Cypher query in this session on the current ambient graph.

    Executes a Cypher query in this session on the current ambient graph.

    query

    Cypher query to execute

    parameters

    parameters used by the Cypher query

    returns

    result of the query

  2. abstract def sessionNamespace: Namespace

    Permalink

    The org.opencypher.okapi.api.graph.Namespace used to to store graphs within this session.

    The org.opencypher.okapi.api.graph.Namespace used to to store graphs within this session.

    returns

    session namespace

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. def dataSource(namespace: Namespace): PropertyGraphDataSource

    Permalink

    Returns the org.opencypher.okapi.api.io.PropertyGraphDataSource that is registered under the given org.opencypher.okapi.api.graph.Namespace.

    Returns the org.opencypher.okapi.api.io.PropertyGraphDataSource that is registered under the given org.opencypher.okapi.api.graph.Namespace.

    namespace

    namespace for lookup

    returns

    property graph data source

  7. var dataSourceMapping: Map[Namespace, PropertyGraphDataSource]

    Permalink

    Stores a mutable mapping between a data source org.opencypher.okapi.api.graph.Namespace and the specific org.opencypher.okapi.api.io.PropertyGraphDataSource.

    Stores a mutable mapping between a data source org.opencypher.okapi.api.graph.Namespace and the specific org.opencypher.okapi.api.io.PropertyGraphDataSource.

    This mapping also holds the org.opencypher.okapi.impl.io.SessionPropertyGraphDataSource by default.

    Attributes
    protected

  8. def delete(qualifiedGraphName: QualifiedGraphName): Unit

    Permalink

    Removes the org.opencypher.okapi.api.graph.PropertyGraph with the given qualified name from the data source associated with the specified org.opencypher.okapi.api.graph.Namespace.

    Removes the org.opencypher.okapi.api.graph.PropertyGraph with the given qualified name from the data source associated with the specified org.opencypher.okapi.api.graph.Namespace.

    qualifiedGraphName

    qualified graph name

  9. def delete(graphName: GraphName): Unit

    Permalink

    Removes the org.opencypher.okapi.api.graph.PropertyGraph associated with the given name from the session-local storage.

    Removes the org.opencypher.okapi.api.graph.PropertyGraph associated with the given name from the session-local storage.

    graphName

    name of the graph within the session.

  10. def deregisterSource(namespace: Namespace): Unit

    Permalink

    De-registers a org.opencypher.okapi.api.io.PropertyGraphDataSource from the session by its given org.opencypher.okapi.api.graph.Namespace.

    De-registers a org.opencypher.okapi.api.io.PropertyGraphDataSource from the session by its given org.opencypher.okapi.api.graph.Namespace.

    namespace

    namespace for lookup

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    AnyRef → Any

  15. def graph(qualifiedGraphName: QualifiedGraphName): PropertyGraph

    Permalink

    Returns the org.opencypher.okapi.api.graph.PropertyGraph that is stored under the given org.opencypher.okapi.api.graph.QualifiedGraphName.

    Returns the org.opencypher.okapi.api.graph.PropertyGraph that is stored under the given org.opencypher.okapi.api.graph.QualifiedGraphName.

    qualifiedGraphName

    qualified graph name

    returns

    property graph

  16. def graph(graphName: GraphName): PropertyGraph

    Permalink

    Returns the org.opencypher.okapi.api.graph.PropertyGraph that is stored in session-local storage under the given org.opencypher.okapi.api.graph.GraphName.

    Returns the org.opencypher.okapi.api.graph.PropertyGraph that is stored in session-local storage under the given org.opencypher.okapi.api.graph.GraphName.

    graphName

    qualified graph name

    returns

    property graph

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def namespaces: Set[Namespace]

    Permalink

    Returns all org.opencypher.okapi.api.graph.Namespaces registered at this session.

    Returns all org.opencypher.okapi.api.graph.Namespaces registered at this session.

    returns

    registered namespaces

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def registerSource(namespace: Namespace, dataSource: PropertyGraphDataSource): Unit

    Permalink

    Register the given org.opencypher.okapi.api.io.PropertyGraphDataSource under the specific org.opencypher.okapi.api.graph.Namespace within this session.

    Register the given org.opencypher.okapi.api.io.PropertyGraphDataSource under the specific org.opencypher.okapi.api.graph.Namespace within this session.

    This enables a user to refer to that org.opencypher.okapi.api.io.PropertyGraphDataSource within a Cypher query.

    Note, that it is not allowed to overwrite an already registered org.opencypher.okapi.api.graph.Namespace. Use CypherSession#deregisterSource first.

    namespace

    namespace for lookup

    dataSource

    property graph data source

  24. def store(qualifiedGraphName: QualifiedGraphName, graph: PropertyGraph): Unit

    Permalink

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph using the org.opencypher.okapi.api.io.PropertyGraphDataSource registered under the org.opencypher.okapi.api.graph.Namespace of the specified org.opencypher.okapi.api.graph.QualifiedGraphName.

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph using the org.opencypher.okapi.api.io.PropertyGraphDataSource registered under the org.opencypher.okapi.api.graph.Namespace of the specified org.opencypher.okapi.api.graph.QualifiedGraphName.

    qualifiedGraphName

    qualified graph name

    graph

    property graph to store

  25. def store(graphName: GraphName, graph: PropertyGraph): QualifiedGraphName

    Permalink

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph to session-local storage under the given org.opencypher.okapi.api.graph.GraphName.

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph to session-local storage under the given org.opencypher.okapi.api.graph.GraphName. The specified graph will be accessible under the session-local naming scheme, e.g. session.graphName.

    graphName

    graph name

    graph

    property graph to store

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

    Permalink
    Definition Classes
    AnyRef

  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

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

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

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

  30. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped