Type Members

1.  case class EdgePropertyGroup extends PropertyGroup with Product with Serializable

   Represents a logical group of edges in a property graph with associated metadata and data.

   Represents a logical group of edges in a property graph with associated metadata and data.

   EdgePropertyGroup encapsulates edge data stored in a DataFrame along with metadata describing how to interpret the data as graph edges. Each edge group has:

   • A unique name identifier
   • DataFrame containing the actual edge data
   • Source and destination vertex property groups
   • Direction flag indicating if edges are directed or undirected
   • Column names specifying source vertex, destination vertex and edge weight columns

   The class validates that required columns exist in the provided DataFrame on creation. Required columns are:

   • Source vertex column
   • Destination vertex column
   • Weight column

   Note

   When edges from different groups are combined into a GraphFrame, their SRCs and DSTs are hashed with the group name to prevent collisions in the same way as ID of the corresponded vertex group is hashed.

2.  trait PropertyGroup extends AnyRef
3.  case class VertexPropertyGroup(name: String, data: DataFrame, primaryKeyColumn: String, applyMaskOnId: Boolean = true) extends PropertyGroup with Product with Serializable

   Represents a logical group of vertices in a property graph with associated data and identification.

   Represents a logical group of vertices in a property graph with associated data and identification.

   A VertexPropertyGroup is used to organize and manage vertices that share common characteristics or belong to the same logical group within a property graph. Each group maintains its own data in the form of a DataFrame and uses a primary key column for unique vertex identification.

   The class provides two ways to create a vertex property group:

   1. With a specified primary key column:

   VertexPropertyGroup("users", userDataFrame, "userId")

   2. With the default primary key column ("id"):

   VertexPropertyGroup("users", userDataFrame)

   name

   The unique identifier for this vertex property group

   data

   The DataFrame containing the vertex data

   primaryKeyColumn

   The column name used to uniquely identify vertices in this group

   applyMaskOnId

   A flag indicating whether to apply masking on vertex IDs. When false, uses raw IDs from primaryKeyColumn. When true, hashes IDs with group name. Defaults to true.

   Note

   When vertices from different groups are combined into a GraphFrame, their IDs are hashed with the group name to prevent collisions.