Source DuckDB: ✨ Add MotherDuck support 🦆🦆 #29428

aaronsteers · 2023-08-15T11:23:57Z

☝️ Click here to dev/test this in the browser.

What

Adds a DevContainer config specific to the DuckDB Destination.
Add a Poetry config to ensure proper Python environment isolation.
Adds support for motherduck (md:) database paths.

How

Loosens restriction that would otherwise require /local/ paths, allowing md: and motherduck: paths.
Add a motherduck_api_key config options which allows users to securely pass their API token from the motherduck service.
Adds a poetry config to ensure proper library versions.
Adds a devcontainer to streamline testing and dev for the DuckDB destination.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
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.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

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
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

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
If new credentials are required for use in CI, add them to GSM. Instructions.

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

github-actions · 2023-08-15T11:24:22Z

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

PR name follows PR naming conventions
Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
Secrets in the connector's spec are annotated with airbyte_secret
All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

Check for hidden checklists in your PR description
Toggle the github label checklist-action-run on/off to re-run the checklist CI.

aaronsteers · 2023-08-26T04:19:02Z

Tests are passing locally. I've opened this up for review.

github-actions · 2023-08-26T04:21:35Z

destination-duckdb test report (commit `8f62a7921c`) - ❌

⏲️ Total pipeline duration: 59.91s

Step	Result
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	❌
Code format checks	❌
Connector package install	❌

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-08-26T04:33:27Z

destination-duckdb test report (commit `9cb65d97f8`) - ❌

⏲️ Total pipeline duration: 44.17s

Step	Result
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅
Code format checks	❌
Connector package install	❌

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

Co-authored-by: Augustin <augustin@airbyte.io>

github-actions · 2023-09-13T01:58:50Z

destination-duckdb test report (commit `044fbe8e49`) - ✅

⏲️ Total pipeline duration: 01mn43s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

flash1293 · 2023-09-15T15:53:37Z

docs/integrations/destinations/duckdb.md


-This destination is meant to be used on a local workstation and won't work on Kubernetes
+This destination is meant to be used on a local workstation or with the MotherDuck service as the destination. Local file-based DBs will not work on Kubernetes or in Airbyte Cloud.


This connector is not enabled in cloud - if I understand correctly that should be part of the PR; if that's the case the enabled flag in the metadata.yaml has to be adjusted

Thanks for calling this out. And yes, we definitely want to enable for Cloud as part of this PR. 👍

airbyte-integrations/connectors/destination-duckdb/integration_tests/spec.json

airbyte-integrations/connectors/destination-duckdb/destination_duckdb/destination.py

docs/integrations/destinations/duckdb.md

…feat-motherduck-support

github-actions · 2023-09-16T01:23:20Z

destination-duckdb test report (commit `23b21ca35b`) - ✅

⏲️ Total pipeline duration: 02mn47s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-16T01:53:47Z

destination-duckdb test report (commit `65161fd3dc`) - ✅

⏲️ Total pipeline duration: 01mn47s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-18T23:34:57Z

destination-duckdb test report (commit `41a9981e72`) - ❌

⏲️ Total pipeline duration: 03mn25s

Step	Result

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-19T13:36:57Z

destination-duckdb test report (commit `2b31870d15`) - ✅

⏲️ Total pipeline duration: 01mn55s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-19T15:43:11Z

destination-duckdb test report (commit `f290c2b330`) - ✅

⏲️ Total pipeline duration: 01mn27s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-19T16:28:07Z

destination-duckdb test report (commit `92897fd1ef`) - ✅

⏲️ Total pipeline duration: 01mn16s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

…feat-motherduck-support

github-actions · 2023-09-19T18:13:04Z

destination-duckdb test report (commit `811d601c09`) - ✅

⏲️ Total pipeline duration: 01mn33s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

…feat-motherduck-support

github-actions · 2023-09-19T19:34:08Z

destination-duckdb test report (commit `611b915fb5`) - ✅

⏲️ Total pipeline duration: 01mn49s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-19T19:41:45Z

destination-duckdb test report (commit `e0ec60508d`) - ✅

⏲️ Total pipeline duration: 01mn54s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

github-actions · 2023-09-19T20:17:47Z

destination-duckdb test report (commit `1e7b3b770d`) - ✅

⏲️ Total pipeline duration: 02mn17s

Step	Result
Connector package install	✅
Build destination-duckdb docker image for platform linux/x86_64	✅
Unit tests	✅
Integration tests	✅
Acceptance tests	✅
Code format checks	✅
Validate airbyte-integrations/connectors/destination-duckdb/metadata.yaml	✅
Connector version semver check	✅
Connector version increment check	✅
QA checks	✅

🔗 View the logs here

☁️ View runs for commit in Dagger Cloud

Please note that tests are only run on PR ready for review. Please set your PR to draft mode to not flood the CI engine and upstream service on following commits.
You can run the same pipeline locally on this branch with the airbyte-ci tool with the following command

airbyte-ci connectors --name=destination-duckdb test

feat: (draft) motherduck support for destination-duckdb

80306e2

octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/destination/duckdb labels Aug 15, 2023

aaronsteers added 19 commits August 18, 2023 08:20

docs: instructions for motherduck connectivity

a331b01

chore: poetry init

cb63810

chore: mark setup.py for future removal

a0b4a2a

fix: typo

74c68eb

chore: add dev container config

29f3704

chore: move duckdb dev container config to root

ec275a5

chore: dev container opens in subdir

8a67d3c

fix: stringified dir name

622e34d

fix: api key injection

e708c08

chore: create symlink to devcontainer config while in the devcontainer

58b4ab8

chore: symlink the devcontainer config file directly

b48432e

