Package org.apache.iceberg.parquet

Class VariantWriterBuilder

java.lang.Object

org.apache.iceberg.parquet.ParquetVariantVisitor<ParquetValueWriter<?>>

org.apache.iceberg.parquet.VariantWriterBuilder

public class VariantWriterBuilder
extends ParquetVariantVisitor<ParquetValueWriter<?>>

Constructor Summary

Constructors

Constructor	Description
VariantWriterBuilder(org.apache.parquet.schema.MessageType schema, Iterable<String> basePath)

Method Summary

Modifier and Type	Method	Description
void	afterField(org.apache.parquet.schema.Type type)	Handler called after visiting any primitive or group type.
ParquetValueWriter<?>	array(org.apache.parquet.schema.GroupType array, ParquetValueWriter<?> valueWriter, ParquetValueWriter<?> elementWriter)	Handles a shredded array value result and an element value result.
void	beforeField(org.apache.parquet.schema.Type type)	Handler called before visiting any primitive or group type.
ParquetValueWriter<?>	metadata(org.apache.parquet.schema.PrimitiveType metadata)	Handles a serialized variant metadata column.
ParquetValueWriter<?>	object(org.apache.parquet.schema.GroupType object, ParquetValueWriter<?> valueWriter, List<ParquetValueWriter<?>> fieldWriters)	Handles a shredded object value result and a list of field value results.
ParquetValueWriter<?>	primitive(org.apache.parquet.schema.PrimitiveType primitive)	Handles a shredded primitive typed_value column.
ParquetValueWriter<?>	serialized(org.apache.parquet.schema.PrimitiveType value)	Handles a serialized variant value column.
ParquetValueWriter<?>	value(org.apache.parquet.schema.GroupType value, ParquetValueWriter<?> valueWriter, ParquetValueWriter<?> typedWriter)	Handles a variant value result and typed_value result pair.
ParquetValueWriter<?>	variant(org.apache.parquet.schema.GroupType variant, ParquetValueWriter<?> metadataWriter, ParquetValueWriter<?> valueWriter)	Handles the root variant column group.

Methods inherited from class org.apache.iceberg.parquet.ParquetVariantVisitor

visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VariantWriterBuilder

public VariantWriterBuilder(org.apache.parquet.schema.MessageType schema,
 Iterable<String> basePath)

Method Details

beforeField

public void beforeField(org.apache.parquet.schema.Type type)

Description copied from class: ParquetVariantVisitor

Handler called before visiting any primitive or group type.

Overrides:

beforeField in class ParquetVariantVisitor<ParquetValueWriter<?>>

afterField

public void afterField(org.apache.parquet.schema.Type type)

Description copied from class: ParquetVariantVisitor

Handler called after visiting any primitive or group type.

Overrides:

afterField in class ParquetVariantVisitor<ParquetValueWriter<?>>

variant

public ParquetValueWriter<?> variant(org.apache.parquet.schema.GroupType variant,
 ParquetValueWriter<?> metadataWriter,
 ParquetValueWriter<?> valueWriter)

Description copied from class: ParquetVariantVisitor

Handles the root variant column group.

The value and typed_value results are combined by calling ParquetVariantVisitor.value(org.apache.parquet.schema.GroupType, R, R).

   group v (VARIANT) { <-- metadata result and combined value and typed_value result
     required binary metadata;
     optional binary value;
     optional ... typed_value;
   }
 

Overrides:

variant in class ParquetVariantVisitor<ParquetValueWriter<?>>

metadata

public ParquetValueWriter<?> metadata(org.apache.parquet.schema.PrimitiveType metadata)

Description copied from class: ParquetVariantVisitor

Handles a serialized variant metadata column.

   group v (VARIANT) {
     required binary metadata; <-- this column
     optional binary value;
     optional ... typed_value;
   }
 

Overrides:

metadata in class ParquetVariantVisitor<ParquetValueWriter<?>>

serialized

public ParquetValueWriter<?> serialized(org.apache.parquet.schema.PrimitiveType value)

Description copied from class: ParquetVariantVisitor

Handles a serialized variant value column.

   group variant_value_pair {
     optional binary value; <-- this column
     optional ... typed_value;
   }
 

Overrides:

serialized in class ParquetVariantVisitor<ParquetValueWriter<?>>

primitive

public ParquetValueWriter<?> primitive(org.apache.parquet.schema.PrimitiveType primitive)

Description copied from class: ParquetVariantVisitor

Handles a shredded primitive typed_value column.

   group variant_value_pair {
     optional binary value;
     optional int32 typed_value; <-- this column when it is any primitive
   }
 

Overrides:

primitive in class ParquetVariantVisitor<ParquetValueWriter<?>>

value

public ParquetValueWriter<?> value(org.apache.parquet.schema.GroupType value,
 ParquetValueWriter<?> valueWriter,
 ParquetValueWriter<?> typedWriter)

Description copied from class: ParquetVariantVisitor

Handles a variant value result and typed_value result pair.

The value and typed_value pair may be nested in an object field, array element, or in the root group of a variant.

This method is also called when the typed_value field is missing.

   group variant_value_pair { <-- value result and typed_value result
     optional binary value;
     optional ... typed_value;
   }
 

Overrides:

value in class ParquetVariantVisitor<ParquetValueWriter<?>>

object

public ParquetValueWriter<?> object(org.apache.parquet.schema.GroupType object,
 ParquetValueWriter<?> valueWriter,
 List<ParquetValueWriter<?>> fieldWriters)

Description copied from class: ParquetVariantVisitor

Handles a shredded object value result and a list of field value results.

Each field's value and typed_value results are combined by calling ParquetVariantVisitor.value(org.apache.parquet.schema.GroupType, R, R).

   group variant_value_pair {  <-- value result and typed_value field results
     optional binary value;
     optional group typed_value {
       required group a {
         optional binary value;
         optional binary typed_value (UTF8);
       }
       ...
     }
   }
 

Overrides:

object in class ParquetVariantVisitor<ParquetValueWriter<?>>

array

public ParquetValueWriter<?> array(org.apache.parquet.schema.GroupType array,
 ParquetValueWriter<?> valueWriter,
 ParquetValueWriter<?> elementWriter)

Description copied from class: ParquetVariantVisitor

Handles a shredded array value result and an element value result.

The element's value and typed_value results are combined by calling ParquetVariantVisitor.value(org.apache.parquet.schema.GroupType, R, R).

   group variant_value_pair {  <-- value result and element result
     optional binary value;
     optional group typed_value (LIST) {
       repeated group list {
         required group element {
           optional binary value;
           optional binary typed_value (UTF8);
         }
       }
     }
   }
 

Overrides:

array in class ParquetVariantVisitor<ParquetValueWriter<?>>