Package org.apache.flink.cdc.connectors.mongodb.table

Enum MongoDBReadableMetadata

java.lang.Object

java.lang.Enum<MongoDBReadableMetadata>

org.apache.flink.cdc.connectors.mongodb.table.MongoDBReadableMetadata

All Implemented Interfaces:

Serializable, Comparable<MongoDBReadableMetadata>

public enum MongoDBReadableMetadata
extends Enum<MongoDBReadableMetadata>

Defines the supported metadata columns for MongoDBTableSource.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COLLECTION	Name of the collection that contain the row.
DATABASE	Name of the database that contain the row.
OP_TS	It indicates the time that the change was made in the database.
ROW_KIND	It indicates the row kind of the changelog.

Method Summary

Modifier and Type	Method	Description
MetadataConverter	getConverter()
org.apache.flink.table.types.DataType	getDataType()
String	getKey()
static MongoDBReadableMetadata	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MongoDBReadableMetadata[]	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

COLLECTION

public static final MongoDBReadableMetadata COLLECTION

Name of the collection that contain the row.

DATABASE

public static final MongoDBReadableMetadata DATABASE

Name of the database that contain the row.

OP_TS

public static final MongoDBReadableMetadata OP_TS

It indicates the time that the change was made in the database. If the record is read from snapshot of the table instead of the change stream, the value is always 0.

ROW_KIND

public static final MongoDBReadableMetadata ROW_KIND

It indicates the row kind of the changelog. '+I' means INSERT message, '-D' means DELETE message, '-U' means UPDATE_BEFORE message and '+U' means UPDATE_AFTER message

Method Detail

values

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

Returns:

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

valueOf

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

getKey

public String getKey()

getDataType

public org.apache.flink.table.types.DataType getDataType()

getConverter

public MetadataConverter getConverter()