Packages

c

org.opencypher.okapi.relational.api.graph

RelationalCypherSession

abstract class RelationalCypherSession[T <: Table[T]] extends CypherSession

Base class for relational back ends implementing the OKAPI pipeline.

The class provides a generic implementation of the necessary steps to execute a Cypher query on a relational back end including parsing, IR planning, logical planning and relational planning.

Implementers need to make sure to provide factories for back end specific record and graph implementations.

T

back end specific Table implementation

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

Instance Constructors

  1. new RelationalCypherSession()(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[T])

Type Members

  1. abstract type Records <: RelationalCypherRecords[T]

    Back end specific records type

  2. type Result = RelationalCypherResult[T]
    Definition Classes
    RelationalCypherSession → CypherSession

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val catalog: CypherCatalog
    Definition Classes
    RelationalCypherSession → CypherSession
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def cypher(query: String, parameters: CypherMap = CypherMap.empty, drivingTable: Option[CypherRecords] = None, queryCatalog: Map[QualifiedGraphName, PropertyGraph] = Map.empty): Result
    Definition Classes
    RelationalCypherSession → CypherSession
  8. def deregisterSource(namespace: Namespace): Unit
    Definition Classes
    CypherSession
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def generateQualifiedGraphName: QualifiedGraphName
    Definition Classes
    CypherSession
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def logStageProgress(s: String, newLine: Boolean = true): Unit
    Attributes
    protected
  17. val logicalOptimizer: LogicalOptimizer.type
    Attributes
    protected
  18. val logicalPlanner: LogicalPlanner
    Attributes
    protected
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val parser: CypherParser
    Attributes
    protected
  23. def planCypherQuery(graph: PropertyGraph, cypherQuery: CypherQuery, allParameters: CypherMap, inputFields: Set[Var], maybeDrivingTable: Option[RelationalCypherRecords[T]], queryLocalCatalog: QueryLocalCatalog): Result
    Attributes
    protected
  24. def planLogical(ir: CypherQuery, graph: PropertyGraph, inputFields: Set[Var], queryLocalCatalog: QueryLocalCatalog): LogicalOperator
    Attributes
    protected
  25. def planRelational(maybeDrivingTable: Option[RelationalCypherRecords[T]], parameters: CypherMap, logicalPlan: LogicalOperator, queryLocalCatalog: QueryLocalCatalog): Result
    Attributes
    protected
  26. def readFrom(nodeTable: ElementTable[T], elementTables: ElementTable[T]*): RelationalCypherGraph[T]

    Reads a graph from a sequence of element tables that contains at least one node table.

    Reads a graph from a sequence of element tables that contains at least one node table.

    nodeTable

    first parameter to guarantee there is at least one node table

    elementTables

    sequence of node and relationship tables defining the graph

    returns

    property graph

  27. def registerSource(namespace: Namespace, dataSource: PropertyGraphDataSource): Unit
    Definition Classes
    CypherSession
  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    CypherSession → AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from CypherSession

Inherited from AnyRef

Inherited from Any

Ungrouped