Checkpointing: documentation of lifecycle of how data flows through destination connectors

[ryankfu]

What

Follows up on #19765

Documents methods that write data from file buffer into the staging area of a destination connector. No function changes with one exception being SqlOperations where the method was renamed copyTableQuery to insertTableQuery to better match the logic that this is an append-only operation when writing data to airbyte_raw

How

Adds comments on methods that do not fully describe the parameters and what each method serves. Some methods have been updated to better reflect their underlying SQL query with additional notes for how that affects the information being stored

TODO comments are used as markers for myself primarily to keep a tracker of where changes need to be made for the removal and clean up the usage of airbyte_tmp tables

Recommended reading order

1. JdbcSqlOperations.java

🚨 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.

No user impact, this is purely a documentation of the learnings and findings about how destinations write data through the usage of temporary tables and how that data then is inserted into airbyte_raw

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.

[github-actions]

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	1.0.34	✅	✅
source-alloydb-strict-encrypt	1.0.34	🔵 (ignored)	🔵 (ignored)
source-bigquery	0.2.3	✅	✅
source-clickhouse	0.1.14	✅	✅
source-clickhouse-strict-encrypt	0.1.14	🔵 (ignored)	🔵 (ignored)
source-cockroachdb	0.1.18	✅	✅
source-cockroachdb-strict-encrypt	0.1.18	🔵 (ignored)	🔵 (ignored)
source-db2	0.1.16	✅	✅
source-db2-strict-encrypt	0.1.16	🔵 (ignored)	🔵 (ignored)
source-dynamodb	0.1.0	✅	✅
source-e2e-test	2.1.3	✅	✅
source-e2e-test-cloud	2.1.1	⚠ (doc not found)	⚠ (not in seed)
source-elasticsearch	0.1.1	✅	✅
source-jdbc	0.3.5	⚠ (doc not found)	⚠ (not in seed)
source-kafka	0.2.3	✅	✅
source-mongodb-strict-encrypt	0.1.19	🔵 (ignored)	🔵 (ignored)
source-mongodb-v2	0.1.19	✅	✅
source-mssql	0.4.26	✅	✅
source-mssql-strict-encrypt	0.4.26	🔵 (ignored)	🔵 (ignored)
source-mysql	1.0.18	✅	✅
source-mysql-strict-encrypt	1.0.18	🔵 (ignored)	🔵 (ignored)
source-oracle	0.3.21	✅	✅
source-oracle-strict-encrypt	0.3.21	🔵 (ignored)	🔵 (ignored)
source-postgres	1.0.34	✅	✅
source-postgres-strict-encrypt	1.0.34	🔵 (ignored)	🔵 (ignored)
source-redshift	0.3.15	✅	✅
source-relational-db	0.3.1	⚠ (doc not found)	⚠ (not in seed)
source-scaffold-java-jdbc	0.1.0	⚠ (doc not found)	⚠ (not in seed)
source-sftp	0.1.2	✅	✅
source-snowflake	0.1.27	✅	✅
source-tidb	0.2.1	✅	✅

• See "Actionable Items" below for how to resolve warnings and errors.

❌ Destinations (46)

Connector	Version	Changelog	Publish
destination-azure-blob-storage	0.1.6	✅	✅
destination-bigquery	1.2.9	✅	✅
destination-bigquery-denormalized	1.2.9	✅	✅
destination-cassandra	0.1.4	✅	✅
destination-clickhouse	0.2.1	✅	✅
destination-clickhouse-strict-encrypt	0.2.1	🔵 (ignored)	🔵 (ignored)
destination-csv	0.2.10	✅	✅
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-gcs	0.2.12	✅	✅
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.3.51	✅	✅
destination-rockset	0.1.4	✅	✅
destination-s3	0.3.18	✅	✅
destination-s3-glue	0.1.1	✅	✅
destination-scylla	0.1.3	✅	✅
destination-snowflake	0.4.40	✅	✅
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.