Skip to content

Commit

Permalink
docs: Update stripe-migrations.md (#42047)
Browse files Browse the repository at this point in the history
  • Loading branch information
nataliekwong authored Jul 17, 2024
1 parent c36d8e2 commit 1c06673
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions docs/integrations/sources/stripe-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,33 @@

## Upgrading to 5.4.0

This change fixes incremental sync issues with the `Refunds` stream:
The `Refunds` stream previously did not sync incrementally correctly. Incremental syncs are now resolved, and the `Refunds` stream now receives the correct updates using the `events` endpoint. This version resolves incremental sync issues with the `Refunds` stream.

- Stream cursor has changed from `created` to `updated`.
### Summary of changes:

The `Reset` for the affected stream `Refunds` is required. It's safe to do, since before this update the `Refunds` stream didn't use the `events` endpoint that have `30 Days data retention` period.
- The stream `Refunds` cursor changed from the field `created` to `updated` when syncing incrementally.
- The stream `Refunds` now incrementally syncs using the `events` endpoint.

Because of the changed cursor field of the `Refunds` stream, incremental syncs are now fixed and the stream receives the updates using the `events` endpoint.
### Migration Steps

1. Upgrade the Stripe connector by pressing the upgrade button and following the instructions on the screen.

:::info
The following migration steps are relevant for those who would like to sync `Refunds` incrementally. These migration steps can be skipped if you prefer to sync using `Full Refresh`.
:::

The stream `Refunds` will need to be synced historically again to ensure the connection continues syncing smoothly. If available for your destination, we recommend initiating a `Refresh` for the stream, which will pull in all historical data for the stream without removing the existing data first and update your destination with all data once complete. To initiate a `Refresh`:

1. Navigate to the connection's `Schema` tab. Navigate to the `Refunds` stream.
2. Update the `Refunds` stream to use the `Incremental | Append + Dedup` sync mode. This ensures your data will sync correctly and capture all updates efficiently.
3. If your stream already has a sync mode of either `Incremental | Append + Dedup` or `Incremental | Append`, simply update the cursor from `created_at` to `updated_at`.
4. Save the connection.
5. Review the prompt to `Refresh` the `Refunds` stream. Select `Refresh and retain records` to ensure any data no longer found in Stripe is retained in your destination.
6. Confirm the modal to save the connection and initiate a `Refresh`. This will start to pull in all historical data for the stream.

:::note
If you are using a destination that does not support the `Refresh` feature, you will need to [Clear](/operator-guides/clear) your stream. This will remove the data from the destination for just that stream. You will then need to sync the connection again in order to sync all data again for that stream.
:::

## Upgrading to 5.0.0

Expand Down

0 comments on commit 1c06673

Please sign in to comment.