jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update public documentation to include restrictions for backwards incompatible changes (#14731)

Browse Source 
* Update public documentation to include restrictions for backwards incompatible schema changes

* move a section down a bit

* Update docs/connector-development/best-practices.md

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>

Co-authored-by: Sherif A. Nada <snadalive@gmail.com>
This commit is contained in:
Brian Lai
2022-07-18 08:21:50 -04:00
committed by GitHub
parent 2dc4759264
commit 92a45d94ca
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/connector-development/cdk-python/schemas.md
View File

@@ -20,6 +20,9 @@ If you are implementing a connector to pull data from an API which publishes an
We also provide a tool for generating schemas using a connector's `read` command output. Detailed information can be found [here](https://github.com/airbytehq/airbyte/tree/master/tools/schema_generator/).
### Backwards Compatibility
Because statically defined schemas explicitly define how data is represented in a destination, updates to a schema must be backwards compatible with prior versions. More information about breaking changes can be found [here](../best-practices.md#schema-breaking-changes)
## Dynamic schemas