Trait

org.opencypher.okapi.api.graph

PropertyGraph

Related Doc: package graph

Permalink

trait PropertyGraph extends GraphOperations

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

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

Abstract Value Members

  1. abstract def nodes(name: String, nodeCypherType: CTNode = CTNode): CypherRecords

    Permalink

    Returns all nodes in this graph with the given org.opencypher.okapi.api.types.CTNode type.

    Returns all nodes in this graph with the given org.opencypher.okapi.api.types.CTNode type.

    name

    field name for the returned nodes

    nodeCypherType

    node type used for selection

    returns

    table of nodes of the specified type

  2. abstract def relationships(name: String, relCypherType: CTRelationship = CTRelationship): CypherRecords

    Permalink

    Returns all relationships in this graph with the given org.opencypher.okapi.api.types.CTRelationship type.

    Returns all relationships in this graph with the given org.opencypher.okapi.api.types.CTRelationship type.

    name

    field name for the returned relationships

    relCypherType

    relationship type used for selection

    returns

    table of relationships of the specified type

  3. abstract def schema: Schema

    Permalink

    The schema that describes this graph.

    The schema that describes this graph.

    returns

    the schema of this graph.

  4. abstract def session: CypherSession

    Permalink

    The session in which this graph is managed.

    The session in which this graph is managed.

    returns

    the session of this graph.

  5. abstract def union(other: PropertyGraph): PropertyGraph

    Permalink

    Constructs the union of this graph and the argument graph.

    Constructs the union of this graph and the argument graph. Note that the argument graph has to be managed by the same session as this graph.

    other

    argument graph with which to union

    returns

    union of this and the argument graph

    Definition Classes
    GraphOperations

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 cypher(query: String, parameters: CypherMap = CypherMap.empty, drivingTable: Option[CypherRecords] = None): CypherResult

    Permalink

    Executes a Cypher query in the session that manages this graph, using this graph as the input graph.

    Executes a Cypher query in the session that manages this graph, using this graph as the input graph.

    query

    Cypher query to execute

    parameters

    parameters used by the Cypher query

    returns

    result of the query.

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

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

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

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

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

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

Inherited from GraphOperations

Inherited from AnyRef

Inherited from Any

Ungrouped