RocMarshal commented on code in PR #78: URL: https://github.com/apache/flink-connector-jdbc/pull/78#discussion_r1441299767
########## flink-connector-jdbc/src/main/java/org/apache/flink/connector/jdbc/source/JdbcSourceBuilder.java: ########## @@ -0,0 +1,206 @@ +/* + * 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.flink.connector.jdbc.source; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.api.common.typeinfo.TypeInformation; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.connector.base.DeliveryGuarantee; +import org.apache.flink.connector.jdbc.JdbcConnectionOptions; +import org.apache.flink.connector.jdbc.internal.connection.JdbcConnectionProvider; +import org.apache.flink.connector.jdbc.internal.connection.SimpleJdbcConnectionProvider; +import org.apache.flink.connector.jdbc.source.enumerator.SqlTemplateSplitEnumerator; +import org.apache.flink.connector.jdbc.source.reader.extractor.ResultExtractor; +import org.apache.flink.connector.jdbc.split.JdbcParameterValuesProvider; +import org.apache.flink.util.Preconditions; +import org.apache.flink.util.StringUtils; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.annotation.Nonnull; + +import java.sql.ResultSet; + +import static org.apache.flink.connector.jdbc.source.JdbcSourceOptions.AUTO_COMMIT; +import static org.apache.flink.connector.jdbc.source.JdbcSourceOptions.READER_FETCH_BATCH_SIZE; +import static org.apache.flink.connector.jdbc.source.JdbcSourceOptions.RESULTSET_CONCURRENCY; +import static org.apache.flink.connector.jdbc.source.JdbcSourceOptions.RESULTSET_FETCH_SIZE; +import static org.apache.flink.connector.jdbc.source.JdbcSourceOptions.RESULTSET_TYPE; + +/** A tool is used to build {@link JdbcSource} quickly. */ +@PublicEvolving +public class JdbcSourceBuilder<OUT> { + + public static final Logger LOG = LoggerFactory.getLogger(JdbcSourceBuilder.class); + + private final Configuration configuration; + + private int splitReaderFetchBatchSize; + private int resultSetType; + private int resultSetConcurrency; + private int resultSetFetchSize; + // Boolean to distinguish between default value and explicitly set autoCommit mode. + private Boolean autoCommit; + + // TODO It would need a builder method to render after introducing streaming semantic. + private DeliveryGuarantee deliveryGuarantee; + + private TypeInformation<OUT> typeInformation; + + private final JdbcConnectionOptions.JdbcConnectionOptionsBuilder connOptionsBuilder; + private String sql; + private JdbcParameterValuesProvider jdbcParameterValuesProvider; + private ResultExtractor<OUT> resultExtractor; + + private JdbcConnectionProvider connectionProvider; + + JdbcSourceBuilder() { + this.configuration = new Configuration(); + this.connOptionsBuilder = new JdbcConnectionOptions.JdbcConnectionOptionsBuilder(); + this.splitReaderFetchBatchSize = 1024; + this.resultSetType = ResultSet.TYPE_FORWARD_ONLY; + this.resultSetConcurrency = ResultSet.CONCUR_READ_ONLY; + this.deliveryGuarantee = DeliveryGuarantee.NONE; + // Boolean to distinguish between default value and explicitly set autoCommit mode. + this.autoCommit = true; + } + + public JdbcSourceBuilder<OUT> setSql(@Nonnull String sql) { + Preconditions.checkArgument( + !StringUtils.isNullOrWhitespaceOnly(sql), "It's required to set the sql."); + this.sql = sql; + return this; + } + + public JdbcSourceBuilder<OUT> setResultExtractor(ResultExtractor<OUT> resultExtractor) { + this.resultExtractor = + Preconditions.checkNotNull(resultExtractor, "resultExtractor must not be null."); + return this; + } + + public JdbcSourceBuilder<OUT> setUsername(String username) { + Preconditions.checkArgument( + !StringUtils.isNullOrWhitespaceOnly(username), + "It's required to set the 'username'."); + connOptionsBuilder.withUsername(username); + return this; + } + + public JdbcSourceBuilder<OUT> setPassword(String password) { + connOptionsBuilder.withPassword(password); + return this; + } + + public JdbcSourceBuilder<OUT> setDriverName(String driverName) { + Preconditions.checkArgument( + !StringUtils.isNullOrWhitespaceOnly(driverName), + "It's required to set the 'driverName'."); + connOptionsBuilder.withDriverName(driverName); + return this; + } + + public JdbcSourceBuilder<OUT> setDBUrl(String dbURL) { + Preconditions.checkArgument( + !StringUtils.isNullOrWhitespaceOnly(dbURL), "It's required to set the 'dbURL'."); + connOptionsBuilder.withUrl(dbURL); + return this; + } + + public JdbcSourceBuilder<OUT> setTypeInformation( + @Nonnull TypeInformation<OUT> typeInformation) { + this.typeInformation = Preconditions.checkNotNull(typeInformation); + return this; + } + + // ------ Optional ------------------------------------------------------------------ + + public JdbcSourceBuilder<OUT> setJdbcParameterValuesProvider( + @Nonnull JdbcParameterValuesProvider parameterValuesProvider) { + this.jdbcParameterValuesProvider = Preconditions.checkNotNull(parameterValuesProvider); + return this; + } + + public JdbcSourceBuilder<OUT> setSplitReaderFetchBatchSize(int splitReaderFetchBatchSize) { + Preconditions.checkArgument( + splitReaderFetchBatchSize > 0, + "'splitReaderFetchBatchSize' must be in range (0, %s]", + Integer.MAX_VALUE); + this.splitReaderFetchBatchSize = splitReaderFetchBatchSize; + return this; + } + + public JdbcSourceBuilder<OUT> setResultSetType(int resultSetType) { + this.resultSetType = resultSetType; + return this; + } + + public JdbcSourceBuilder<OUT> setResultSetConcurrency(int resultSetConcurrency) { + this.resultSetConcurrency = resultSetConcurrency; + return this; + } + + public JdbcSourceBuilder<OUT> setAutoCommit(boolean autoCommit) { + this.autoCommit = autoCommit; + return this; + } + + public JdbcSourceBuilder<OUT> setResultSetFetchSize(int resultSetFetchSize) { + Preconditions.checkArgument( + resultSetFetchSize == Integer.MIN_VALUE || resultSetFetchSize > 0, + "Illegal value %s for fetchSize, has to be positive or Integer.MIN_VALUE.", + resultSetFetchSize); + this.resultSetFetchSize = resultSetFetchSize; + return this; + } + + public JdbcSourceBuilder<OUT> setConnectionProvider( + @Nonnull JdbcConnectionProvider connectionProvider) { + this.connectionProvider = Preconditions.checkNotNull(connectionProvider); + return this; + } + + public JdbcSource<OUT> build() { + this.connectionProvider = new SimpleJdbcConnectionProvider(connOptionsBuilder.build()); + if (resultSetFetchSize > 0) { + this.configuration.set(RESULTSET_FETCH_SIZE, resultSetFetchSize); + } + this.configuration.set(RESULTSET_CONCURRENCY, resultSetConcurrency); + this.configuration.set(RESULTSET_TYPE, resultSetType); + this.configuration.set(READER_FETCH_BATCH_SIZE, splitReaderFetchBatchSize); + this.configuration.set(AUTO_COMMIT, autoCommit); + + if (StringUtils.isNullOrWhitespaceOnly(sql)) { Review Comment: thx for the catching. And I'll add the test case like the followed for validating the line. ``` assertThatThrownBy(() -> JdbcSource.builder().setDBUrl(dbUrl).build()) .isInstanceOf(IllegalStateException.class); ``` -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
