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:
- 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.
- Alphabetic
- By Inheritance
- VertexPropertyGroup
- Serializable
- Product
- Equals
- PropertyGroup
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toany2stringadd[VertexPropertyGroup] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (VertexPropertyGroup, B)
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toArrowAssoc[VertexPropertyGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val applyMaskOnId: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val data: DataFrame
- Definition Classes
- VertexPropertyGroup → PropertyGroup
- def ensuring(cond: (VertexPropertyGroup) => Boolean, msg: => Any): VertexPropertyGroup
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toEnsuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (VertexPropertyGroup) => Boolean): VertexPropertyGroup
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toEnsuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): VertexPropertyGroup
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toEnsuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): VertexPropertyGroup
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toEnsuring[VertexPropertyGroup] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- Definition Classes
- VertexPropertyGroup → PropertyGroup
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val primaryKeyColumn: String
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(): VertexPropertyGroup.this.type
- Attributes
- protected
- Definition Classes
- VertexPropertyGroup → PropertyGroup
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toStringFormat[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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (VertexPropertyGroup, B)
- Implicit
- This member is added by an implicit conversion from VertexPropertyGroup toArrowAssoc[VertexPropertyGroup] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.