Skip to content

Commit

Permalink
[Docs] Update "Reset" to "Clear" (#37357)
Browse files Browse the repository at this point in the history 
Co-authored-by: Teal Larson <[email protected]>
  • Loading branch information
@nataliekwong @teallarson
nataliekwong and teallarson authored Apr 17, 2024
1 parent db9c993 commit f519eb1
Show file tree
Hide file tree
Showing 9 changed files with 108 additions and 132 deletions.
12 changes: 6 additions & 6 deletions docs/integrations/sources/harvest-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Upgrading to 1.0.0

This update results in a change the following streams, requiring reset:
This update results in a change the following streams, requiring them to be cleared and completely synced again:
- `expenses_clients`
- `expenses_categories`
- `expenses_projects`
Expand All @@ -17,15 +17,15 @@ This update results in a change the following streams, requiring reset:
- `invoice_messages`
- `project_assignments`

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning Source Harvest from the Python Connector Development Kit (CDK) to our new low-code framework improving maintainability and reliability of the connector. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning the source Harvest from the Python Connector Development Kit (CDK) to our new low-code framework to improve maintainability and reliability of the connector. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

## Steps to Reset Streams
## Steps to Clear Streams

To reset your data for the impacted streams, follow the steps below:
To clear your data for the impacted streams, follow the steps below:

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Status** tab.
1. In the **Enabled streams** list, click the three dots on the right side of the stream requiring reset and select **Reset this stream**.
1. In the **Enabled streams** list, click the three dots on the right side of the stream and select **Clear Data**.

A fresh sync will run for the stream. For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
29 changes: 10 additions & 19 deletions docs/integrations/sources/linkedin-ads-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Upgrading to 1.0.0

Version 1.0.0 introduces changes in primary key for all *-analytics streams (including custom ones).
Version 1.0.0 introduces changes in the primary key selected for all *-analytics streams (including custom ones).

- "ad_campaign_analytics"
- "ad_creative_analytics"
- "ad_impression_device_analytics"
Expand All @@ -17,24 +18,14 @@ Version 1.0.0 introduces changes in primary key for all *-analytics streams (inc

## Migration Steps

### Refresh affected schemas and reset data
Clearing your data is required for the affected streams in order to continue syncing successfully. To clear your data for the affected streams, follow the steps below:

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab.
1. Select **Refresh source schema**.
2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
1. Select **Connections** in the main navbar and select the connection(s) affected by the update.
2. Select the **Schema** tab.
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review.
2. Select **OK** to approve changes.
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema.
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::

For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
10 changes: 5 additions & 5 deletions docs/integrations/sources/notion-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning source Notion from the Python Connector Development Kit (CDK) to our innovative low-code framework. This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change for users syncing data from the `Comments` stream.

Specifically, we’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream. This change impacts how individual states are tracked and stored for each partition, using a more structured approach to ensure the most granular and flexible state management. To gracefully handle these changes for your existing connections, we highly recommend resetting your data for the `Comments` stream before resuming your syncs with the new version.
Specifically, we’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream. This change impacts how individual states are tracked and stored for each partition, using a more structured approach to ensure the most granular and flexible state management. To gracefully handle these changes for your existing connections, we highly recommend clearing your data for the `Comments` stream before resuming your syncs with the new version.

If you are not syncing data from the `Comments` stream, this change is non-breaking, and no further action is required.

### Resetting your `Comments` data
### Migration Steps

To reset your data for the `Comments` stream, follow the steps below:
Data for the `Comments` stream will need to cleared to ensure your syncs continue successfully. To clear your data for the `Comments` stream, follow the steps below:

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Status** tab.
1. In the **Enabled streams** list, click the three dots on the right side of the **Comments** stream and select **Reset this stream**.
1. In the **Enabled streams** list, click the three dots on the right side of the **Comments** stream and select **Clear data**.

A fresh sync will run for the `Comments` stream. For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
After the clear succeeds, trigger a sync for the `Comments` stream by clicking "Sync Now". For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).

## Upgrading to 2.0.0

Expand Down
21 changes: 19 additions & 2 deletions docs/integrations/sources/rss-migrations.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
# Rss Migration Guide
# RSS Migration Guide

## Upgrading to 1.0.0
The verison migrates the Rss connector to the low-code framework for greater maintainability. You may need to refresh the connection schema (with the reset), and run a sync.
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte.

As part of our commitment to delivering exceptional service, we are transitioning our RSS source from the Python Connector Development Kit (CDK)
to our new low-code framework improving maintainability and reliability of the connector. Due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

## Migration Steps

Clearing your data is required for the affected streams in order to continue syncing successfully. To clear your data for the affected streams, follow the steps below:

1. Select **Connections** in the main navbar and select the connection(s) affected by the update.
2. Select the **Schema** tab.
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review.
2. Select **OK** to approve changes.
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema.
4. Select **Save connection**.

This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
62 changes: 16 additions & 46 deletions docs/integrations/sources/sendgrid-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
## Upgrading to 1.0.0

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte.

As part of our commitment to delivering exceptional service, we are transitioning Source Sendgrid from the Python Connector Development Kit (CDK)
to our new low-code framework improving maintainability and reliability of the connector.
However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.
to our new low-code framework improving maintainability and reliability of the connector. Due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

* The configuration options have been renamed to `api_key` and `start_date`.
* The `unsubscribe_groups` stream has been removed. It was the same as `suppression_groups`. You can use that and get the same data.
* The `single_sends` stream has been renamed `singlesend_stats`. This is closer to the data and API.
* The `segments` stream has been upgraded to use the Sendgrid 2.0 API because the older one has been deprecated. The schema has changed as a result.
* The `unsubscribe_groups` stream has been removed as it was a duplicate of `suppression_groups`. You can use `suppression_groups` and get the same data you were previously receiving in `unsubscribe_groups`.
* The `single_sends` stream has been renamed to `singlesend_stats`. This was done to more closely match the data from the Sendgrid API.
* The `segments` stream has been upgraded to use the Sendgrid 2.0 API as the previous version of the API has been deprecated. As a result, fields within the stream have changed to reflect the new API.

To ensure a smooth upgrade, please refresh your schemas and reset your data before resuming syncs.
To ensure a smooth upgrade, please clear your streams and trigger a sync to bring in historical data.

## Connector Upgrade Guide
## Migration Steps

### For Airbyte Open Source: Update the local connector image

Expand Down Expand Up @@ -42,46 +42,16 @@ Each instance of the connector must be updated separately. If you have created m
3. Select **Upgrade**
1. Follow the prompt to confirm you are ready to upgrade to the new version.

### For Airbyte Cloud and Open Source: Steps to Update Schema and Clear Streams

### Refresh all schemas and reset data

1. Select **Connections** in the main navbar.
2. Select the connection(s) affected by the update.
3. Select the **Replication** tab.
1. Select **Refresh source schema**.
2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
4. Select **Save changes** at the bottom of the page.
1. Ensure the **Reset all streams** option is checked.
5. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::

For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).

