io.delta.standalone.actions

Class Metadata

Object

io.delta.standalone.actions.Metadata

All Implemented Interfaces:

Action

public final class Metadata
extends Object
implements Action

Updates the metadata of the table. The first version of a table must contain a Metadata action. Subsequent Metadata actions completely overwrite the current metadata of the table. It is the responsibility of the writer to ensure that any data already present in the table is still valid after any change. There can be at most one Metadata action in a given version of the table.

See Also:

Delta Transaction Log Protocol: Change Metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Builder Builder class for Metadata.

Constructor Summary

Constructors

Constructor and Description
Metadata(String id, String name, String description, Format format, java.util.List<String> partitionColumns, java.util.Map<String,String> configuration, java.util.Optional<Long> createdTime, StructType schema)

Method Summary

Modifier and Type	Method and Description
static Metadata.Builder	builder()
Metadata.Builder	copyBuilder()
boolean	equals(Object o)
java.util.Map<String,String>	getConfiguration()
java.util.Optional<Long>	getCreatedTime()
String	getDescription()
Format	getFormat()
String	getId()
String	getName()
java.util.List<String>	getPartitionColumns()
StructType	getSchema()
int	hashCode()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Metadata

public Metadata(@Nonnull
                String id,
                @Nullable
                String name,
                @Nullable
                String description,
                @Nonnull
                Format format,
                @Nonnull
                java.util.List<String> partitionColumns,
                @Nonnull
                java.util.Map<String,String> configuration,
                @Nonnull
                java.util.Optional<Long> createdTime,
                @Nullable
                StructType schema)

Method Detail

getId

@Nonnull
public String getId()

Returns:

the unique identifier for this table

getName

@Nullable
public String getName()

Returns:

the user-provided identifier for this table

getDescription

@Nullable
public String getDescription()

Returns:

the user-provided description for this table

getFormat

@Nonnull
public Format getFormat()

Returns:

the Format for this table

getPartitionColumns

@Nonnull
public java.util.List<String> getPartitionColumns()

Returns:

an unmodifiable java.util.List containing the names of columns by which the data should be partitioned

getConfiguration

@Nonnull
public java.util.Map<String,String> getConfiguration()

Returns:

an unmodifiable java.util.Map containing configuration options for this metadata

getCreatedTime

@Nonnull
public java.util.Optional<Long> getCreatedTime()

Returns:

the time when this metadata action was created, in milliseconds since the Unix epoch

getSchema

@Nullable
public StructType getSchema()

Returns:

the schema of the table as a StructType

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copyBuilder

public Metadata.Builder copyBuilder()

Returns:

a new Metadata.Builder initialized with the same properties as this Metadata instance

builder

public static Metadata.Builder builder()

Returns:

a new Metadata.Builder