pabloem commented on code in PR #24629: URL: https://github.com/apache/beam/pull/24629#discussion_r1053648178
########## sdks/java/io/debezium/src/main/java/org/apache/beam/io/debezium/DebeziumReadSchemaTransformProvider.java: ########## @@ -0,0 +1,216 @@ +/* + * 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.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; + +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 + 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) { + 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 + if (!Arrays.stream(Connectors.values()) + .map(Objects::toString) + .collect(Collectors.toSet()) + .contains(configuration.getDatabase())) { + throw new IllegalArgumentException( + "Unsupported dabase " + + configuration.getDatabase() + + ". Unable to select a JDBC driver for it. Supported Databases are: " + + String.join( + ", ", + Arrays.stream(Connectors.values()) + .map(Object::toString) + .collect(Collectors.toList()))); + } + 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 { Review Comment: thanks!I added a todo : ) ########## sdks/java/io/debezium/src/main/java/org/apache/beam/io/debezium/DebeziumReadSchemaTransformProvider.java: ########## @@ -0,0 +1,216 @@ +/* + * 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.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; + +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 + 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) { + 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 + if (!Arrays.stream(Connectors.values()) + .map(Objects::toString) + .collect(Collectors.toSet()) + .contains(configuration.getDatabase())) { + throw new IllegalArgumentException( + "Unsupported dabase " + + configuration.getDatabase() + + ". Unable to select a JDBC driver for it. Supported Databases are: " + + String.join( + ", ", + Arrays.stream(Connectors.values()) + .map(Object::toString) + .collect(Collectors.toList()))); + } + 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]; Review Comment: added a todo. Thanks Ahmed! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