chore: updated gitignore

60a1166

fix: path declaration

401cd3b

fix: data type for emitted_at col

be903ae

fix: motherduck token ingestion

6907b06

add motherduck tests (passing)

6c69415

fix: don't echo path (could be sensitive)

a4659b7

chore: add back db path logging when we know it is a local path

8f62a79

chore: update examples in json schema

0fdbe90

aaronsteers marked this pull request as ready for review August 26, 2023 04:18

aaronsteers changed the title ~~feat: (draft) MotherDuck support for destination-duckdb~~ feat(destination-motherduck): Add MotherDuck support Aug 26, 2023

chore: remove redundant python install

9cb65d9

Update airbyte-ci/connectors/connector_ops/connector_ops/utils.py

044fbe8

Co-authored-by: Augustin <augustin@airbyte.io>

Remove duplicate

a585701

flash1293 reviewed Sep 15, 2023

View reviewed changes

bnchrch added 3 commits September 15, 2023 17:39

Merge remote-tracking branch 'origin/master' into destination-duckdb/…

d65c853

…feat-motherduck-support

Bump version

07c2e5c

update tests

23b21ca

Update tests

65161fd

Merge branch 'master' into destination-duckdb/feat-motherduck-support

41a9981

Merge branch 'master' into destination-duckdb/feat-motherduck-support

2b31870

add titles to spec.json files

f290c2b

docs: customize readme for oss vs cloud

92897fd

Merge remote-tracking branch 'origin/master' into destination-duckdb/…

811d601

…feat-motherduck-support

Merge remote-tracking branch 'origin/master' into destination-duckdb/…

611b915

…feat-motherduck-support

enable duckdb in cloud

e0ec605

aaronsteers changed the title ~~feat(destination-motherduck): Add MotherDuck support~~ Source DuckDB: Add MotherDuck support Sep 19, 2023

aaronsteers changed the title ~~Source DuckDB: Add MotherDuck support~~ Source DuckDB: ✨ Add MotherDuck support 🦆🦆 Sep 19, 2023

docs: fix broken links

1e7b3b7

aaronsteers merged commit 68380cb into master Sep 19, 2023
16 checks passed

aaronsteers deleted the destination-duckdb/feat-motherduck-support branch September 19, 2023 20:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Source DuckDB: ✨ Add MotherDuck support 🦆🦆 #29428

Source DuckDB: ✨ Add MotherDuck support 🦆🦆 #29428

aaronsteers commented Aug 15, 2023 •

edited

Loading

github-actions bot commented Aug 15, 2023 •

edited by aaronsteers

Loading

aaronsteers commented Aug 26, 2023

github-actions bot commented Aug 26, 2023

github-actions bot commented Aug 26, 2023

github-actions bot commented Sep 13, 2023

flash1293 Sep 15, 2023

aaronsteers Sep 15, 2023

github-actions bot commented Sep 16, 2023

github-actions bot commented Sep 16, 2023

github-actions bot commented Sep 18, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023

github-actions bot commented Sep 19, 2023


		This destination is meant to be used on a local workstation and won't work on Kubernetes
		This destination is meant to be used on a local workstation or with the MotherDuck service as the destination. Local file-based DBs will not work on Kubernetes or in Airbyte Cloud.

Source DuckDB: ✨ Add MotherDuck support 🦆🦆 #29428

Source DuckDB: ✨ Add MotherDuck support 🦆🦆 #29428

Conversation

aaronsteers commented Aug 15, 2023 • edited Loading

What

How

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

github-actions bot commented Aug 15, 2023 • edited by aaronsteers Loading

Before Merging a Connector Pull Request

aaronsteers commented Aug 26, 2023

github-actions bot commented Aug 26, 2023

destination-duckdb test report (commit 8f62a7921c) - ❌

github-actions bot commented Aug 26, 2023

destination-duckdb test report (commit 9cb65d97f8) - ❌

github-actions bot commented Sep 13, 2023

destination-duckdb test report (commit 044fbe8e49) - ✅

flash1293 Sep 15, 2023

Choose a reason for hiding this comment

aaronsteers Sep 15, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 16, 2023

destination-duckdb test report (commit 23b21ca35b) - ✅

github-actions bot commented Sep 16, 2023

destination-duckdb test report (commit 65161fd3dc) - ✅

github-actions bot commented Sep 18, 2023

destination-duckdb test report (commit 41a9981e72) - ❌

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit 2b31870d15) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit f290c2b330) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit 92897fd1ef) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit 811d601c09) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit 611b915fb5) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit e0ec60508d) - ✅

github-actions bot commented Sep 19, 2023

destination-duckdb test report (commit 1e7b3b770d) - ✅

aaronsteers commented Aug 15, 2023 •

edited

Loading

github-actions bot commented Aug 15, 2023 •

edited by aaronsteers

Loading

destination-duckdb test report (commit `8f62a7921c`) - ❌

destination-duckdb test report (commit `9cb65d97f8`) - ❌

destination-duckdb test report (commit `044fbe8e49`) - ✅

destination-duckdb test report (commit `23b21ca35b`) - ✅

destination-duckdb test report (commit `65161fd3dc`) - ✅

destination-duckdb test report (commit `41a9981e72`) - ❌

destination-duckdb test report (commit `2b31870d15`) - ✅

destination-duckdb test report (commit `f290c2b330`) - ✅

destination-duckdb test report (commit `92897fd1ef`) - ✅

destination-duckdb test report (commit `811d601c09`) - ✅

destination-duckdb test report (commit `611b915fb5`) - ✅

destination-duckdb test report (commit `e0ec60508d`) - ✅

destination-duckdb test report (commit `1e7b3b770d`) - ✅