graph

Type Members

1. trait CypherQueryPlans extends AnyRef

   

2. trait CypherResult extends CypherPrintable

   

   Describes the result of executing a Cypher query.

   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.

3. trait CypherSession extends AnyRef

   

   The Cypher Session is the main API for a Cypher-based application.

   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.

4. final case class GraphName(value: String) extends AnyVal with Product with Serializable

   

   A graph name is used to address a specific graph within a Namespace and is used for lookups in the org.opencypher.okapi.api.graph.CypherSession.

   A graph name is used to address a specific graph within a Namespace and is used for lookups in the org.opencypher.okapi.api.graph.CypherSession.

   value

   string representing the graph name

5. trait GraphOperations extends AnyRef

   

   Inter-graph operations between org.opencypher.okapi.api.graph.PropertyGraphs.

6. final case class Namespace(value: String) extends AnyVal with Product with Serializable

   

   A namespace is used to address different org.opencypher.okapi.api.io.PropertyGraphDataSource implementations within a org.opencypher.okapi.api.graph.CypherSession.

   A namespace is used to address different org.opencypher.okapi.api.io.PropertyGraphDataSource implementations within a org.opencypher.okapi.api.graph.CypherSession.

   value

   string representing the namespace

7. trait PropertyGraph extends GraphOperations

   

   A Property Graph as defined by the openCypher Property Graph Model.

   A Property Graph as defined by the openCypher Property Graph Model.

   A graph is always tied to and managed by a session. The lifetime of a graph is bounded by the session lifetime.

   A graph always has a schema, which describes the properties of the entities in the graph, grouped by the labels and relationship types of the entities.

   See also

   openCypher Property Graph Model

8. case class QualifiedGraphName(namespace: Namespace, graphName: GraphName) extends Product with Serializable

   

   A qualified graph name is used in a Cypher query to address a specific graph within a namespace.

   A qualified graph name is used in a Cypher query to address a specific graph within a namespace.

   Example:

   FROM GRAPH AT 'myNamespace.myGraphName' MATCH (n) RETURN n

   Here, {{myNamespace.myGraphName}} represents a qualified graph name.

   namespace

   namespace part of the qualified graph name

   graphName

   graph name part of the qualified graph name