org.apache.hudi.client.bootstrap

Enum BootstrapMode

java.lang.Object

java.lang.Enum<BootstrapMode>

org.apache.hudi.client.bootstrap.BootstrapMode

All Implemented Interfaces:

Serializable, Comparable<BootstrapMode>

@EnumDescription(value="Bootstrap mode for importing an existing table into Hudi")
public enum BootstrapMode
extends Enum<BootstrapMode>

Identifies different types of bootstrap.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL_RECORD In this mode, record level metadata is generated for each source record and both original record and metadata for each record copied.
METADATA_ONLY In this mode, record level metadata alone is generated for each source record and stored in new bootstrap location.

Method Summary

Modifier and Type	Method and Description
static BootstrapMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BootstrapMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULL_RECORD

@EnumFieldDescription(value="In this mode, the full record data is copied into hudi and metadata columns are added. A full record bootstrap is functionally equivalent to a bulk-insert. After a full record bootstrap, Hudi will function properly even if the original table is modified or deleted.")
public static final BootstrapMode FULL_RECORD

In this mode, record level metadata is generated for each source record and both original record and metadata for each record copied.

METADATA_ONLY

@EnumFieldDescription(value="In this mode, the full record data is not copied into Hudi therefore it avoids full cost of rewriting the dataset. Instead, \'skeleton\' files containing just the corresponding metadata columns are added to the Hudi table. Hudi relies on the data in the original table and will face data-loss or corruption if files in the original table location are deleted or modified.")
public static final BootstrapMode METADATA_ONLY

In this mode, record level metadata alone is generated for each source record and stored in new bootstrap location.

Method Detail

values

public static BootstrapMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BootstrapMode c : BootstrapMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BootstrapMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null