io.debezium.converters

Class RecordParser

java.lang.Object

io.debezium.converters.RecordParser

Direct Known Subclasses:

RecordParser.MongodbRecordParser, RecordParser.MysqlRecordParser, RecordParser.PostgresRecordParser, RecordParser.SqlserverRecordParser

public abstract class RecordParser
extends Object

An abstract parser of change records. Callers create a concrete parser for a record and the parser's type is chosen by the connector type (e.g. mysql, postgresql, etc.) defined in change records. Fields and metadata of change records can be provided by RecordParser.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordParser.MongodbRecordParser Parser for records produced by MongoDB connectors.
static class	RecordParser.MysqlRecordParser Parser for records produced by MySQL connectors.
static class	RecordParser.PostgresRecordParser Parser for records produced by PostgreSQL connectors.
static class	RecordParser.SqlserverRecordParser Parser for records produced by Sql Server connectors.

Field Summary

Fields

Modifier and Type	Field and Description
private String	connectorType
private org.apache.kafka.connect.data.Schema	dataSchema
private String	op
private org.apache.kafka.connect.data.Schema	opSchema
private org.apache.kafka.connect.data.Struct	record
private org.apache.kafka.connect.data.Struct	source
(package private) static Set<String>	SOURCE_FIELDS
private org.apache.kafka.connect.data.Struct	transaction
private String	ts_ms
private org.apache.kafka.connect.data.Schema	ts_msSchema

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecordParser(org.apache.kafka.connect.data.Schema schema, org.apache.kafka.connect.data.Struct record, String... dataFields)

Method Summary

Modifier and Type	Method and Description
String	connectorType() Get the type of the connector which produced this record .
static RecordParser	create(org.apache.kafka.connect.data.Schema schema, Object value) Create a concrete parser of a change record for a specific connector type.
org.apache.kafka.connect.data.Struct	data() Get the value of the data field in the record; may not be null.
org.apache.kafka.connect.data.Schema	dataSchema() Get the schema of the data field in the record; may be not be null.
private static org.apache.kafka.connect.data.Schema	getDataSchema(org.apache.kafka.connect.data.Schema schema, String connectorType, String... fields)
abstract Object	getMetadata(String name) Search for metadata of the record by name, which are defined in the source field; throw a DataException if not found.
String	op() Get the value of the op field in the record.
org.apache.kafka.connect.data.Schema	opSchema() Get the schema of the op field in the record.
org.apache.kafka.connect.data.Struct	source() Get the value of the source field in the record.
org.apache.kafka.connect.data.Struct	transaction() Get the value of the transaction field in the record.
String	ts_ms() Get the value of the ts_ms field in the record.
org.apache.kafka.connect.data.Schema	ts_msSchema() Get the schema of the ts_ms field in the record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

record

private final org.apache.kafka.connect.data.Struct record

source

private final org.apache.kafka.connect.data.Struct source

transaction

private final org.apache.kafka.connect.data.Struct transaction

op

private final String op

opSchema

private final org.apache.kafka.connect.data.Schema opSchema

ts_ms

private final String ts_ms

ts_msSchema

private final org.apache.kafka.connect.data.Schema ts_msSchema

dataSchema

private final org.apache.kafka.connect.data.Schema dataSchema

connectorType

private final String connectorType

SOURCE_FIELDS

static final Set<String> SOURCE_FIELDS

Constructor Detail

RecordParser

protected RecordParser(org.apache.kafka.connect.data.Schema schema,
                       org.apache.kafka.connect.data.Struct record,
                       String... dataFields)

Method Detail

create

public static RecordParser create(org.apache.kafka.connect.data.Schema schema,
                                  Object value)

Create a concrete parser of a change record for a specific connector type.

Parameters:

schema - the schema of the record

value - the value of the record

Returns:

a concrete parser

getDataSchema

private static org.apache.kafka.connect.data.Schema getDataSchema(org.apache.kafka.connect.data.Schema schema,
                                                                  String connectorType,
                                                                  String... fields)

data

public org.apache.kafka.connect.data.Struct data()

Get the value of the data field in the record; may not be null.

source

public org.apache.kafka.connect.data.Struct source()

Get the value of the source field in the record.

Returns:

the value of the source field

transaction

public org.apache.kafka.connect.data.Struct transaction()

Get the value of the transaction field in the record.

Returns:

the value of the transaction field

op

public String op()

Get the value of the op field in the record.

Returns:

the value of the op field

opSchema

public org.apache.kafka.connect.data.Schema opSchema()

Get the schema of the op field in the record.

Returns:

the schema of the op field

ts_ms

public String ts_ms()

Get the value of the ts_ms field in the record.

Returns:

the value of the ts_ms field

ts_msSchema

public org.apache.kafka.connect.data.Schema ts_msSchema()

Get the schema of the ts_ms field in the record.

Returns:

the schema of the ts_ms field

dataSchema

public org.apache.kafka.connect.data.Schema dataSchema()

Get the schema of the data field in the record; may be not be null.

connectorType

public String connectorType()

Get the type of the connector which produced this record .

Returns:

the connector type

getMetadata

public abstract Object getMetadata(String name)

Search for metadata of the record by name, which are defined in the source field; throw a DataException if not found.

Returns:

metadata of the record