Packages

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.

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, PropertyGroup, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VertexPropertyGroup
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PropertyGroup
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VertexPropertyGroup(name: String, data: DataFrame, primaryKeyColumn: String, applyMaskOnId: Boolean = true)

    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.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to any2stringadd[VertexPropertyGroup] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (VertexPropertyGroup, B)
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to ArrowAssoc[VertexPropertyGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val applyMaskOnId: Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. val data: DataFrame
    Definition Classes
    VertexPropertyGroup → PropertyGroup
  10. def ensuring(cond: (VertexPropertyGroup) ⇒ Boolean, msg: ⇒ Any): VertexPropertyGroup
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to Ensuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (VertexPropertyGroup) ⇒ Boolean): VertexPropertyGroup
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to Ensuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): VertexPropertyGroup
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to Ensuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): VertexPropertyGroup
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to Ensuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def getData(filter: Column): DataFrame

    Returns a filtered view of the data for the property group, with an optional mask applied to IDs.

    Returns a filtered view of the data for the property group, with an optional mask applied to IDs.

    filter

    A condition (Column) used to filter the data.

    returns

    A DataFrame containing the filtered and optionally transformed data.

    Attributes
    protected[graphframes]
    Definition Classes
    VertexPropertyGroup → PropertyGroup
  17. def getData(): DataFrame

    Returns a view of the data for the property group without applying any filter.

    Returns a view of the data for the property group without applying any filter.

    returns

    A DataFrame containing the raw data.

    Attributes
    protected[graphframes]
    Definition Classes
    PropertyGroup
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val name: String
    Definition Classes
    VertexPropertyGroup → PropertyGroup
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val primaryKeyColumn: String
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def validate(): VertexPropertyGroup.this.type
    Attributes
    protected
    Definition Classes
    VertexPropertyGroup → PropertyGroup
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def →[B](y: B): (VertexPropertyGroup, B)
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to ArrowAssoc[VertexPropertyGroup] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from VertexPropertyGroup to StringFormat[VertexPropertyGroup] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PropertyGroup

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from VertexPropertyGroup to any2stringadd[VertexPropertyGroup]

Inherited by implicit conversion StringFormat from VertexPropertyGroup to StringFormat[VertexPropertyGroup]

Inherited by implicit conversion Ensuring from VertexPropertyGroup to Ensuring[VertexPropertyGroup]

Inherited by implicit conversion ArrowAssoc from VertexPropertyGroup to ArrowAssoc[VertexPropertyGroup]

Ungrouped