maxkferg/destination-clickhouse repository overview

⁠Destination Clickhouse

This is the repository for the Clickhouse destination connector in Java. For information about how to use this connector within Airbyte, see the User Documentation⁠.

⁠Local development

⁠Building via Gradle

From the Airbyte repository root, run:

./gradlew :airbyte-integrations:connectors:destination-clickhouse: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⁠ to set up the credentials.

⁠Locally running the connector docker image

⁠Build

Build the connector image via Gradle:

./gradlew :airbyte-integrations:connectors:destination-clickhouse:airbyteDocker

When building via Gradle, the docker image name and tag, respectively, are the values of the io.airbyte.name and io.airbyte.version LABELs in the Dockerfile.

⁠Run

Then run any of the connector commands as follows:

docker run --rm airbyte/destination-clickhouse:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-clickhouse:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/destination-clickhouse:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/destination-clickhouse: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/clickhouse.

⁠Acceptance Tests

Airbyte has a standard test suite that all destination connectors must pass. Implement the TODOs in src/test-integration/java/io/airbyte/integrations/destinations/clickhouseDestinationAcceptanceTest.java.

⁠Using gradle to run tests

All commands should be run from airbyte project root. To run unit tests:

./gradlew :airbyte-integrations:connectors:destination-clickhouse:unitTest

To run acceptance and custom integration tests:

./gradlew :airbyte-integrations:connectors:destination-clickhouse: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.
2. Bump the connector version in Dockerfile -- just increment the value of the LABEL io.airbyte.version appropriately (we use SemVer⁠).
3. Create a Pull Request.
4. Pat yourself on the back for being an awesome contributor.
5. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.