To clear your data for the affected streams, follow the steps below:

### Refresh affected schemas and reset data

1. Select **Connections** in the main navbar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab.
1. Select **Refresh source schema**.
2. Select **OK**.
:::note
Any detected schema changes will be listed for your review.
:::
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Reset affected streams** option is checked.
:::note
Depending on destination type you may not be prompted to reset your data.
:::
1. Select **Connections** in the main navbar and select the connection(s) affected by the update.
2. Select the **Schema** tab.
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review.
2. Select **OK** to approve changes.
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema.
4. Select **Save connection**.
:::note
This will reset the data in your destination and initiate a fresh sync.
:::

For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).

This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
39 changes: 14 additions & 25 deletions docs/integrations/sources/sftp-bulk-migrations.md
View file
Original file line number Diff line number Diff line change
@@ -1,36 +1,25 @@
# SFTP Bulk Migration Guide

## Upgrading to 1.0.0
This release upgrades the SFTP Bulk connector to file-based CDK which causes the following changes:
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte.

- Configuration changes
- Stream changes
As part of our commitment to delivering exceptional service, we are transitioning our SFTP Bulk source from the Python Connector Development Kit (CDK) to our new low-code framework improving maintainability and reliability of the connector. Due to differences between the Python and low-code CDKs, this migration constitutes a breaking change for the following:

