-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DebeziumIO schema transform (#24629)
* prototyping a debezium-based schema transform for continuous ingestion of change streams from databases * Writing a significant integration test for DebeziumIO SchemaTransformProvider * Improvements to debuggability, performance on expansion * fix tests. mysql integration test remaining * fixing and improving mysql test * Fix JdbcIO issue * add integration tests and reduce size for now * fixup * passing tests * Address comments * add comment
- Loading branch information
Showing
13 changed files
with
882 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
227 changes: 227 additions & 0 deletions
227
...bezium/src/main/java/org/apache/beam/io/debezium/DebeziumReadSchemaTransformProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,227 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.beam.io.debezium; | ||
|
|
||
| import com.google.auto.value.AutoValue; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
| import org.apache.beam.sdk.coders.RowCoder; | ||
| import org.apache.beam.sdk.schemas.Schema; | ||
| import org.apache.beam.sdk.schemas.transforms.SchemaTransform; | ||
| import org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider; | ||
| import org.apache.beam.sdk.transforms.PTransform; | ||
| import org.apache.beam.sdk.values.PCollectionRowTuple; | ||
| import org.apache.beam.sdk.values.Row; | ||
| import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; | ||
| import org.checkerframework.checker.initialization.qual.Initialized; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
| import org.checkerframework.checker.nullness.qual.Nullable; | ||
| import org.checkerframework.checker.nullness.qual.UnknownKeyFor; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * A schema-aware transform provider for {@link DebeziumIO}. This class provides a {@link | ||
| * PTransform} that returns a change stream for a relational database. | ||
| * | ||
| * <p>The transform needs to access the source database <b>on expansion</b> and at <b>pipeline | ||
| * runtime</b>. At expansion, the output {@link org.apache.beam.sdk.values.PCollection} schema is | ||
| * retrieved, while at runtime, the change stream is consumed. | ||
| * | ||
| * <p>This transform is tested against <b>MySQL and Postgres</b>, but it should work well for any | ||
| * data source supported by Debezium. | ||
| */ | ||
| public class DebeziumReadSchemaTransformProvider | ||
| extends TypedSchemaTransformProvider< | ||
| DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration> { | ||
|
|
||
| private static final Logger LOG = | ||
| LoggerFactory.getLogger(DebeziumReadSchemaTransformProvider.class); | ||
| private final Boolean isTest; | ||
| private final Integer testLimitRecords; | ||
| private final Long testLimitMilliseconds; | ||
|
|
||
| DebeziumReadSchemaTransformProvider() { | ||
| this(false, -1, Long.MAX_VALUE); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| protected DebeziumReadSchemaTransformProvider( | ||
| Boolean isTest, Integer recordLimit, Long timeLimitMs) { | ||
| this.isTest = isTest; | ||
| this.testLimitRecords = recordLimit; | ||
| this.testLimitMilliseconds = timeLimitMs; | ||
| } | ||
|
|
||
| @Override | ||
| protected @NonNull @Initialized Class<DebeziumReadSchemaTransformConfiguration> | ||
| configurationClass() { | ||
| return DebeziumReadSchemaTransformConfiguration.class; | ||
| } | ||
|
|
||
| @Override | ||
| protected @NonNull @Initialized SchemaTransform from( | ||
| DebeziumReadSchemaTransformConfiguration configuration) { | ||
| // TODO(pabloem): Validate configuration parameters to ensure formatting is correct. | ||
| return new SchemaTransform() { | ||
| @Override | ||
| public @UnknownKeyFor @NonNull @Initialized PTransform< | ||
| @UnknownKeyFor @NonNull @Initialized PCollectionRowTuple, | ||
| @UnknownKeyFor @NonNull @Initialized PCollectionRowTuple> | ||
| buildTransform() { | ||
| return new PTransform<PCollectionRowTuple, PCollectionRowTuple>() { | ||
| @Override | ||
| public PCollectionRowTuple expand(PCollectionRowTuple input) { | ||
| // TODO(pabloem): Test this behavior | ||
| Collection<String> connectors = | ||
| Arrays.stream(Connectors.values()) | ||
| .map(Object::toString) | ||
| .collect(Collectors.toSet()); | ||
| if (!connectors.contains(configuration.getDatabase())) { | ||
| throw new IllegalArgumentException( | ||
| "Unsupported database " | ||
| + configuration.getDatabase() | ||
| + ". Unable to select a JDBC driver for it. Supported Databases are: " | ||
| + String.join(", ", connectors)); | ||
| } | ||
| Class<?> connectorClass = | ||
| Objects.requireNonNull(Connectors.valueOf(configuration.getDatabase())) | ||
| .getConnector(); | ||
| DebeziumIO.ConnectorConfiguration connectorConfiguration = | ||
| DebeziumIO.ConnectorConfiguration.create() | ||
| .withUsername(configuration.getUsername()) | ||
| .withPassword(configuration.getPassword()) | ||
| .withHostName(configuration.getHost()) | ||
| .withPort(Integer.toString(configuration.getPort())) | ||
| .withConnectorClass(connectorClass); | ||
| connectorConfiguration = | ||
| connectorConfiguration | ||
| .withConnectionProperty("table.include.list", configuration.getTable()) | ||
| .withConnectionProperty("include.schema.changes", "false") | ||
| .withConnectionProperty("database.server.name", "beam-pipeline-server"); | ||
| if (configuration.getDatabase().equals("POSTGRES")) { | ||
| LOG.info( | ||
| "As Database is POSTGRES, we set the `database.dbname` property to {}.", | ||
| configuration.getTable().substring(0, configuration.getTable().indexOf("."))); | ||
| connectorConfiguration = | ||
| connectorConfiguration.withConnectionProperty( | ||
| "database.dbname", | ||
| configuration.getTable().substring(0, configuration.getTable().indexOf("."))); | ||
| } | ||
|
|
||
| final List<String> debeziumConnectionProperties = | ||
| configuration.getDebeziumConnectionProperties(); | ||
| if (debeziumConnectionProperties != null) { | ||
| for (String connectionProperty : debeziumConnectionProperties) { | ||
| String[] parts = connectionProperty.split("=", -1); | ||
| String key = parts[0]; | ||
| String value = parts[1]; | ||
| connectorConfiguration.withConnectionProperty(key, value); | ||
| } | ||
| } | ||
|
|
||
| DebeziumIO.Read<Row> readTransform = | ||
| DebeziumIO.<Row>read().withConnectorConfiguration(connectorConfiguration); | ||
|
|
||
| if (isTest) { | ||
| readTransform = | ||
| readTransform | ||
| .withMaxNumberOfRecords(testLimitRecords) | ||
| .withMaxTimeToRun(testLimitMilliseconds); | ||
| } | ||
|
|
||
| // TODO(pabloem): Database connection issues can be debugged here. | ||
| Schema recordSchema = readTransform.getRecordSchema(); | ||
| LOG.info( | ||
| "Computed schema for table {} from {}: {}", | ||
| configuration.getTable(), | ||
| configuration.getDatabase(), | ||
| recordSchema); | ||
| SourceRecordMapper<Row> formatFn = | ||
| KafkaConnectUtils.beamRowFromSourceRecordFn(recordSchema); | ||
| readTransform = | ||
| readTransform.withFormatFunction(formatFn).withCoder(RowCoder.of(recordSchema)); | ||
|
|
||
| return PCollectionRowTuple.of("output", input.getPipeline().apply(readTransform)); | ||
| } | ||
| }; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull @Initialized String identifier() { | ||
| return "beam:schematransform:org.apache.beam:debezium_read:v1"; | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull @Initialized List<@NonNull @Initialized String> inputCollectionNames() { | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| @Override | ||
| public @NonNull @Initialized List<@NonNull @Initialized String> outputCollectionNames() { | ||
| return Collections.singletonList("output"); | ||
| } | ||
|
|
||
| @AutoValue | ||
| public abstract static class DebeziumReadSchemaTransformConfiguration { | ||
| public abstract String getUsername(); | ||
|
|
||
| public abstract String getPassword(); | ||
|
|
||
| public abstract String getHost(); | ||
|
|
||
| public abstract Integer getPort(); | ||
|
|
||
| public abstract String getTable(); | ||
|
|
||
| public abstract @NonNull String getDatabase(); | ||
|
|
||
| public abstract @Nullable List<String> getDebeziumConnectionProperties(); | ||
|
|
||
| public static Builder builder() { | ||
| return new AutoValue_DebeziumReadSchemaTransformProvider_DebeziumReadSchemaTransformConfiguration | ||
| .Builder(); | ||
| } | ||
|
|
||
| @AutoValue.Builder | ||
| public abstract static class Builder { | ||
| public abstract Builder setUsername(String username); | ||
|
|
||
| public abstract Builder setPassword(String password); | ||
|
|
||
| public abstract Builder setHost(String host); | ||
|
|
||
| public abstract Builder setPort(Integer port); | ||
|
|
||
| public abstract Builder setDatabase(String database); | ||
|
|
||
| public abstract Builder setTable(String table); | ||
|
|
||
| public abstract Builder setDebeziumConnectionProperties( | ||
| List<String> debeziumConnectionProperties); | ||
|
|
||
| public abstract DebeziumReadSchemaTransformConfiguration build(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.