YuriGusev commented on code in PR #1: URL: https://github.com/apache/flink-connector-dynamodb/pull/1#discussion_r1003528260
########## flink-connector-dynamodb/src/main/java/org/apache/flink/streaming/connectors/dynamodb/sink/DynamoDbSinkBuilder.java: ########## @@ -0,0 +1,144 @@ +/* + * 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.streaming.connectors.dynamodb.sink; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.connector.base.sink.AsyncSinkBaseBuilder; +import org.apache.flink.connector.base.sink.writer.ElementConverter; + +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.Properties; + +/** + * Builder to construct {@link DynamoDbSink}. + * + * <p>The following example shows the minimum setup to create a {@link DynamoDbSink} that writes + * records into DynamoDb + * + * <pre>{@code + * private static class DummyDynamoDbElementConverter implements ElementConverter<String, DynamoDbWriteRequest> { + * + * @Override + * public DynamoDbWriteRequest apply(String s) { + * final Map<String, AttributeValue> item = new HashMap<>(); + * item.put("your-key", AttributeValue.builder().s(s).build()); + * return new DynamoDbWriteRequest( + * WriteRequest.builder() + * .putRequest(PutRequest.builder() + * .item(item) + * .build()) + * .build() + * ); + * } + * } + * DynamoDbSink<String> dynamoDbSink = DynamoDbSink.<String>builder() + * .setElementConverter(new DummyDynamoDbElementConverter()) + * .setDestinationTableName("your-table-name") + * .build(); + * }</pre> + * + * <p>If the following parameters are not set in this builder, the following defaults will be used: + * + * <ul> + * <li>{@code maxBatchSize} will be 25 + * <li>{@code maxInFlightRequests} will be 50 + * <li>{@code maxBufferedRequests} will be 10000 + * <li>{@code maxBatchSizeInBytes} will be 16 MB i.e. {@code 16 * 1000 * 1000} + * <li>{@code maxTimeInBufferMS} will be 5000ms + * <li>{@code maxRecordSizeInBytes} will be 400 KB i.e. {@code 400 * 1000} + * <li>{@code failOnError} will be false + * <li>{@code destinationTableName} destination table for the sink + * <li>{@code overwriteByPKeys} will be empty meaning no records deduplication will be performed + * by the batch sink + * </ul> + * + * @param <InputT> type of elements that should be persisted in the destination + */ +@PublicEvolving +public class DynamoDbSinkBuilder<InputT> + extends AsyncSinkBaseBuilder<InputT, DynamoDbWriteRequest, DynamoDbSinkBuilder<InputT>> { + + private static final int DEFAULT_MAX_BATCH_SIZE = 25; + private static final int DEFAULT_MAX_IN_FLIGHT_REQUESTS = 50; + private static final int DEFAULT_MAX_BUFFERED_REQUESTS = 10000; + private static final long DEFAULT_MAX_BATCH_SIZE_IN_B = 16 * 1000 * 1000; + private static final long DEFAULT_MAX_TIME_IN_BUFFER_MS = 5000; + private static final long DEFAULT_MAX_RECORD_SIZE_IN_B = 400 * 1000; + private static final boolean DEFAULT_FAIL_ON_ERROR = false; + + private boolean failOnError; + private Properties dynamodbClientProperties; + + private ElementConverter<InputT, DynamoDbWriteRequest> elementConverter; + private String tableName; + + private List<String> overwriteByPKeys; + + public DynamoDbSinkBuilder<InputT> setDynamoDbProperties(Properties properties) { + this.dynamodbClientProperties = properties; + return this; + } + + public DynamoDbSinkBuilder<InputT> setElementConverter( + ElementConverter<InputT, DynamoDbWriteRequest> elementConverter) { + this.elementConverter = elementConverter; + return this; + } + + /** Destination DynamoDB table name for the sink to write to. */ + public DynamoDbSinkBuilder<InputT> setDestinationTableName(String tableName) { + this.tableName = tableName; + return this; + } + + /** + * @param overwriteByPKeys provide partition key and (optionally) sort key name if you want to + * bypass no duplication limitation of single batch write request. Batching DynamoDB sink + * will drop request items in the buffer if their primary keys(composite) values are the + * same as newly added one. Review Comment: @dannycranmer do you think it is ok to keep this way or you would like to change the approach? -- 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
