final class VariantAccessInfo extends Serializable
Variant access information that describes how variant fields are accessed in a query.
This class captures the information needed by data sources to optimize reading variant columns. Instead of reading the entire variant value, the data source can read only the fields that are actually accessed, represented as a structured schema.
For example, if a query accesses variant_get(v, '$.a', 'int') and
variant_get(v, '$.b', 'string'), the extracted schema would be
struct<0:int, 1:string> where field ordinals correspond to the access order.
- Annotations
- @Evolving()
- Source
- VariantAccessInfo.java
- Since
4.1.0
- Alphabetic
- By Inheritance
- VariantAccessInfo
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new VariantAccessInfo(columnName: String, extractedSchema: StructType)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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()
- def columnName(): String
Returns the name of the variant column.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(o: AnyRef): Boolean
- Definition Classes
- VariantAccessInfo → AnyRef → Any
- Annotations
- @Override()
- def extractedSchema(): StructType
Returns the schema representing fields extracted from the variant column.
Returns the schema representing fields extracted from the variant column.
The schema structure is:
- Field names: Typically ordinals ("0", "1", "2", ...) representing access order
- Field types: The target data type for each field extraction
- Field metadata: Contains variant-specific information such as JSON path, timezone, and error handling mode
Data sources should use this schema to determine what fields to extract from the variant and what types they should be converted to.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- VariantAccessInfo → AnyRef → Any
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- VariantAccessInfo → AnyRef → Any
- Annotations
- @Override()
- 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)