Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update retl extract schedule #5510

Merged
merged 7 commits into from
Oct 26, 2023
Merged

update retl extract schedule #5510

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
abccddd
init commit
Oct 10, 2023
d3f2850
Merge branch 'develop' into update-retl-extract-schedule
Oct 24, 2023
a3fea98
fix typo
Oct 24, 2023
f9ddb47
fix numbered list
terence1988 Oct 25, 2023
ce981c4
fix numbered list
terence1988 Oct 25, 2023
37e709d
improve wording
terence1988 Oct 25, 2023
9fad252
update suggestions
Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions src/connections/reverse-etl/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,32 +96,34 @@ To create a mapping:
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
2. Select the destination that you want to create a mapping for.
3. Click **Add Mapping**.
2. Select the model to sync from.
3. Select the **Action** you want to sync and click **Next**.
4. Select the model to sync from.
5. Select the **Action** you want to sync and click **Next**.
* Actions determine the information sent to the destination. The list of Actions will be unique to each destination.
4. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
6. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
* Added records
* Updated records
* Added or updated records
* Deleted records
5. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
6. Select the **Schedule type** for the times you want the data to be extracted from your warehouse. You can choose from:
7. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
8. Select the Schedule type for the times you want the model’s data to be extracted from your warehouse. You can choose from:
* **Interval**: Extractions perform based on a selected time cycle.
* **Day and time**: Extractions perform at specific times on selected days of the week.
7. Select how often you want the schedule to sync in **Schedule configuration**.
9. Select how often you want the schedule to sync in **Schedule configuration**.
* For an **Interval** schedule type, you can choose from: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
* 15 minutes is considered real-time for warehouse syncs
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time. You can only choose to sync the extraction at the top of the hour.
8. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
* 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.
* 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](#supported-object-and-arrays).
9. *(Optional)* Send a test record to verify the mappings correctly send to your destination.
9. Click **Save Mapping**.
10. Select the destination you’d like to enable the mapping for under **Connections > Destinations > Reverse ETL**.
11. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time.
* You can only choose to start the extraction at the top of the hour.
* Scheduling multiple extractions to start at the same time inside the same data warehouse causes extraction errors.
10. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
* 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.
* 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](#supported-object-and-arrays).
11. *(Optional)* Send a test record to verify the mappings correctly send to your destination.
12. Click **Create Mapping**.
13. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
14. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
* If you disable the mapping state to the destination, events that match the trigger condition in the mapping won’t be sent to the destination.

To add multiple mappings from your warehouse to your destination, repeat steps 1-9 above.
To add multiple mappings from your warehouse to your destination, repeat steps 1-13 above.

## Using Reverse ETL
After you've followed [all four steps](/docs/connections/reverse-etl/#getting-started) and set up your source, model, destination, and mappings for Reverse ETL, your data will extract and sync to your destination(s) right away if you chose an interval schedule. If you set your data to extract at a specific day and time, the extraction will take place then.
Expand Down
Loading