Package org.apache.iceberg

Interface InternalData.WriteBuilder

All Known Implementing Classes:

Avro.WriteBuilder, Parquet.WriteBuilder

Enclosing class:

InternalData

public static interface InternalData.WriteBuilder

Method Summary

Modifier and Type	Method	Description
<D> FileAppender<D>	build()	Build the configured FileAppender.
InternalData.WriteBuilder	meta(String property, String value)	Set a file metadata property.
default InternalData.WriteBuilder	meta(Map<String,String> properties)	Set a file metadata properties from a Map.
InternalData.WriteBuilder	named(String name)	Set the file schema's root name.
InternalData.WriteBuilder	overwrite()	Overwrite the file if it already exists.
InternalData.WriteBuilder	schema(Schema schema)	Set the file schema.
InternalData.WriteBuilder	set(String property, String value)	Set a writer configuration property.

Method Details

schema

InternalData.WriteBuilder schema(Schema schema)

Set the file schema.

named

InternalData.WriteBuilder named(String name)

Set the file schema's root name.

set

InternalData.WriteBuilder set(String property,
 String value)

Set a writer configuration property.

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

Parameters:

property - a writer config property name

value - config value

Returns:

this for method chaining

meta

InternalData.WriteBuilder meta(String property,
 String value)

Set a file metadata property.

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

Parameters:

property - a file metadata property name

value - config value

Returns:

this for method chaining

meta

default InternalData.WriteBuilder meta(Map<String,String> properties)

Set a file metadata properties from a Map.

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

Parameters:

properties - a map of file metadata properties

Returns:

this for method chaining

overwrite

InternalData.WriteBuilder overwrite()

Overwrite the file if it already exists.

build

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

Build the configured FileAppender.

Throws:

IOException