Skip to main content

Manage syncs

After you have created a connection, you can change how your data syncs to the destination by modifying the configuration settings and the 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:

  1. On the Airbyte Cloud dashboard, click Connections and then click the connection you want to change.

  2. Click the Replication tab.

  3. Click the Configuration dropdown.

You can configure the following settings:

note

These settings apply to all streams in the connection.

SettingDescription
Replication frequencyHow often the data syncs
Destination namespaceWhere the replicated data is written
Destination stream prefixHow you identify streams from different connectors
Non-breaking schema updates detectedHow Airbyte handles syncs when it detects non-breaking schema changes in the source

To use cron scheduling:

  1. In the Replication Frequency dropdown, click Cron.

  2. Enter a cron expression and choose a time zone to create a sync schedule.

note
  • 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.
  • Airbyte Cloud does not support schedules that sync more frequently than once per hour.

Modify streams in your connection

In the Activate the streams you want to sync table, you can choose which streams to sync and how they are loaded to the destination.

note

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:

  1. On the Airbyte Cloud dashboard, click Connections and then click the connection you want to change.

  2. Click the Replication tab.

  3. Scroll down to the Activate the streams you want to sync table.

note

You can modify a single stream, or you can modify multiple streams at once.

Modify an individual stream:

gif-single-edit-march-2023

  1. In the Activate the streams you want to sync table, toggle Sync on or off for your selected stream.

  2. Click the Sync mode dropdown and select the sync mode you want to apply.

note

Depending on the sync mode you select, you may need to choose a cursor or primary key.

  1. Select the Cursor or Primary keys when they are required by the stream sync mode.
note

Source-defined cursors and primary keys are selected automatically and cannot be changed in the table.

  1. Click on a stream to display the stream details panel.

  2. Toggle individual fields to include or exclude them in the sync, or use the toggle in the table header to select all fields at once.

note
  • 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.
  1. Depending on the sync mode you chose for your connection, you can select the Cursor or Primary keys for individual fields in this table.

  2. Click the X to close the stream details panel.

  3. Click Save changes, or click Cancel to discard the changes.

  4. The Stream configuration changed dialog displays. This gives you the option to reset streams when you save the changes.

caution

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.

  1. Click Save connection.

Modify multiple streams:

gif-batch-edit-march-2023

  1. In the Activate the streams you want to sync table, select the checkboxes of streams that you want to apply changes to.
note

To select or deselect all streams, click the checkbox in the table header. To deselect an individual stream, deselect its checkbox in the table.

  • In the highlighted footer of the table:

    1. Toggle Sync on or off.

    2. Click the Sync mode dropdown and select the sync mode you want to apply.

      note

      Depending on the sync mode you select, you may need to choose a cursor or primary key.

    3. Select the Cursor and Primary keys if there are dropdowns in those fields.

      note

      Source-defined cursors and primary keys cannot be changed while configuring multiple streams.

    4. Click Apply to apply these changes to the streams you selected, or click Cancel to discard the changes.

  1. Click Save changes, or click Cancel to discard the changes.

  2. The Stream configuration changed dialog displays. This gives you the option to reset streams when you save the changes.

caution

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.

  1. Click Save connection.