Class/Object

com.datastax.bdp.graph.spark.graphframe.dsedb

CoreDseGraphFrame

Related Docs: object CoreDseGraphFrame | package dsedb

Permalink

class CoreDseGraphFrame extends DseGraphFrame

Linear Supertypes
DseGraphFrame, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CoreDseGraphFrame
  2. DseGraphFrame
  3. Serializable
  4. Serializable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CoreDseGraphFrame(graphFrame: GraphFrame, graphKeyspace: GraphKeyspace, name: Option[String] = None, graphOptions: Map[String, String] = Map.empty)

    Permalink

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. def E(edgesIds: AnyRef*): DseGraphTraversal[Edge]

    Permalink

    Return graph traversal that supports a subset of TinkerPop3 traversal steps

    Return graph traversal that supports a subset of TinkerPop3 traversal steps

    edgesIds

    to start traverse with

    returns

    GraphTraversal[Edge] for the filtered graph

    Definition Classes
    DseGraphFrame
    Annotations
    @varargs()
  5. def E: DseGraphTraversal[Edge]

    Permalink

    Return graph traversal that supports a subset of TinkerPop3 traversal steps

    Return graph traversal that supports a subset of TinkerPop3 traversal steps

    returns

    GraphTraversal[Edge] for the graph

    Definition Classes
    DseGraphFrame
  6. def V(vertexIds: AnyRef*): DseGraphTraversal[Vertex]

    Permalink

    Return graph traversal that supports subset of TinkerPop3 traversal steps

    Return graph traversal that supports subset of TinkerPop3 traversal steps

    vertexIds

    to start traverse with

    returns

    GraphTraversal[Vertex] for the filtered graph

    Definition Classes
    DseGraphFrame
    Annotations
    @varargs()
  7. def V: DseGraphTraversal[Vertex]

    Permalink

    Return graph traversal that supports subset of TinkerPop3 traversal steps

    Return graph traversal that supports subset of TinkerPop3 traversal steps

    returns

    GraphTraversal[Vertex] for the graph

    Definition Classes
    DseGraphFrame
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def cache(): CoreDseGraphFrame.this.type

    Permalink

    proxy call to gf.cache()

    proxy call to gf.cache()

    returns

    this

    Definition Classes
    DseGraphFrame
  10. def cleanUp: String

    Permalink

    Remove any invalid edge entries from the database backend.

    Remove any invalid edge entries from the database backend.

    Definition Classes
    DseGraphFrame
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val clusterName: String

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  13. lazy val connector: CassandraConnector

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  14. val connectorOptions: Map[String, String]

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  15. def deleteEdgeProperties(df: DataFrame, properties: String*): Unit

    Permalink

    clean edges properties

    clean edges properties

    properties

    delete only selected properties not entire row

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  16. def deleteEdgeProperties(df: DataFrame, properties: Array[String]): Unit

    Permalink
  17. def deleteEdges(df: DataFrame, cache: Boolean = true): Unit

    Permalink

    delete graph edges.

    delete graph edges. 4 id columns should be passed to the method

    +--------------------+--------------------+-------+--------------------+
    |                 src|                 dst| ~label|                  id|
    +--------------------+--------------------+-------+--------------------+
    |god:THxdAAAAAAAAAAAA|titan:J474AAAAAAA...| father|da0a9900-8fe1-11e...|
    +--------------------+--------------------+-------+--------------------+
    df

    data frame with edge ids: src,dst,~label, id

    cache

    cache df before processing, true by default for consistence updates. two C* entries need to be deleted for one edge, so no reloads expected between this two calls.

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  18. def deleteEdges(df: DataFrame): Unit

    Permalink

    shortcut for deleteEdges(df: DataFrame, cache: Boolean = true) for Java

    shortcut for deleteEdges(df: DataFrame, cache: Boolean = true) for Java

    Definition Classes
    DseGraphFrame
  19. def deleteVertexProperties(df: DataFrame, properties: Seq[String], labels: Seq[String] = Seq.empty, cache: Boolean = true): Unit

    Permalink

    clean vertex properties with meta properties

    clean vertex properties with meta properties

    properties

    property names to delete

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  20. def deleteVertexProperties(df: DataFrame, properties: String*): Unit

    Permalink

    clean vertex properties with meta properties

    clean vertex properties with meta properties

    properties

    property names to delete

    Definition Classes
    DseGraphFrame
    Annotations
    @varargs()
  21. def deleteVertices(label: String): Unit

    Permalink

    delete all vertices with given label

    delete all vertices with given label

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  22. def deleteVertices(df: DataFrame, labels: Seq[String] = Seq.empty, cache: Boolean = true): Unit

    Permalink

    df

    should contains "id" column to delete

    labels

    (optional) speed up deletion by providing list of affected labels

    cache

    true by default. the df will be cached before processing.

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  23. def dropIsolatedVertices(): DseGraphFrame

    Permalink

    proxy call to gf.dropIsolatedVertices()

    proxy call to gf.dropIsolatedVertices()

    returns

    new filtered DseGraphFrame

    Definition Classes
    DseGraphFrame
  24. var dseGraphName: Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  25. lazy val edgeIdColumnNames: Seq[String]

    Permalink
    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  26. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  28. def filterEdges(conditionExpr: String): DseGraphFrame

    Permalink

    proxy call to gf.filterEdges()

    proxy call to gf.filterEdges()

    returns

    new filtered DseGraphFrame

    Definition Classes
    DseGraphFrame
  29. def filterEdges(condition: Column): DseGraphFrame

    Permalink

    proxy call to gf.filterEdges()

    proxy call to gf.filterEdges()

    returns

    new filtered DseGraphFrame

    Definition Classes
    DseGraphFrame
  30. def filterVertices(conditionExpr: String): DseGraphFrame

    Permalink

    proxy call to gf.filterVertices()

    proxy call to gf.filterVertices()

    returns

    new filtered DseGraphFrame

    Definition Classes
    DseGraphFrame
  31. def filterVertices(condition: Column): DseGraphFrame

    Permalink

    proxy call to gf.filterVertices()

    proxy call to gf.filterVertices()

    returns

    new filtered DseGraphFrame

    Definition Classes
    DseGraphFrame
  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  34. def getEdgeLabelFromSchema(outVertexLabel: String, edgeLabel: String, inVertexLabel: String): EdgeLabel

    Permalink
  35. val gf: GraphFrame

    Permalink
    Definition Classes
    DseGraphFrame
  36. val graphKeyspace: GraphKeyspace

    Permalink
  37. def graphName: String

    Permalink

    Returns the graph name of this DseGraphFrame.

    Returns the graph name of this DseGraphFrame.

    Definition Classes
    DseGraphFrame
    Exceptions thrown

    NoSuchElementException if the graph name is not set.

  38. val graphOptions: Map[String, String]

    Permalink
    Definition Classes
    DseGraphFrame
  39. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  40. def idColumn(labelColumn: Column, idColumns: Column*): Column

    Permalink

    Utility method to generate GraphFrame compatible ids, if a mixed set of labels is in the DF.

    Utility method to generate GraphFrame compatible ids, if a mixed set of labels is in the DF. It is slower than idColumn(label: String, idColumns: Column*): Column The id is added automatically when vertex is inserted, if inserted columns has the same names as in graph schema It is not possible for edges as you need to point both src and dst ids. Usage:

    val updateEdgeDF = sourceDF.select(
      gf.idColumn(col("srcLabel"), col("srcId")) as "src",
      gf.idColumn(col("dstLabel"), col("dstId")) as "dst",
      col("label") as "~label",
      gf.randomEdgeIdColumn,
      col("property"))
    
    gf.updateEdges(updateEdgeDF)

    If different labels have different id format use case statement to sort them:

    when(col("srcLabel") === "1format", col("src1Id")).when(col("srcLabel") === "2format", col("src2Id")).otherwise(col("src3Id")) as "src"
    Definition Classes
    CoreDseGraphFrameDseGraphFrame
    Annotations
    @varargs()
  41. def idColumn(label: String, idColumns: Column*): Column

    Permalink

    Utility method to generate GraphFrame compatible ids.

    Utility method to generate GraphFrame compatible ids. The id is added automatically when vertex is inserted, if inserted columns has the same names as in graph schema It is not possible for edges as you need to point both src and dst ids. Usage:

    val updateEdgeDF = sourceDF.select(
      gf.idColumn("srcLabel", col("srcId")) as "src",
      gf.idColumn("dstLabel", col("dstId")) as "dst",
      col("label") as "~label",
      gf.randomEdgeIdColumn,
      col("property"))
    
    gf.updateEdges(updateEdgeDF)
    Definition Classes
    CoreDseGraphFrameDseGraphFrame
    Annotations
    @varargs()
  42. def io(url: String): DseGraphTraversal[Vertex]

    Permalink

    Performs a read or write based operation on the Graph backing this GraphTraversalSource.

    Performs a read or write based operation on the Graph backing this GraphTraversalSource. This step can be accompanied by the Object) modulator for further configuration and must be accompanied by a GraphTraversal#read() or GraphTraversal#write() modulator step which will terminate the traversal.

    url

    the url of file in distributed file system or JDBC connection or the name of file in default file system for which the read or write will apply - note that the context of how this parameter is used is wholly dependent on the implementation. i.e cassandra read/writer implementation will ignore this path and read table name from parameters.

    returns

    the traversal with the { @link IoStep} added

    Definition Classes
    DseGraphFrame
  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  44. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. def persist(storageLevel: StorageLevel): CoreDseGraphFrame.this.type

    Permalink

    proxy call to gf.persist()

    proxy call to gf.persist()

    returns

    this

    Definition Classes
    DseGraphFrame
  48. def persist(): CoreDseGraphFrame.this.type

    Permalink

    proxy call to gf.persist()

    proxy call to gf.persist()

    returns

    this

    Definition Classes
    DseGraphFrame
  49. lazy val spark: SparkSession

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  50. lazy val sqlContext: SQLContext

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame
  51. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  52. def toExternalEdgeId(label: String, srcId: String, dstId: String, ids: Seq[Any], schema: StructType): AnyRef

    Permalink

    label

    Edge label

    srcId

    Source vertex id

    dstId

    Destination vertex id

    ids

    Edge ids

    schema

    Associated DataFrame schema

    returns

    External ID object

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  53. def toExternalVertexId(id: String): AnyRef

    Permalink

    id

    String of vertex ID in the form "label:columnData:checkSum(data)"

    returns

    External ID object

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  55. def unpersist(blocking: Boolean): CoreDseGraphFrame.this.type

    Permalink

    proxy call to gf.unpersist()

    proxy call to gf.unpersist()

    returns

    this

    Definition Classes
    DseGraphFrame
  56. def unpersist(): CoreDseGraphFrame.this.type

    Permalink

    proxy call to gf.unpersist()

    proxy call to gf.unpersist()

    returns

    this

    Definition Classes
    DseGraphFrame
  57. def updateEdges(outVertexLabel: String, edgeLabel: String, inVertexLabel: String, df: DataFrame): Unit

    Permalink

    Update or insert edges.

    Update or insert edges. Edge id column names should be the same as in the underlying DSE-DB table.

    For example, suppose we have the following edge label definition (Core Graph)

    schema.edgeLabel('created')
      .ifNotExists()
      .from('person').to('software')
      .property('weight', Double)
      .create()

    with the corresponding CQL table definition

    CREATE TABLE test.person__created__software (
      person_name text,
      person_ssn text,
      person_age int,
      software_name text,
      software_version text,
      software_lang text,
      weight double,
      PRIMARY KEY ((person_name, person_ssn), person_age, software_name, software_version, software_lang)
    ) WITH CLUSTERING ORDER BY (person_age ASC, software_name ASC, software_version ASC, software_lang ASC)

    In this example, we have "person" and "software" vertex labels (not shown) that are connected with a "created" edge label.

    Edge updates can be carried out like this

    scala> g.updateEdges("person", "created", "software", createdDF)

    where the dataframe has the following column names, note they match the corresponding DSE-DB edge table column names

    scala> createdDF.show
    +-----------+-----------+----------+-------------+----------------+-------------+------+
    |person_name| person_ssn|person_age|software_name|software_version|software_lang|weight|
    +-----------+-----------+----------+-------------+----------------+-------------+------+
    |      rocco|111-11-1111|        21|         chat|             1.0|        scala|   2.0|
    +-----------+-----------+----------+-------------+----------------+-------------+------+

    Note: The dataframe is not cached by this function. The dataframe should be persisted by the user if a dynamic data source is used.

    df

    data frame with edge ids and update columns

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  58. def updateEdges(df: DataFrame, cache: Boolean = true): Unit

    Permalink

    update this graph edges.

    update this graph edges. the minimal df schema is: 4 id columns and at least one property to update

    +--------------------+--------------------+-------+--------------------+-------------------+
    |                 src|                 dst| ~label|                  id|               prop|
    +--------------------+--------------------+-------+--------------------+-------------------+
    |god:THxdAAAAAAAAAAAA|titan:J474AAAAAAA...| father|da0a9900-8fe1-11e...|              value|
    +--------------------+--------------------+-------+--------------------+-------------------+

    if ID column is not present it will be generated and edges will be saved as new.

    df

    data frame with edge ids and update columns

    cache

    cache df before processing, true by default for consistence updates. two C* entries need to be updated for one edge, so no reloads expected between this two calls.

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  59. def updateEdges(df: DataFrame): Unit

    Permalink

    shortcut for updateEdges(df: DataFrame, cache: Boolean = true) for Java

    shortcut for updateEdges(df: DataFrame, cache: Boolean = true) for Java

    Definition Classes
    DseGraphFrame
  60. def updateVertices(vertexLabel: String, df: DataFrame): Unit

    Permalink

    update this graph vertices with properties provided in the df.

    update this graph vertices with properties provided in the df. you should provide id in non encoded format

    +-----------------+---------+---------+
    |     community_id|member_id|      age|
    +-----------------+---------+---------+
    |       1182054400|        0|        0|
    +-----------------+---------+---------+

    the df is not cached by the function.

    vertexLabel

    to update

    df

    dataframe with vertex id and update columns

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  61. def updateVertices(df: DataFrame, labels: Seq[String] = Seq.empty, cache: Boolean = true): Unit

    Permalink

    update this graph vertices with properties provided in the df.

    update this graph vertices with properties provided in the df. the minimal df schema is just vertex "id" and one property to update:

    +-----------------+---------+
    |               id|      age|
    +-----------------+---------+
    |god:AAAAATMAAA...|        0|
    +-----------------+---------+

    label and vertices id will be extracted from the graph frame id. for better performance it is recommended to add/leave "~label" column

    +-----------------+---------+---------+
    |               id|   ~label|      age|
    +-----------------+---------+---------+
    |god:AAAAATMAAA...|      god|        0|
    +-----------------+---------+---------+

    you can also provide id in non encoded format

    +-----------------+---------+---------+---------+
    |     community_id|member_id|   ~label|      age|
    +-----------------+---------+---------+---------+
    |       1182054400|        0|      god|        0|
    +-----------------+---------+---------+---------+

    Note: passing both synthetic "id" and vertex Id columns is an error.

    df

    dataframe with vertex id and update columns

    labels

    empty (means all) by default, it is convenient to group vertexes with the same id format. That group could be passed here, to reduce number of verification steps

    cache

    cache df before processing, true by default for consistence update and performance

    Definition Classes
    CoreDseGraphFrameDseGraphFrame
  62. def updateVertices(df: DataFrame): Unit

    Permalink

    shortcut for updateVertices(df: DataFrame, labels: Seq[String] = Seq.empty, cache: Boolean = true) for Java API

    shortcut for updateVertices(df: DataFrame, labels: Seq[String] = Seq.empty, cache: Boolean = true) for Java API

    df

    dataframe with vertex id and update columns

    Definition Classes
    DseGraphFrame
  63. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. def withCachedDf[T](df: DataFrame, cache: Boolean)(code: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    DseGraphFrame

Inherited from DseGraphFrame

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped