Skip to content
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: Cassandra #7186

Merged
merged 12 commits into from
Nov 5, 2021
Merged

🎉 New destination: Cassandra #7186

merged 12 commits into from
Nov 5, 2021

Conversation

itaseskii
Copy link
Contributor

@itaseskii itaseskii commented Oct 19, 2021

What

The MR adds new destination connector for Apache Cassandra

How

Using the Java Datastax driver https://docs.datastax.com/en/developer/java-driver/4.13/

Recommended reading order

  1. CassandraDestination.java
  2. CassandraConfig.java
  3. CassandraMessageConsumer.java
  4. CassandraNameTransformer.java
  5. CassandraStreamConfig.java
  6. CassandraCqlProvider.java
  7. SessionManager.java
  8. TableRecord.java
  9. MetadataTuple.java

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@CLAassistant
Copy link

CLAassistant commented Oct 19, 2021

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ itaseskii
❌ itaseski


itaseski seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Oct 19, 2021
@itaseskii
Copy link
Contributor Author

itaseskii commented Oct 19, 2021

Hi Airbyte team :) I would like to submit my Cassandra destination connector for the Airbyte platform. Unfortunately I have the same issue with the acceptance tests as the Elasticsearch connector #7005 (comment). My unit and integration tests run without a problem but the build gets stuck on the acceptance tests, from initial investigation it seems that the running container won't exit after the write command has been executed and that locks the gradle build.

@itaseskii
Copy link
Contributor Author

Also, can you please remove the 'itaseski' user from the CLA issue? I have already signed the agreement with my Github acc.

@marcosmarxm marcosmarxm self-assigned this Oct 20, 2021
@marcosmarxm marcosmarxm added the gl label Oct 20, 2021
@marcosmarxm
Copy link
Member

marcosmarxm commented Oct 20, 2021

thanks for the contribution @itaseskii I added this to our sprint to review. About the acceptance tests any news to solve I'll let you know. If possible run ./gradlew format to format all files.


RUN tar xf ${APPLICATION}.tar --strip-components=1

LABEL io.airbyte.version=1.0.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please, change the version to 0.1.0

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to 0.1.0

private static final Logger LOGGER = LoggerFactory.getLogger(CassandraDestination.class);

public static void main(String[] args) throws Exception {
new IntegrationRunner(new CassandraDestination()).run(args);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be great to add logs around the connector initialization

Suggested change
new IntegrationRunner(new CassandraDestination()).run(args);
LOGGER.info("starting destination: {}", CassandraDestination.class);
new IntegrationRunner(new CassandraDestination()).run(args);
LOGGER.info("completed destination: {}", CassandraDestination.class);

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since run() is already logging the info that the integration/destination has started and finished isn't that enough? :)

var streamConfig =
cassandraStreams.get(AirbyteStreamNameNamespacePair.fromRecordMessage(messageRecord));
Preconditions.checkNotNull(streamConfig, "Unrecognized destination stream");
//var formattedNode = CassandraNameTransformer.formatJsonPath(messageRecord.getData());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please, remove commented line if not needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed.

if (cassandraContainer == null) {
cassandraContainer = new ConfiguredCassandraContainer();
// max heap size
// cassandraContainer.addEnv("MAX_HEAP_SIZE", "2048");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please, remove commented line if not needed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed.

@itaseskii
Copy link
Contributor Author

Hey @marcosmarxm :) I have formatted the code with ./gradlew format and I have managed to fix my acceptance tests. The reason the jvm was hanging was because of a missing executor service shutdown. I have also done some general code improvements and refactoring. As an attachment I am sending you screenshot of the passing acceptance tests.

Screenshot_6

"address": {
"title": "Address",
"description": "Address to connect to.",
"type": "string",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add an example here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added :)

@marcosmarxm marcosmarxm merged commit f53fd5e into airbytehq:master Nov 5, 2021
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
* add cassandra destination connector

* refactor and docs.

* delete test dockerfile

* revert Dockerfile rm change

* refactor & fix acceptance tests & format

* revert stream peek

* remove get pip

* add address example

* improved copy and code refactor

* add docker-compose and improved docs

Co-authored-by: itaseski <ivica.taseski@seavus.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants