Standardize spec.json for DB connectors that support log-based CDC replication

[VitaliiMaltsev]

What

Describe what the change is solving It helps to add screenshots if it affects the frontend.

How

Describe the solution

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

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

[VitaliiMaltsev]

/test connector=connectors/source-mysql

:clock2: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2733788230 :white_check_mark: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2733788230 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mysql-strict-encrypt

:clock2: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2733791083 :white_check_mark: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2733791083 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mysql

:clock2: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2754061264 :white_check_mark: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2754061264 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mysql-strict-encrypt

:clock2: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2754062582 :white_check_mark: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2754062582 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mssql-strict-encrypt

:clock2: connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2754318360 :white_check_mark: connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2754318360 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mssql

:clock2: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2754593979 :x: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2754593979 :bug: https://gradle.com/s/midn4fohvk2zu

Build Failed

Test summary info:

Could not find result summary

[VitaliiMaltsev]

/test connector=connectors/source-mssql

:clock2: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2782775070 :white_check_mark: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2782775070 No Python unittests run

Build Passed

Test summary info:

All Passed

[tuliren]

FYI a new version for MySQL and MSSQL is being published here. Should be done in the next hour.

[VitaliiMaltsev]

/test connector=connectors/source-mssql-strict-encrypt

:clock2: connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2859241536 :white_check_mark: connectors/source-mssql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2859241536 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mssql

:clock2: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2859241777 :white_check_mark: connectors/source-mssql https://github.com/airbytehq/airbyte/actions/runs/2859241777 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mysql-strict-encrypt

:clock2: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2859684774 :white_check_mark: connectors/source-mysql-strict-encrypt https://github.com/airbytehq/airbyte/actions/runs/2859684774 No Python unittests run

Build Passed

Test summary info:

All Passed

[VitaliiMaltsev]

/test connector=connectors/source-mysql

:clock2: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2859780526 :white_check_mark: connectors/source-mysql https://github.com/airbytehq/airbyte/actions/runs/2859780526 No Python unittests run

Build Passed

Test summary info:

All Passed

[grishick]

@VitaliiMaltsev what will happen if the new connector is deployed to an OpenSource Airbyte instance that does not have airbyte-server changes that are proposed in this PR?

[VitaliiMaltsev]

@VitaliiMaltsev what will happen if the new connector is deployed to an OpenSource Airbyte instance that does not have airbyte-server changes that are proposed in this PR?

@grishick in this case, the sync will fail for existing users who use mysql-source or mssql-source

[grishick]

@VitaliiMaltsev after much deliberation with platform team and tech support we decided to handle this in the following way:

1. please break this PR down into 2 separate PRs: one for MySQL connector and one for MS SQL connector
2. move the changes to airbyte-server into a separate PR - we will not merge it but use it for future reference

we will approve the PR for MS SQL first and will publish the new version of MS SQL source. After that is done, we will notify the community and manually fix specs for users in Airbyte Cloud. After that, we'll repeat the procedure for MySQL connector. In the process, we'll use the changes you proposed to airbyte-server as a reference.

The reason we'll do this with MS SQL source first is because it affects fewer connections than MySQL.

Later on when we implement an upgrade framework, we'll use the changes you proposed to airbyte-server as a reference as well.

[github-actions[bot]]

NOTE :warning: Changes in this PR affect the following connectors. Make sure to run corresponding integration tests:

• source-mysql
• source-mssql
• source-mysql-strict-encrypt
• source-mssql-strict-encrypt

[VitaliiMaltsev]

@VitaliiMaltsev after much deliberation with platform team and tech support we decided to handle this in the following way:

1. please break this PR down into 2 separate PRs: one for MySQL connector and one for MS SQL connector
2. move the changes to airbyte-server into a separate PR - we will not merge it but use it for future reference

we will approve the PR for MS SQL first and will publish the new version of MS SQL source. After that is done, we will notify the community and manually fix specs for users in Airbyte Cloud. After that, we'll repeat the procedure for MySQL connector. In the process, we'll use the changes you proposed to airbyte-server as a reference.

The reason we'll do this with MS SQL source first is because it affects fewer connections than MySQL.

Later on when we implement an upgrade framework, we'll use the changes you proposed to airbyte-server as a reference as well.

@grishick @evantahler created two separate PRs MsSQL Source MySQL Source

[VitaliiMaltsev]

Mysql Source and Mssql Source published and merged