Package org.apache.iceberg.avro

Class Avro.WriteBuilder

java.lang.Object

org.apache.iceberg.avro.Avro.WriteBuilder

All Implemented Interfaces:

InternalData.WriteBuilder

Enclosing class:

Avro

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

Method Summary

Modifier and Type	Method	Description
<D> FileAppender<D>	build()	Build the configured FileAppender.
Avro.WriteBuilder	createWriterFunc(Function<org.apache.avro.Schema,org.apache.avro.io.DatumWriter<?>> writerFunction)
Avro.WriteBuilder	forTable(Table table)
Avro.WriteBuilder	meta(String property, String value)	Set a file metadata property.
Avro.WriteBuilder	meta(Map<String,String> properties)	Set a file metadata properties from a Map.
Avro.WriteBuilder	metricsConfig(MetricsConfig newMetricsConfig)
Avro.WriteBuilder	named(String newName)	Set the file schema's root name.
Avro.WriteBuilder	overwrite()	Overwrite the file if it already exists.
Avro.WriteBuilder	overwrite(boolean enabled)
Avro.WriteBuilder	schema(Schema newSchema)	Set the file schema.
Avro.WriteBuilder	set(String property, String value)	Set a writer configuration property.
Avro.WriteBuilder	setAll(Map<String,String> properties)

Methods inherited from class java.lang.Object

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

Method Details

forTable

public Avro.WriteBuilder forTable(Table table)

schema

public Avro.WriteBuilder schema(Schema newSchema)

Description copied from interface: InternalData.WriteBuilder

Set the file schema.

Specified by:

schema in interface InternalData.WriteBuilder

named

public Avro.WriteBuilder named(String newName)

Description copied from interface: InternalData.WriteBuilder

Set the file schema's root name.

Specified by:

named in interface InternalData.WriteBuilder

createWriterFunc

public Avro.WriteBuilder createWriterFunc(Function<org.apache.avro.Schema,org.apache.avro.io.DatumWriter<?>> writerFunction)

set

public Avro.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 Avro.WriteBuilder setAll(Map<String,String> properties)

meta

public Avro.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

meta

public Avro.WriteBuilder meta(Map<String,String> properties)

Description copied from interface: InternalData.WriteBuilder

Set a file metadata properties from a Map.

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:

properties - a map of file metadata properties

Returns:

this for method chaining

metricsConfig

public Avro.WriteBuilder metricsConfig(MetricsConfig newMetricsConfig)

overwrite

public Avro.WriteBuilder overwrite()

Description copied from interface: InternalData.WriteBuilder

Overwrite the file if it already exists.

Specified by:

overwrite in interface InternalData.WriteBuilder

overwrite

public Avro.WriteBuilder overwrite(boolean enabled)

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