Package org.apache.iceberg.parquet

Class Parquet.WriteBuilder

java.lang.Object

org.apache.iceberg.parquet.Parquet.WriteBuilder

All Implemented Interfaces:

InternalData.WriteBuilder

Enclosing class:

Parquet

public static class Parquet.WriteBuilder
extends Object
implements InternalData.WriteBuilder

Method Summary

Modifier and Type	Method	Description
<D> FileAppender<D>	build()	Build the configured FileAppender.
Parquet.WriteBuilder	createWriterFunc(BiFunction<Schema,org.apache.parquet.schema.MessageType,ParquetValueWriter<?>> newCreateWriterFunc)
Parquet.WriteBuilder	createWriterFunc(Function<org.apache.parquet.schema.MessageType,ParquetValueWriter<?>> newCreateWriterFunc)
Parquet.WriteBuilder	forTable(Table table)
Parquet.WriteBuilder	meta(String property, String value)	Set a file metadata property.
Parquet.WriteBuilder	metricsConfig(MetricsConfig newMetricsConfig)
Parquet.WriteBuilder	named(String newName)	Set the file schema's root name.
Parquet.WriteBuilder	overwrite()	Overwrite the file if it already exists.
Parquet.WriteBuilder	overwrite(boolean enabled)
Parquet.WriteBuilder	schema(Schema newSchema)	Set the file schema.
Parquet.WriteBuilder	set(String property, String value)	Set a writer configuration property.
Parquet.WriteBuilder	setAll(Map<String,String> properties)
Parquet.WriteBuilder	variantShreddingFunc(VariantShreddingFunction func)	Set a VariantShreddingFunction that is called with each variant field's name and field ID to produce the shredding type as a typed_value field.
Parquet.WriteBuilder	withAADPrefix(ByteBuffer aadPrefix)
Parquet.WriteBuilder	withFileEncryptionKey(ByteBuffer encryptionKey)
Parquet.WriteBuilder	writerVersion(org.apache.parquet.column.ParquetProperties.WriterVersion version)
Parquet.WriteBuilder	writeSupport(org.apache.parquet.hadoop.api.WriteSupport<?> newWriteSupport)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.InternalData.WriteBuilder

meta

Method Details

forTable

public Parquet.WriteBuilder forTable(Table table)

schema

public Parquet.WriteBuilder schema(Schema newSchema)

Description copied from interface: InternalData.WriteBuilder

Set the file schema.

Specified by:

schema in interface InternalData.WriteBuilder

variantShreddingFunc

public Parquet.WriteBuilder variantShreddingFunc(VariantShreddingFunction func)

Set a VariantShreddingFunction that is called with each variant field's name and field ID to produce the shredding type as a typed_value field. This field is added to the result variant struct alongside the metadata and value fields.

Parameters:

func - VariantShreddingFunction that produces a shredded typed_value

Returns:

this for method chaining

named

public Parquet.WriteBuilder named(String newName)

Description copied from interface: InternalData.WriteBuilder

Set the file schema's root name.

Specified by:

named in interface InternalData.WriteBuilder

writeSupport

public Parquet.WriteBuilder writeSupport(org.apache.parquet.hadoop.api.WriteSupport<?> newWriteSupport)

set

public Parquet.WriteBuilder set(String property,
 String value)

Description copied from interface: InternalData.WriteBuilder

Set a writer configuration property.

Write configuration affects writer behavior. To add file metadata properties, use InternalData.WriteBuilder.meta(String, String).

Specified by:

set in interface InternalData.WriteBuilder

Parameters:

property - a writer config property name

value - config value

Returns:

this for method chaining

setAll

public Parquet.WriteBuilder setAll(Map<String,String> properties)

meta

public Parquet.WriteBuilder meta(String property,
 String value)

Description copied from interface: InternalData.WriteBuilder

Set a file metadata property.

Metadata properties are written into file metadata. To alter a writer configuration property, use InternalData.WriteBuilder.set(String, String).

Specified by:

meta in interface InternalData.WriteBuilder

Parameters:

property - a file metadata property name

value - config value

Returns:

this for method chaining

createWriterFunc

public Parquet.WriteBuilder createWriterFunc(Function<org.apache.parquet.schema.MessageType,ParquetValueWriter<?>> newCreateWriterFunc)

createWriterFunc

public Parquet.WriteBuilder createWriterFunc(BiFunction<Schema,org.apache.parquet.schema.MessageType,ParquetValueWriter<?>> newCreateWriterFunc)

metricsConfig

public Parquet.WriteBuilder metricsConfig(MetricsConfig newMetricsConfig)

overwrite

public Parquet.WriteBuilder overwrite()

Description copied from interface: InternalData.WriteBuilder

Overwrite the file if it already exists.

Specified by:

overwrite in interface InternalData.WriteBuilder

overwrite

public Parquet.WriteBuilder overwrite(boolean enabled)

writerVersion

public Parquet.WriteBuilder writerVersion(org.apache.parquet.column.ParquetProperties.WriterVersion version)

withFileEncryptionKey

public Parquet.WriteBuilder withFileEncryptionKey(ByteBuffer encryptionKey)

withAADPrefix

public Parquet.WriteBuilder withAADPrefix(ByteBuffer aadPrefix)

build

public <D> FileAppender<D> build()
                          throws IOException

Description copied from interface: InternalData.WriteBuilder

Build the configured FileAppender.

Specified by:

build in interface InternalData.WriteBuilder

Throws:

IOException