Configuring connections
A connection links a source to a destination and defines how your data will sync. After you have created a connection, you can modify any of the configuration settings or stream settings.
Configure Connection Settings
Configuring the connection settings allows you to manage various aspects of the sync, such as how often data syncs and where data is written.
To configure these settings:
On the Airbyte Cloud dashboard, click Connections and then click the connection you want to change.
Click the Replication tab.
Click the Configuration dropdown to expand the options.
These settings apply to all streams in the connection.
You can configure the following settings:
| Setting | Description |
|---|---|
| Replication frequency | How often the data syncs |
| Destination namespace | Where the replicated data is written |
| Destination stream prefix | How you identify streams from different connectors |
| Detect and propagate schema changes | How Airbyte handles syncs when it detects schema changes in the source |
| Connection Data Residency | Where data will be processed |
To use cron scheduling:
In the Replication Frequency dropdown, click Cron.
Enter a cron expression and choose a time zone to create a sync schedule.
- Only one sync per connection can run at a time.
- If a sync is scheduled to run before the previous sync finishes, the scheduled sync will start after the completion of the previous sync.
- Reach out to Sales if you require replication more frequently than once per hour.
Modify streams in your connection
In the Activate the streams you want to sync table, you choose which streams to sync and how they are loaded to the destination.
A connection's schema consists of one or many streams. Each stream is most commonly associated with a database table or an API endpoint. Within a stream, there can be one or many fields or columns.
To modify streams:
On the Airbyte Cloud dashboard, click Connections and then click the connection you want to change.
Click the Replication tab.
Scroll down to the Activate the streams you want to sync table.
Modify an individual stream:
In the Activate the streams you want to sync table, toggle Sync on or off for your selected stream. To select or deselect all streams, click the checkbox in the table header. To deselect an individual stream, deselect its checkbox in the table.
Click the Sync mode dropdown and select the sync mode you want to apply. Depending on the sync mode you select, you may need to choose a cursor or primary key.
Source-defined cursors and primary keys are selected automatically and cannot be changed in the table.
Click on a stream to display the stream details panel. You'll see each column we detect from the source.
Toggle individual fields or columns to include or exclude them in the sync, or use the toggle in the table header to select all fields at once.
- You can only deselect top-level fields. You cannot deselect nested fields.
- The Airbyte platform may read all data from the source (depending on the source), but it will only write data to the destination from fields you selected. Deselecting fields will not prevent the Airbyte platform from reading them.
- When you refresh the schema, newly added fields will be selected by default, even if you have previously deselected fields in that stream.
Click the X to close the stream details panel.
Click Save changes, or click Cancel to discard the changes.
The Stream configuration changed dialog displays. This gives you the option to reset streams when you save the changes.
Airbyte recommends that you reset streams. A reset will delete data in the destination of the affected streams and then re-sync that data. Skipping a reset is discouraged and might lead to unexpected behavior.
- Click Save connection.