You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/index.md
+19-20Lines changed: 19 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,10 +9,10 @@ Reverse ETL (Extract, Transform, Load) extracts data from a data warehouse using
9
9
10
10
Use Reverse ETL when you want to:
11
11
***Enable your marketing teams**: Sync audiences and other data built in the warehouse to Braze, Hubspot, or Salesforce Marketing Cloud for personalized marketing campaigns.
12
-
***Enrich your customer profiles**: Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from the warehouse.
13
-
***Activate data in Twilio Engage**: Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage.
12
+
***Enrich your customer profiles**: Sync enriched data to Mixpanel for a more complete view of the customer, or enrich Segment Unify with data from your warehouse.
13
+
***Activate data in Twilio Engage**: Send data in the warehouse back into Segment as events that can be activated in all supported destinations, including Twilio Engage destinations.
14
14
***Strengthen your conversion events**: Pass offline or enriched data to conversion APIs like Facebook, Google Ads, TikTok, or Snapchat.
15
-
***Empower business teams**: Connect Google Sheets to a view in the warehouse for other business teams to have access to up-to-date reports.
15
+
***Empower business teams**: Connect Google Sheets to a view in the warehouse to create up-to-date reports for other business teams.
16
16
17
17
> info "Reverse ETL supports event and object data"
18
18
> Event and object data includes customer profile data, subscriptions, product tables, shopping cart tables, and more.
@@ -29,50 +29,49 @@ Use Reverse ETL when you want to:
description="View the 30+ destinations with native Reverse ETL support and learn how you can use the Segment Connections and Segment Profiles to send data to the rest of the Segment catalog."
34
+
title="Manage Reverse ETL Syncs"
35
+
description="View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs."
36
36
%}
37
37
</div>
38
38
39
39
## Learn more
40
40
41
-
Learn more about the system that powers Reverse ETL, the mappings that power the flow of data to your downstream destinations, and observability tools you can use to manage your syncs.
42
-
41
+
Learn more about the system that powers Reverse ETL, check out the supported destinations, and view frequently asked questions.
description="View the 30+ destinations with native Reverse ETL support and learn how to send data to the rest of the Segment catalog using Segment Connections."
description="Reference material about system limits and how Segment detects data changes."
61
+
href="/docs/connections/reverse-etl/faq"
62
+
title="Reverse ETL FAQ"
63
+
description="Frequently asked questions about Reverse ETL."
65
64
%}
66
65
</div>
67
66
</div>
68
67
69
-
## More Segment resources
68
+
## More Reverse ETL resources
70
69
71
70
{% include components/reference-button.html
72
71
icon="guides.svg"
73
72
href="https://segment.com/blog/reverse-etl/"
74
-
title="What is reverse ETL? A complete guide"
75
-
description="In this blog from Segment, learn how reverse ETL helps businesses activate their data to drive better decision-making and greater operational efficiency."
73
+
title="What is Reverse ETL? A complete guide"
74
+
description="In this blog from Segment, learn how Reverse ETL helps businesses activate their data to drive better decision-making and greater operational efficiency."
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/manage-retl.md
+52-17Lines changed: 52 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,60 @@
1
1
---
2
-
title: Reverse ETL Mappings
3
-
beta: false
2
+
title: Manage Reverse ETL Syncs
3
+
beta: false
4
4
---
5
5
6
-
Learn which mapping fields support object and array values in your mappings and how you can reset or replay your syncs.
6
+
View your sync history, gain insights into sync statuses, and restart or replay failed or partially successful syncs.
7
+
8
+
## Sync history
9
+
Check the status of your data extractions and see details of your syncs. Click into failed records to view additional details on the error, sample payloads to help you debug the issue, and recommended actions.
10
+
11
+
To check the status of your extractions:
12
+
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
13
+
2. Select the destination you want to view.
14
+
3. Select the mapping you want to view.
15
+
4. Click the sync you want to view to get details of the sync. You can view:
16
+
* The status of the sync.
17
+
* Details of how long it took for the sync to complete.
18
+
* How many total records were extracted, as well as a breakdown of the number of records added, updated, and deleted.
19
+
* The load results - how many successful records were synced as well as how many records were updated, deleted, or are new.
20
+
5. If your sync failed, click the failed reason to get more details on the error and view sample payloads to help troubleshoot the issue.
21
+
22
+
> info "Segment automatically retries events that were extracted but failed to load"
23
+
> Segment retries events for 14 days following a total or partial sync failure. Before loading the failed records on a subsequent sync, Segment checks for the latest changes in your data to ensure the data loaded into your warehouse isn't stale. If the error causing the load failure is coming from an upstream tool, you can fix the error in the upstream tool to ensure the record loads on the next sync.
24
+
25
+
## Reset syncs
26
+
You can reset your syncs so that your data is synced from the beginning. This means that Segment resyncs your entire dataset for the model.
27
+
28
+
To reset a sync:
29
+
1. Select the three dots next to **Sync now**.
30
+
2. Select **Reset sync**.
31
+
3. Select the checkbox that you understand what happens when a sync is reset.
32
+
4. Click **Reset sync**.
33
+
34
+
## Replays
35
+
You can choose to replay syncs. To replay a specific sync, contact [[email protected]](mailto:[email protected]). Keep in mind that triggering a replay resyncs all records for a given sync.
36
+
37
+
## Alerting
38
+
You can opt in to receive email, Slack, and in-app alerts about Reverse ETL sync failures and partial successes.
39
+
40
+
To subscribe to alerts:
41
+
1. Navigate to **Settings > User Preferences**.
42
+
2. Select **Reverse ETL** in the **Activity Notifications** section.
43
+
3. Click the Reverse ETL sync status that you'd like to receive notifications for. You can select one or more of the following sync statuses:
44
+
-**Reverse ETL sync failed**: Receive a notification when your Reverse ETL sync fails.
45
+
-**Reverse ETL sync partial success**: Receive a notification when your Reverse ETL sync is partially successful.
46
+
4. Select one or more of the following alert options:
47
+
-**Enable email notifications**: Enter an email address or alias that should receive alerts.
48
+
-**Enable Slack notifications**: Enter a Webhook URL and Slack channel name.
49
+
-**Enable in-app notifications**: Select this option to see an in-app notification.
50
+
5. Click **Create alert**.
51
+
52
+
> info "View email addresses that are signed up to receive alerts"
53
+
> If you opted to receive notifications by email, you can click **View active email addresses** to see the email addresses that are currently signed up to receive notifications.
7
54
8
55
## Supported object and arrays
9
56
10
-
When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data to be in the form of an [object](/docs/connections/reverse-etl/mapping/#object-mapping) or [array](/docs/connections/reverse-etl/mapping/#array-mapping).
57
+
When you set up destination actions in Reverse ETL, depending on the destination, some [mapping fields](/docs/connections/reverse-etl/setup/#step-4-create-mappings) may require data to be in the form of an [object](/docs/connections/reverse-etl/manage-retl/#object-mapping) or [array](/docs/connections/reverse-etl/manage-retl/#array-mapping).
11
58
12
59
### Object mapping
13
60
You can send data to a mapping field that requires object data. An example of object mapping is an `Order completed` model with a `Products` column that’s in object format.
@@ -68,16 +115,4 @@ Select array | This enables you to send all nested properties within the array.
68
115
> success ""
69
116
> Certain array mapping fields have a fixed list of properties they can accept. If the names of the nested properties in your array don't match the destination properties, the data won't send. Segment recommends you to use the **Customize array** option to ensure your mapping is successful.
70
117
71
-
Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.
72
-
73
-
## Reset syncs
74
-
You can reset your syncs so that your data is synced from the beginning. This means that Segment resyncs your entire dataset for the model.
75
-
76
-
To reset a sync:
77
-
1. Select the three dots next to **Sync now**.
78
-
2. Select **Reset sync**.
79
-
3. Select the checkbox that you understand what happens when a sync is reset.
80
-
4. Click **Reset sync**.
81
-
82
-
## Replays
83
-
You can choose to replay syncs. To replay a specific sync, contact [[email protected]](mailto:[email protected]). Keep in mind that triggering a replay resyncs all records for a given sync.
118
+
Objects in an array don't need to have the same properties. If a user selects a missing property in the input object for a mapping field, the output object will miss the property.
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/setup.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,11 @@ After you add your data warehouse as a source, you can [add a model](#step-2-add
37
37
## Step 2: Add a model
38
38
Models are SQL queries that define sets of data you want to synchronize to your Reverse ETL destinations. After you add your source, you can add a model.
39
39
40
+
> info "Use Segment's dbt extension to centralize model management and versioning"
41
+
> Users who set up a BigQuery, Databricks, Postgres, Redshift, or Snowflake source can use Segment's [dbt extension](/docs/segment-app/extensions/dbt/) to centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes.
42
+
>
43
+
> Extensions is currently in public beta and is governed by Segment's [First Access and Beta Preview Terms](https://www.twilio.com/en-us/legal/tos){:target="_blank"}. During Public Beta, Extensions is available for Team and Developer plans only. [Reach out to Segment](mailto:[email protected]) if you're on a Business Tier plan and would like to participate in the Public Beta.
44
+
40
45
To add your first model:
41
46
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab. Select your source and click **Add Model**.
42
47
2. Click **SQL Editor** as your modeling method. (Segment will add more modeling methods in the future.)
@@ -67,7 +72,7 @@ Reverse ETL supports 30+ destinations: see all destinations listed in the [Rever
67
72
Engage users can use the [Segment Profiles Destination](/docs/connections/destinations/catalog/actions-segment-profiles/) to send data from their warehouse to their Reverse ETL destinations.
68
73
69
74
> info "Separate endpoints and credentials required to set up third party destinations"
70
-
> Before you begin setting up your destinations, note that you might be required to have credentials for and
75
+
> Before you begin setting up your destinations, note that each destination has different authentication requirements. See the documentation for your intended destination for more details.
71
76
72
77
To add your first destination:
73
78
1. Navigate to **Connections > Destinations** and select the **Reverse ETL** tab.
@@ -106,7 +111,7 @@ To create a mapping:
106
111
* Scheduling multiple extractions to start at the same time inside the same data warehouse causes extraction errors.
107
112
11. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
108
113
* You map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected.
109
-
* If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/mapping/#supported-object-and-arrays).
114
+
* If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](/docs/connections/reverse-etl/manage-retl/#supported-object-and-arrays).
110
115
12.*(Optional)* Send a test record to verify the mappings correctly send to your destination.
111
116
13. Click **Create Mapping**.
112
117
14. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/system.md
-12Lines changed: 0 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,6 @@ beta: false
5
5
6
6
View reference information about how Segment detects data changes in your warehouse and the rate and usage limits associated with Reverse ETL.
7
7
8
-
## Extensions
9
-
10
-
Extensions integrate third-party tools into your existing Segment workspace to help you automate tasks.
11
-
12
-
> info ""
13
-
> Extensions is currently in public beta and is governed by Segment’s First Access and Beta Preview Terms. During Public Beta, Extensions is available for Team and Developer plans only. Reach out to Segment if you’re on a Business Tier plan and would like to participate in the Public Beta.
14
-
15
-
Segment has two extensions that you can use to manage your Reverse ETL sources:
16
-
17
-
-[dbt models and dbt Cloud](/docs/segment-app/extensions/dbt/): Sync your Reverse ETL models with dbt labs models and syncs to help centralize model management and versioning, reduce redundancies, and run CI checks to prevent breaking changes.
18
-
-[Git sync](/docs/segment-app/extensions/git/): Manage versioning by syncing changes you make to your Reverse ETL sources from your Segment workspace to a Git repository.
19
-
20
8
## Record diffing
21
9
Reverse ETL computes the incremental changes to your data directly within your data warehouse. The Unique Identifier column is used to detect the data changes, such as new, updated, and deleted records.
0 commit comments