-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
🎉 New Destination: DynamoDB #5561
Merged
Merged
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
893338b
Added the DynamoDB destination connector.
jinnig 1974e66
Added auto-generated project files.
YQ-Wang b7a19d1
Added config related files and output table helper.
YQ-Wang 2cf22e8
Added document for DynamoDB destination.
jinnig dd8d582
Implemented DynamodbWriter.
qtz123 d8b4cef
Added DynamoDB in the SUMMARY.md.
qtz123 125203f
Merge branch 'master' into dynamodb-destination
jinnig 14954d5
Formatted code using ./gradlew format.
jinnig 843dcee
Added changelog to the doc.
qtz123 23fa643
Used PAY_PER_REQUEST instead of provisioned for DynamoDB.
YQ-Wang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
...esources/config/STANDARD_DESTINATION_DEFINITION/8ccd8909-4e99-4141-b48d-4984b70b2d89.json
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,7 @@ | ||
{ | ||
"destinationDefinitionId": "8ccd8909-4e99-4141-b48d-4984b70b2d89", | ||
"name": "DynamoDB", | ||
"dockerRepository": "airbyte/destination-dynamodb", | ||
"dockerImageTag": "0.1.0", | ||
"documentationUrl": "https://docs.airbyte.io/integrations/destinations/dynamodb" | ||
} |
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
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/destination-dynamodb/.dockerignore
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,3 @@ | ||
* | ||
!Dockerfile | ||
!build |
11 changes: 11 additions & 0 deletions
11
airbyte-integrations/connectors/destination-dynamodb/Dockerfile
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,11 @@ | ||
FROM airbyte/integration-base-java:dev | ||
|
||
WORKDIR /airbyte | ||
ENV APPLICATION destination-dynamodb | ||
|
||
COPY build/distributions/${APPLICATION}*.tar ${APPLICATION}.tar | ||
|
||
RUN tar xf ${APPLICATION}.tar --strip-components=1 | ||
|
||
LABEL io.airbyte.version=0.1.0 | ||
LABEL io.airbyte.name=airbyte/destination-dynamodb |
68 changes: 68 additions & 0 deletions
68
airbyte-integrations/connectors/destination-dynamodb/README.md
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,68 @@ | ||
# Destination Dynamodb | ||
|
||
This is the repository for the Dynamodb destination connector in Java. | ||
For information about how to use this connector within Airbyte, see [the User Documentation](https://docs.airbyte.io/integrations/destinations/dynamodb). | ||
|
||
## Local development | ||
|
||
#### Building via Gradle | ||
From the Airbyte repository root, run: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:destination-dynamodb:build | ||
``` | ||
|
||
#### Create credentials | ||
**If you are a community contributor**, generate the necessary credentials and place them in `secrets/config.json` conforming to the spec file in `src/main/resources/spec.json`. | ||
Note that the `secrets` directory is git-ignored by default, so there is no danger of accidentally checking in sensitive information. | ||
|
||
**If you are an Airbyte core member**, follow the [instructions](https://docs.airbyte.io/connector-development#using-credentials-in-ci) to set up the credentials. | ||
|
||
### Locally running the connector docker image | ||
|
||
#### Build | ||
Build the connector image via Gradle: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:destination-dynamodb:airbyteDocker | ||
``` | ||
When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in | ||
the Dockerfile. | ||
|
||
#### Run | ||
Then run any of the connector commands as follows: | ||
``` | ||
docker run --rm airbyte/destination-dynamodb:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-dynamodb:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-dynamodb:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-dynamodb:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
## Testing | ||
We use `JUnit` for Java tests. | ||
|
||
### Unit and Integration Tests | ||
Place unit tests under `src/test/io/airbyte/integrations/destinations/dynamodb`. | ||
|
||
#### Acceptance Tests | ||
Airbyte has a standard test suite that all destination connectors must pass. Implement the `TODO`s in | ||
`src/test-integration/java/io/airbyte/integrations/destinations/dynamodbDestinationAcceptanceTest.java`. | ||
|
||
### Using gradle to run tests | ||
All commands should be run from airbyte project root. | ||
To run unit tests: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:destination-dynamodb:unitTest | ||
``` | ||
To run acceptance and custom integration tests: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:destination-dynamodb:integrationTest | ||
``` | ||
|
||
## Dependency Management | ||
|
||
### Publishing a new version of the connector | ||
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what? | ||
1. Make sure your changes are passing unit and integration tests. | ||
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
1. Create a Pull Request. | ||
1. Pat yourself on the back for being an awesome contributor. | ||
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
21 changes: 21 additions & 0 deletions
21
airbyte-integrations/connectors/destination-dynamodb/build.gradle
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,21 @@ | ||
plugins { | ||
id 'application' | ||
id 'airbyte-docker' | ||
id 'airbyte-integration-test-java' | ||
} | ||
|
||
application { | ||
mainClass = 'io.airbyte.integrations.destination.dynamodb.DynamodbDestination' | ||
} | ||
|
||
dependencies { | ||
implementation project(':airbyte-config:models') | ||
implementation project(':airbyte-protocol:models') | ||
implementation project(':airbyte-integrations:bases:base-java') | ||
implementation project(':airbyte-integrations:connectors:destination-jdbc') | ||
implementation files(project(':airbyte-integrations:bases:base-java').airbyteDocker.outputs) | ||
implementation 'com.amazonaws:aws-java-sdk-dynamodb:1.12.47' | ||
|
||
integrationTestJavaImplementation project(':airbyte-integrations:bases:standard-destination-test') | ||
integrationTestJavaImplementation project(':airbyte-integrations:connectors:destination-dynamodb') | ||
} |
6 changes: 6 additions & 0 deletions
6
airbyte-integrations/connectors/destination-dynamodb/sample_secrets/config.json
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,6 @@ | ||
{ | ||
"dynamodb_table_name": "paste-table-name-here", | ||
"dynamodb_region": "paste-dynamodb-region-here", | ||
"access_key_id": "paste-access-key-id-here", | ||
"secret_access_key": "paste-secret-access-key-here" | ||
} |
100 changes: 100 additions & 0 deletions
100
...-dynamodb/src/main/java/io/airbyte/integrations/destination/dynamodb/DynamodbChecker.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,100 @@ | ||
/* | ||
* MIT License | ||
* | ||
* Copyright (c) 2020 Airbyte | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in all | ||
* copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package io.airbyte.integrations.destination.dynamodb; | ||
|
||
import com.amazonaws.ClientConfiguration; | ||
import com.amazonaws.auth.AWSStaticCredentialsProvider; | ||
import com.amazonaws.auth.BasicAWSCredentials; | ||
import com.amazonaws.client.builder.AwsClientBuilder; | ||
import com.amazonaws.services.dynamodbv2.AmazonDynamoDB; | ||
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder; | ||
import com.amazonaws.services.dynamodbv2.document.*; | ||
import com.amazonaws.services.dynamodbv2.model.*; | ||
import io.airbyte.integrations.base.JavaBaseConstants; | ||
import java.util.Arrays; | ||
import java.util.UUID; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
public class DynamodbChecker { | ||
|
||
private static final Logger LOGGER = LoggerFactory.getLogger(DynamodbChecker.class); | ||
|
||
public static void attemptDynamodbWriteAndDelete(DynamodbDestinationConfig dynamodbDestinationConfig) throws Exception { | ||
var prefix = dynamodbDestinationConfig.getTableName(); | ||
final String outputTableName = prefix + "_airbyte_connection_test_" + UUID.randomUUID().toString().replaceAll("-", ""); | ||
attemptWriteAndDeleteDynamodbItem(dynamodbDestinationConfig, outputTableName); | ||
} | ||
|
||
private static void attemptWriteAndDeleteDynamodbItem(DynamodbDestinationConfig dynamodbDestinationConfig, String outputTableName) | ||
throws Exception { | ||
DynamoDB dynamoDB = new DynamoDB(getAmazonDynamoDB(dynamodbDestinationConfig)); | ||
Table table = dynamoDB.createTable(outputTableName, // create table | ||
Arrays.asList(new KeySchemaElement(JavaBaseConstants.COLUMN_NAME_AB_ID, KeyType.HASH), new KeySchemaElement("sync_time", KeyType.RANGE)), | ||
Arrays.asList(new AttributeDefinition(JavaBaseConstants.COLUMN_NAME_AB_ID, ScalarAttributeType.S), | ||
new AttributeDefinition("sync_time", ScalarAttributeType.N)), | ||
new ProvisionedThroughput(1L, 1L)); | ||
table.waitForActive(); | ||
|
||
try { | ||
PutItemOutcome outcome = table | ||
.putItem( | ||
new Item().withPrimaryKey(JavaBaseConstants.COLUMN_NAME_AB_ID, UUID.randomUUID().toString(), "sync_time", System.currentTimeMillis())); | ||
} catch (Exception e) { | ||
LOGGER.error(e.getMessage()); | ||
} | ||
|
||
table.delete(); // delete table | ||
table.waitForDelete(); | ||
} | ||
|
||
public static AmazonDynamoDB getAmazonDynamoDB(DynamodbDestinationConfig dynamodbDestinationConfig) { | ||
var endpoint = dynamodbDestinationConfig.getEndpoint(); | ||
var region = dynamodbDestinationConfig.getRegion(); | ||
var accessKeyId = dynamodbDestinationConfig.getAccessKeyId(); | ||
var secretAccessKey = dynamodbDestinationConfig.getSecretAccessKey(); | ||
|
||
var awsCreds = new BasicAWSCredentials(accessKeyId, secretAccessKey); | ||
|
||
if (endpoint.isEmpty()) { | ||
return AmazonDynamoDBClientBuilder.standard() | ||
.withCredentials(new AWSStaticCredentialsProvider(awsCreds)) | ||
.withRegion(dynamodbDestinationConfig.getRegion()) | ||
.build(); | ||
|
||
} else { | ||
ClientConfiguration clientConfiguration = new ClientConfiguration(); | ||
clientConfiguration.setSignerOverride("AWSDynamodbSignerType"); | ||
|
||
return AmazonDynamoDBClientBuilder | ||
.standard() | ||
.withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration(endpoint, region)) | ||
.withClientConfiguration(clientConfiguration) | ||
.withCredentials(new AWSStaticCredentialsProvider(awsCreds)) | ||
.build(); | ||
} | ||
} | ||
|
||
} |
133 changes: 133 additions & 0 deletions
133
...dynamodb/src/main/java/io/airbyte/integrations/destination/dynamodb/DynamodbConsumer.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,133 @@ | ||
/* | ||
* MIT License | ||
* | ||
* Copyright (c) 2020 Airbyte | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to deal | ||
* in the Software without restriction, including without limitation the rights | ||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
* copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in all | ||
* copies or substantial portions of the Software. | ||
* | ||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
* SOFTWARE. | ||
*/ | ||
|
||
package io.airbyte.integrations.destination.dynamodb; | ||
|
||
import com.amazonaws.ClientConfiguration; | ||
import com.amazonaws.auth.AWSCredentials; | ||
import com.amazonaws.auth.AWSStaticCredentialsProvider; | ||
import com.amazonaws.auth.BasicAWSCredentials; | ||
import com.amazonaws.client.builder.AwsClientBuilder; | ||
import com.amazonaws.services.dynamodbv2.AmazonDynamoDB; | ||
import com.amazonaws.services.dynamodbv2.AmazonDynamoDBClientBuilder; | ||
import io.airbyte.commons.json.Jsons; | ||
import io.airbyte.integrations.base.AirbyteStreamNameNamespacePair; | ||
import io.airbyte.integrations.base.FailureTrackingAirbyteMessageConsumer; | ||
import io.airbyte.protocol.models.*; | ||
import java.util.*; | ||
import java.util.function.Consumer; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
public class DynamodbConsumer extends FailureTrackingAirbyteMessageConsumer { | ||
|
||
private static final Logger LOGGER = LoggerFactory.getLogger(DynamodbConsumer.class); | ||
|
||
private final DynamodbDestinationConfig dynamodbDestinationConfig; | ||
private final ConfiguredAirbyteCatalog configuredCatalog; | ||
private final Consumer<AirbyteMessage> outputRecordCollector; | ||
private final Map<AirbyteStreamNameNamespacePair, DynamodbWriter> streamNameAndNamespaceToWriters; | ||
|
||
private AirbyteMessage lastStateMessage = null; | ||
|
||
public DynamodbConsumer(DynamodbDestinationConfig dynamodbDestinationConfig, | ||
ConfiguredAirbyteCatalog configuredCatalog, | ||
Consumer<AirbyteMessage> outputRecordCollector) { | ||
this.dynamodbDestinationConfig = dynamodbDestinationConfig; | ||
this.configuredCatalog = configuredCatalog; | ||
this.outputRecordCollector = outputRecordCollector; | ||
this.streamNameAndNamespaceToWriters = new HashMap<>(configuredCatalog.getStreams().size()); | ||
} | ||
|
||
@Override | ||
protected void startTracked() throws Exception { | ||
|
||
var endpoint = dynamodbDestinationConfig.getEndpoint(); | ||
AWSCredentials awsCreds = new BasicAWSCredentials(dynamodbDestinationConfig.getAccessKeyId(), dynamodbDestinationConfig.getSecretAccessKey()); | ||
AmazonDynamoDB amazonDynamodb = null; | ||
|
||
if (endpoint.isEmpty()) { | ||
amazonDynamodb = AmazonDynamoDBClientBuilder.standard() | ||
.withCredentials(new AWSStaticCredentialsProvider(awsCreds)) | ||
.withRegion(dynamodbDestinationConfig.getRegion()) | ||
.build(); | ||
} else { | ||
ClientConfiguration clientConfiguration = new ClientConfiguration(); | ||
clientConfiguration.setSignerOverride("AWSDynamodbSignerType"); | ||
|
||
amazonDynamodb = AmazonDynamoDBClientBuilder | ||
.standard() | ||
.withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration(endpoint, dynamodbDestinationConfig.getRegion())) | ||
.withClientConfiguration(clientConfiguration) | ||
.withCredentials(new AWSStaticCredentialsProvider(awsCreds)) | ||
.build(); | ||
} | ||
|
||
var uploadTimestamp = System.currentTimeMillis(); | ||
|
||
for (ConfiguredAirbyteStream configuredStream : configuredCatalog.getStreams()) { | ||
var writer = new DynamodbWriter(dynamodbDestinationConfig, amazonDynamodb, configuredStream, uploadTimestamp); | ||
|
||
AirbyteStream stream = configuredStream.getStream(); | ||
AirbyteStreamNameNamespacePair streamNamePair = AirbyteStreamNameNamespacePair | ||
.fromAirbyteSteam(stream); | ||
streamNameAndNamespaceToWriters.put(streamNamePair, writer); | ||
} | ||
} | ||
|
||
@Override | ||
protected void acceptTracked(AirbyteMessage airbyteMessage) throws Exception { | ||
if (airbyteMessage.getType() == AirbyteMessage.Type.STATE) { | ||
this.lastStateMessage = airbyteMessage; | ||
return; | ||
} else if (airbyteMessage.getType() != AirbyteMessage.Type.RECORD) { | ||
return; | ||
} | ||
|
||
AirbyteRecordMessage recordMessage = airbyteMessage.getRecord(); | ||
AirbyteStreamNameNamespacePair pair = AirbyteStreamNameNamespacePair | ||
.fromRecordMessage(recordMessage); | ||
|
||
if (!streamNameAndNamespaceToWriters.containsKey(pair)) { | ||
throw new IllegalArgumentException( | ||
String.format( | ||
"Message contained record from a stream that was not in the catalog. \ncatalog: %s , \nmessage: %s", | ||
Jsons.serialize(configuredCatalog), Jsons.serialize(recordMessage))); | ||
} | ||
|
||
streamNameAndNamespaceToWriters.get(pair).write(UUID.randomUUID(), recordMessage); | ||
} | ||
|
||
@Override | ||
protected void close(boolean hasFailed) throws Exception { | ||
for (DynamodbWriter handler : streamNameAndNamespaceToWriters.values()) { | ||
handler.close(hasFailed); | ||
} | ||
// DynamoDB stream uploader is all or nothing if a failure happens in the destination. | ||
if (!hasFailed) { | ||
outputRecordCollector.accept(lastStateMessage); | ||
} | ||
} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jinnig Dynamodb is a key-value and document database. Using the primary key as a hash type means you're focusing this connector as a document database? Or a hash type PK using in key-value for Dynamodb is not a problem?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now we are just using DynamoDB as a document DB to store JSON objects. However, we have discussed this topic with Shrif - see how to use getPrimaryKey() to get a primary key. Do you think the other issues have been resolved in the last commit?