Class/Object

org.opencypher.spark.api

CAPSSession

Related Docs: object CAPSSession | package api

Permalink

sealed class CAPSSession extends RelationalCypherSession[DataFrameTable] with Serializable

Spark specific Cypher session implementation.

This class is the main entry point for working with the CAPS system. It wraps a SparkSession and allows running Cypher queries over a set of distributed Spark data frames.

Linear Supertypes
Serializable, Serializable, RelationalCypherSession[DataFrameTable], CypherSession, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CAPSSession
  2. Serializable
  3. Serializable
  4. RelationalCypherSession
  5. CypherSession
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CAPSSession(sparkSession: SparkSession)

    Permalink

    sparkSession

    The Spark session representing the cluster to execute on

Type Members

  1. abstract type Graph <: RelationalCypherGraph[DataFrameTable]

    Permalink
    Definition Classes
    RelationalCypherSession

  2. type Records = CAPSRecords

    Permalink
    Definition Classes
    CAPSSession → RelationalCypherSession

  3. type Result = RelationalCypherResult[DataFrameTable]

    Permalink
    Definition Classes
    CAPSSession → RelationalCypherSession → CypherSession

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. implicit val caps: CAPSSession

    Permalink
    Attributes
    protected

  6. lazy val catalog: CypherCatalog

    Permalink
    Definition Classes
    RelationalCypherSession → CypherSession

  7. def clone(): AnyRef

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

  8. def cypher(query: String, parameters: CypherMap, drivingTable: Option[CypherRecords], queryCatalog: Map[QualifiedGraphName, PropertyGraph]): CAPSSession.Result

    Permalink
    Definition Classes
    RelationalCypherSession → CypherSession

  9. def deregisterSource(namespace: Namespace): Unit

    Permalink
    Definition Classes
    CypherSession

  10. val entityTables: CAPSEntityTableFactory.type

    Permalink
    Definition Classes
    CAPSSession → RelationalCypherSession

  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. def generateQualifiedGraphName: QualifiedGraphName

    Permalink
    Definition Classes
    CypherSession

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

    Permalink
    Definition Classes
    AnyRef → Any

  16. val graphs: CAPSGraphFactory

    Permalink
    Definition Classes
    CAPSSession → RelationalCypherSession

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def logStageProgress(s: String, newLine: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  20. val logicalOptimizer: LogicalOptimizer.type

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  21. val logicalPlanner: LogicalPlanner

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

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

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. val parser: CypherParser

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  26. def planCypherQuery(graph: PropertyGraph, cypherQuery: CypherQuery, allParameters: CypherMap, inputFields: Set[Var], maybeDrivingTable: Option[RelationalCypherRecords[DataFrameTable]], queryLocalCatalog: QueryLocalCatalog): CAPSSession.Result

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  27. def planLogical(ir: CypherQuery, graph: PropertyGraph, inputFields: Set[Var]): LogicalOperator

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  28. def planRelational(maybeDrivingTable: Option[RelationalCypherRecords[DataFrameTable]], parameters: CypherMap, logicalPlan: LogicalOperator, queryLocalCatalog: QueryLocalCatalog): CAPSSession.Result

    Permalink
    Attributes
    protected
    Definition Classes
    RelationalCypherSession

  29. def readFrom[N <: Node, R <: Relationship](nodes: Seq[N], relationships: Seq[R] = Seq.empty)(implicit arg0: scala.reflect.api.JavaUniverse.TypeTag[N], arg1: scala.reflect.api.JavaUniverse.TypeTag[R]): PropertyGraph

    Permalink

    Reads a graph from sequences of nodes and relationships.

    Reads a graph from sequences of nodes and relationships.

    N

    node type implementing org.opencypher.spark.api.io.Node

    R

    relationship type implementing org.opencypher.spark.api.io.Relationship

    nodes

    sequence of nodes

    relationships

    sequence of relationships

    returns

    graph defined by the sequences

  30. def readFrom(tags: Set[Int], nodeTable: NodeTable[DataFrameTable], entityTables: EntityTable[DataFrameTable]*): PropertyGraph

    Permalink
    Definition Classes
    RelationalCypherSession

  31. def readFrom(nodeTable: NodeTable[DataFrameTable], entityTables: EntityTable[DataFrameTable]*): PropertyGraph

    Permalink
    Definition Classes
    RelationalCypherSession

  32. val records: CAPSRecordsFactory

    Permalink
    Definition Classes
    CAPSSession → RelationalCypherSession

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

    Permalink
    Definition Classes
    CypherSession

  34. val sparkSession: SparkSession

    Permalink

    The Spark session representing the cluster to execute on

  35. def sql(query: String): CAPSRecords

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  37. def toString(): String

    Permalink
    Definition Classes
    CypherSession → AnyRef → Any

  38. final def wait(): Unit

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from RelationalCypherSession[DataFrameTable]

Inherited from CypherSession

Inherited from AnyRef

Inherited from Any

Ungrouped