Trait

org.opencypher.okapi.api.io

PropertyGraphDataSource

Related Doc: package io

Permalink

trait PropertyGraphDataSource extends AnyRef

The Property Graph Data Source (PGDS) is used to read and write property graphs from and to an external storage (e.g., a database system, a file system or an memory-based collections of graph data).

The PGDS is the main interface for implementing custom data sources for specific openCypher implementations (e.g., for Apache Spark, etc.).

The (PGDS) is able to handle multiple property graphs and distinguishes between them using org.opencypher.okapi.api.graph.GraphNames. Furthermore, a PGDS can be registered at a org.opencypher.okapi.api.graph.CypherSession using a specific org.opencypher.okapi.api.graph.Namespace which enables accessing a org.opencypher.okapi.api.graph.PropertyGraph within a Cypher query.

Linear Supertypes
AnyRef, Any
Known Subclasses
SessionPropertyGraphDataSource
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PropertyGraphDataSource
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def delete(name: GraphName): Unit

    Permalink

    Deletes the org.opencypher.okapi.api.graph.PropertyGraph within the data source that is stored under the given org.opencypher.okapi.api.graph.GraphName.

    Deletes the org.opencypher.okapi.api.graph.PropertyGraph within the data source that is stored under the given org.opencypher.okapi.api.graph.GraphName.

    name

    name under which the graph is stored

  2. abstract def graph(name: GraphName): PropertyGraph

    Permalink

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

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

    name

    name of the graph within the data source

    returns

    property graph

  3. abstract def graphNames: Set[GraphName]

    Permalink

    Returns the org.opencypher.okapi.api.graph.GraphNames of all org.opencypher.okapi.api.graph.PropertyGraphs stored within the data source.

    Returns the org.opencypher.okapi.api.graph.GraphNames of all org.opencypher.okapi.api.graph.PropertyGraphs stored within the data source.

    returns

    names of stored graphs

  4. abstract def hasGraph(name: GraphName): Boolean

    Permalink

    Returns true if the data source stores a graph under the given org.opencypher.okapi.api.graph.GraphName.

    Returns true if the data source stores a graph under the given org.opencypher.okapi.api.graph.GraphName.

    name

    name of the graph within the data source

    returns

    true, iff the graph is stored within the data source

  5. abstract def schema(name: GraphName): Option[Schema]

    Permalink

    Returns the org.opencypher.okapi.api.schema.Schema of the graph that is stored under the given name.

    Returns the org.opencypher.okapi.api.schema.Schema of the graph that is stored under the given name.

    This method gives implementers the ability to efficiently retrieve a graph schema from the data source directly. For reasons of performance, it is highly recommended to make a schema available through this call. If an efficient retrieval is not possible, the call is typically forwarded to the graph using the org.opencypher.okapi.api.graph.PropertyGraph#schema call, which may require materialising the full graph.

    name

    name of the graph within the data source

    returns

    graph schema

  6. abstract def store(name: GraphName, graph: PropertyGraph): Unit

    Permalink

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph under the given org.opencypher.okapi.api.graph.GraphName within the data source.

    Stores the given org.opencypher.okapi.api.graph.PropertyGraph under the given org.opencypher.okapi.api.graph.GraphName within the data source.

    name

    name under which the graph shall be stored

    graph

    property graph

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 hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped