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

Check With Catalog JDBC POC (feature flag default off) #24109

Closed
wants to merge 88 commits into from

Conversation

jbfbell
Copy link
Contributor

@jbfbell jbfbell commented Mar 15, 2023

What

Check with Catalog Implementation for JDBC connectors. Will use the ConfiguredAirbyteCatalog to perform more thorough check method.

How

There is a platform feature flag check-with-catalog which when active will send the ConfiguredAirbyteCatalog path to the check method. In addition to the feature flag, there is logic to validate that the connector supports the additional parameter and will fall back to the standard check method w/o the the catalog.

When the catalog is available, then each namespace declared in the catalog is verified to be writable.

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

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/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

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as 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

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.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped 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

jbfbell and others added 30 commits March 2, 2023 16:29
…ge, Twilio (#23650)

* Fixed expected records

* Added allowedHosts

* fix discovery gitlab
* Use ** instead of |

* Using typing type

* Using typing type

* Using typing type

* Revert "Merge branch 'master' into alex/support_3.8"

This reverts commit 5c75815, reversing
changes made to 5cb47f8.

* Revert "Merge branch 'master' into alex/support_3.8"

This reverts commit 5cb47f8, reversing
changes made to 4058fce.

* Revert "Merge branch 'master' into alex/support_3.8"

This reverts commit e1d1099, reversing
changes made to da881ef.

* reset changes

* undo borked publish

* downgrade bumpversion.cfg and Dockerfile too

* explicitely support >=3.8

* update readme
* Source Senseforce: Mark datefields in spec as dates

* Update changeglog

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Recharge: Mark datefields in spec as dates

* Update changelog

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Klaviyo: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Iterable: Mark datefields in spec as dates

* Update changelog

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Snapchat Marketing: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* Update Dockerfile

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source NASA: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Amplitude: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* Update Dockerfile

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Notion: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* Update Dockerfile

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Woocommerce: Mark datefields in spec as dates

* Reset source version

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Revert "Postgres Source : Support JSONB datatype (#21695)"

This reverts commit 90884d0.

* upgrade version and add changelog

* auto-bump connector version

* update spec

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Prestashop: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Mailgun: Mark datefields in spec as dates

* Update changelog

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Zendesk Chat: Mark datefields in spec as dates

* Specify date-time format

* Reset source version

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source NY Times: Mark datefields in spec as dates

* Update changelog

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Linkedin Ads: Mark datefields in spec as dates

* Update changelog

* Add allowedHosts

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Source Twilio: Mark datefields in spec as dates

* Update changelog

* Reset source version

* auto-bump connector version

---------

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
* Tmp

* Tmp

* Tmp

* tmp

* Make test to work

* PMD and update test

* Bmoric/add more controller tests (#22113)

* Add attempt and connection test

* Add more test

* Add more test

* pmd

* Rm unused import

* Add comment

* More test and address comments

* PR comments
@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues CDK Connector Development Kit labels Mar 15, 2023
@CLAassistant
Copy link

CLAassistant commented Mar 15, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 15, 2023

Affected Connector Report

NOTE ⚠️ Changes in this PR affect the following connectors. Make sure to do the following as needed:

  • Run integration tests
  • Bump connector or module version
  • Add changelog
  • Publish the new version

✅ Sources (31)

Connector Version Changelog Publish
source-alloydb 2.0.2
source-alloydb-strict-encrypt 2.0.2 🔵
(ignored)
🔵
(ignored)
source-bigquery 0.2.3
source-clickhouse 0.1.16
source-clickhouse-strict-encrypt 0.1.16 🔵
(ignored)
🔵
(ignored)
source-cockroachdb 0.1.20
source-cockroachdb-strict-encrypt 0.1.20 🔵
(ignored)
🔵
(ignored)
source-db2 0.1.18
source-db2-strict-encrypt 0.1.18 🔵
(ignored)
🔵
(ignored)
source-dynamodb 0.1.2
source-e2e-test 2.1.4
source-e2e-test-cloud 2.1.4 🔵
(ignored)
🔵
(ignored)
source-elasticsearch 0.1.1
source-jdbc 0.3.5 🔵
(ignored)
🔵
(ignored)
source-kafka 0.2.3
source-mongodb-strict-encrypt 0.1.19 🔵
(ignored)
🔵
(ignored)
source-mongodb-v2 0.1.19
source-mssql 1.0.3
source-mssql-strict-encrypt 1.0.3 🔵
(ignored)
🔵
(ignored)
source-mysql 2.0.3
source-mysql-strict-encrypt 2.0.3 🔵
(ignored)
🔵
(ignored)
source-oracle 0.3.23
source-oracle-strict-encrypt 0.3.23 🔵
(ignored)
🔵
(ignored)
source-postgres 2.0.2
source-postgres-strict-encrypt 2.0.2 🔵
(ignored)
🔵
(ignored)
source-redshift 0.3.16
source-relational-db 0.3.1 🔵
(ignored)
🔵
(ignored)
source-scaffold-java-jdbc 0.1.0 🔵
(ignored)
🔵
(ignored)
source-sftp 0.1.2
source-snowflake 0.1.31
source-tidb 0.2.3
  • See "Actionable Items" below for how to resolve warnings and errors.

❌ Destinations (48)

Connector Version Changelog Publish
destination-azure-blob-storage 0.2.0
destination-bigquery 1.2.16
destination-bigquery-denormalized 1.2.16
destination-cassandra 0.1.4
destination-clickhouse 0.2.2
destination-clickhouse-strict-encrypt 0.2.2 🔵
(ignored)
🔵
(ignored)
destination-csv 1.0.0
destination-databricks 0.3.1
destination-dev-null 0.2.7 🔵
(ignored)
🔵
(ignored)
destination-doris 0.1.0
destination-dynamodb 0.1.7
destination-e2e-test 0.2.4
destination-elasticsearch 0.1.6
destination-elasticsearch-strict-encrypt 0.1.6 🔵
(ignored)
🔵
(ignored)
destination-exasol 0.1.1
destination-gcs 0.2.15
destination-iceberg 0.1.0
destination-jdbc 0.3.14 🔵
(ignored)
🔵
(ignored)
destination-kafka 0.1.10
destination-keen 0.2.4
destination-kinesis 0.1.5
destination-local-json 0.2.11
destination-mariadb-columnstore 0.1.7
destination-mongodb 0.1.9
destination-mongodb-strict-encrypt 0.1.9 🔵
(ignored)
🔵
(ignored)
destination-mqtt 0.1.3
destination-mssql 0.1.22
destination-mssql-strict-encrypt 0.1.22 🔵
(ignored)
🔵
(ignored)
destination-mysql 0.1.20
destination-mysql-strict-encrypt 0.1.21
(mismatch: 0.1.20)
🔵
(ignored)
🔵
(ignored)
destination-oracle 0.1.19
destination-oracle-strict-encrypt 0.1.19 🔵
(ignored)
🔵
(ignored)
destination-postgres 0.3.26
destination-postgres-strict-encrypt 0.3.26 🔵
(ignored)
🔵
(ignored)
destination-pubsub 0.2.0
destination-pulsar 0.1.3
destination-r2 0.1.0
destination-redis 0.1.4
destination-redpanda 0.1.0
destination-redshift 0.4.2
destination-rockset 0.1.4
destination-s3 0.3.21
destination-s3-glue 0.1.2
destination-scylla 0.1.3
destination-snowflake 0.4.53
destination-teradata 0.1.1
destination-tidb 0.1.0
destination-yugabytedb 0.1.0
  • See "Actionable Items" below for how to resolve warnings and errors.

👀 Other Modules (1)

  • base-normalization

Actionable Items

(click to expand)

Category Status Actionable Item
Version
mismatch
The version of the connector is different from its normal variant. Please bump the version of the connector.

doc not found
The connector does not seem to have a documentation file. This can be normal (e.g. basic connector like source-jdbc is not published or documented). Please double-check to make sure that it is not a bug.
Changelog
doc not found
The connector does not seem to have a documentation file. This can be normal (e.g. basic connector like source-jdbc is not published or documented). Please double-check to make sure that it is not a bug.

changelog missing
There is no chnagelog for the current version of the connector. If you are the author of the current version, please add a changelog.
Publish
not in seed
The connector is not in the seed file (e.g. source_definitions.yaml), so its publication status cannot be checked. This can be normal (e.g. some connectors are cloud-specific, and only listed in the cloud seed file). Please double-check to make sure that it is not a bug.

diff seed version
The connector exists in the seed file, but the latest version is not listed there. This usually means that the latest version is not published. Please use the /publish command to publish the latest version.

@jbfbell jbfbell closed this Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment