Yugabytedb
TODO: Update this document.
Sync overview
Output schema
Is the output schema fixed, as it is for an API like Stripe? If so, link to the connector’s schema, such as Stripe’s documentation. You can instead describe the schema here using a diagram or explanatory paragraphs.
Describe how the connector’s schema maps to Airbyte concepts. For example: “MagicDB tables become Airbyte Streams, and MagicDB columns become Airbyte Fields. The connector also appends an extracted_at column to each row it reads.”
Data type mapping
Add a table mapping each connector data type to its Airbyte type. Airbyte currently uses the same types as JSONSchema. The most common data types are string, date-time, object, array, boolean, integer and number.
| Integration Type | Airbyte Type | Notes |
|---|
Features
Add a table using the following format:
| Feature | Supported?(Yes/No) | Notes |
|---|---|---|
| Full Refresh Sync | ||
| Incremental Sync | ||
| Replicate Incremental Deletes | ||
| For databases, WAL/Logical replication | ||
| SSL connection | ||
| SSH Tunnel Support | ||
| (Any other source-specific features) |
Performance considerations
Explain when the connector could strain or affect your database, API or other system. Consider scenarios with many tables or rows. State the breaking point, such as 100mm> records. Explain how you can prevent problems, such as using a read-only replica or scheduling frequent syncs.
Getting started
Requirements
- Which connector versions does this implementation support? For example,
postgres v3.14 and above. - Which connector configurations are required, if any? For example,
buffer_size > 1024. - What network access does the connector require?
- Which credentials or authentication does the connector require? For example, a database user with read permissions for specific tables.
Setup guide
For each relevant requirement above, add or link to a step-by-step guide. See existing source or destination guides for an example.
For each supported major cloud provider, add a step-by-step guide for connecting Airbyte to that destination. See the Postgres destination guide for the expected format.