Users should:
- Changes to the source configuration
- Changes to the schema (added, removed fields and/or streams)

- Reconfigure the source
- Refresh the source schema
- Reset affected streams after upgrading to ensure uninterrupted syncs.
## Migration Steps

This version change requires you to re-verify the configuration of your source. To do this, click on "Source" in the left-hand sidebar and navigate to your SFTP Bulk source. Test the source and ensure the configuration is valid before moving forward.

### Refresh affected schemas and reset data
Clearing your data is required for the affected streams in order to continue syncing successfully. To clear your data for the affected streams, follow the steps below:

1. Select **Connections** in the main navbar.
1. Select the connection(s) affected by the update.
2. Select the **Replication** tab.
1. Select **Refresh source schema**.
2. Select **OK**.
```note
Any detected schema changes will be listed for your review.
```
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Reset affected streams** option is checked.
```note
Depending on destination type you may not be prompted to reset your data.
```
1. Select **Connections** in the main navbar and select the connection(s) affected by the update.
2. Select the **Schema** tab.
1. Select **Refresh source schema** to bring in any schema changes. Any detected schema changes will be listed for your review.
2. Select **OK** to approve changes.
3. Select **Save changes** at the bottom of the page.
1. Ensure the **Clear affected streams** option is checked to ensure your streams continue syncing successfully with the new schema.
4. Select **Save connection**.
```note
This will reset the data in your destination and initiate a fresh sync.
```

For more information on resetting your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
This will clear the data in your destination for the subset of streams with schema changes. After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).
25 changes: 13 additions & 12 deletions docs/integrations/sources/slack-migrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

## Upgrading to 1.0.0

We're continuously striving to enhance the quality and reliability of our connectors at Airbyte.
As part of our commitment to delivering exceptional service, we are transitioning source Slack from the
Python Connector Development Kit (CDK) to our innovative low-code framework.
This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and
freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog.
However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

We’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream.
This change impacts how individual states are tracked and stored for each partition, using a more structured approach
to ensure the most granular and flexible state management.
This change will affect the `Channel Messages` stream.
We're continuously striving to enhance the quality and reliability of our connectors at Airbyte. As part of our commitment to delivering exceptional service, we are transitioning source Slack from the Python Connector Development Kit (CDK) to our innovative low-code framework. This is part of a strategic move to streamline many processes across connectors, bolstering maintainability and freeing us to focus more of our efforts on improving the performance and features of our evolving platform and growing catalog. However, due to differences between the Python and low-code CDKs, this migration constitutes a breaking change.

We’ve evolved and standardized how state is managed for incremental streams that are nested within a parent stream. This change impacts how individual states are tracked and stored for each partition, using a more structured approach to ensure the most granular and flexible state management. This change will affect the `Channel Messages` stream.

## Migration Steps
* A `reset` for `Channel Messages` stream is required after upgrading to this version.

Clearing your data is required in order to continue syncing `Channel Messages` successfully. To clear your data for the `Channel Messages` stream, follow the steps below:

1. Select **Connections** in the main nav bar.
1. Select the connection(s) affected by the update.
2. Select the **Status** tab.
1. In the **Enabled streams** list, click the three dots on the right side of the `Channel Messages` and select **Clear Data**.

After the clear succeeds, trigger a sync by clicking **Sync Now**. For more information on clearing your data in Airbyte, see [this page](https://docs.airbyte.com/operator-guides/reset).

Loading

0 comments on commit f519eb1

Please sign in to comment.