Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-18823][format] Support serialization for debezium-json format #13333

Merged
merged 3 commits into from Sep 10, 2020
Merged

[FLINK-18823][format] Support serialization for debezium-json format #13333

merged 3 commits into from Sep 10, 2020

Conversation

SteNicholas
Copy link
Member

What is the purpose of the change

Currently, debezium-json format only support deserialization, but not support serialization, which is not convenient for users to writing changelogs to an message queue. The serialization for debezium-json could follow the json strcuture of debezium, but should consider currently Flink can't combine UPDATE_BEFORE and UPDATE_AFTER into a single UPDATE message. This could encode UPDATE_BEFORE and UDPATE_AFTER as DELETE and INSERT debezium messages. Therefore, this could support serialization for debezium-json format

Brief change log

  • Add DebeziumJsonSerializationSchema which serialization schema from Flink Table/SQL internal data structure RowData to Debezium JSON.
  • DebeziumJsonFormatFactory supports createEncodingFormat with creating EncodingFormat for DebeziumJsonSerializationSchema.

Verifying this change

  • DebeziumJsonSerDeSchemaTest add test cases for DebeziumJsonSerializationSchema to verify the serialization schema to Debezium JSON.
  • DebeziumJsonFormatFactoryTest add test cases for creating DebeziumJsonSerializationSchema and DebeziumJsonDeserializationSchema to verify the serialization and deserialization schema for DebeziumJsonFormatFactory.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Sep 6, 2020

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit f5080f2 (Sun Sep 06 12:11:27 UTC 2020)

✅no warnings

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Sep 6, 2020

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build


@Override
public SerializationSchema<RowData> createRuntimeEncoder(
DynamicTableSink.Context context, DataType consumedDataType) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indent.

Comment on lines 45 to 46
private static final StringData OP_INSERT = StringData.fromString("INSERT"); // insert
private static final StringData OP_DELETE = StringData.fromString("DELETE"); // delete
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The insert and delete operation string in debezium should be "c" and "d".

@Override
public byte[] serialize(RowData rowData) {
try {
genericRowData.setField(0, rowData);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong. Debezium serialize insert data in "after", but delete data in "before".

// Debezium JSON contains some other information, e.g. "source", "ts_ms"
// but we don't need them.
return (RowType) DataTypes.ROW(
DataTypes.FIELD("after", databaseSchema),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong. Debezium serialize insert data in "after", but delete data in "before".

}

@Override
public byte[] serialize(RowData rowData) {
try {
genericRowData.setField(0, rowData);
genericRowData.setField(1, rowKind2String(rowData.getRowKind()));
if (RowKind.INSERT == rowData.getRowKind()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also consider UPDATE_AFTER and UPDATE_BEFORE .

Copy link
Member

@wuchong wuchong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updating. LGTM.

@wuchong wuchong merged commit db378c1 into apache:master Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants