org.apache.hudi.common.table.cdc

Enum HoodieCDCSupplementalLoggingMode

java.lang.Object

java.lang.Enum<HoodieCDCSupplementalLoggingMode>

org.apache.hudi.common.table.cdc.HoodieCDCSupplementalLoggingMode

All Implemented Interfaces:

Serializable, Comparable<HoodieCDCSupplementalLoggingMode>

@EnumDescription(value="Change log capture supplemental logging mode. The supplemental log is used for accelerating the generation of change log details.")
public enum HoodieCDCSupplementalLoggingMode
extends Enum<HoodieCDCSupplementalLoggingMode>

Change log capture supplemental logging mode. The supplemental log is used for accelerating the generation of change log details.

Three modes are supported:

• op_key_only: record keys, the reader needs to figure out the update before image and after image;
• data_before: before images, the reader needs to figure out the update after images;
• data_before_after: before and after images, the reader can generate the details directly from the log.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATA_BEFORE
DATA_BEFORE_AFTER
OP_KEY_ONLY

Method Summary

Modifier and Type	Method and Description
static HoodieCDCSupplementalLoggingMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static HoodieCDCSupplementalLoggingMode[]	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

OP_KEY_ONLY

@EnumFieldDescription(value="Only keeping record keys in the supplemental logs, so the reader needs to figure out the update before image and after image.")
public static final HoodieCDCSupplementalLoggingMode OP_KEY_ONLY

DATA_BEFORE

@EnumFieldDescription(value="Keeping the before images in the supplemental logs, so the reader needs to figure out the update after images.")
public static final HoodieCDCSupplementalLoggingMode DATA_BEFORE

DATA_BEFORE_AFTER

@EnumFieldDescription(value="Keeping the before and after images in the supplemental logs, so the reader can generate the details directly from the logs.")
public static final HoodieCDCSupplementalLoggingMode DATA_BEFORE_AFTER

Method Detail

values

public static HoodieCDCSupplementalLoggingMode[] 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 (HoodieCDCSupplementalLoggingMode c : HoodieCDCSupplementalLoggingMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static HoodieCDCSupplementalLoggingMode 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