Skip to content

Commit e9c6a2c

Browse files
committed
Update profiles sync flow
1 parent aa06d87 commit e9c6a2c

File tree

1 file changed

+61
-12
lines changed

1 file changed

+61
-12
lines changed

src/unify/profiles-sync/index.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before you begin, prepare for setup with these tips:
1818
- During Step 2, you’ll copy credentials between Segment and your warehouse Destination. To streamline setup, open your Segment workspace in one browser tab and open another with your warehouse account.
1919
- Make sure to copy any IP addresses Segment asks you to allowlist in your warehouse Destination.
2020

21-
### Step 1: Create a warehouse
21+
### Step 1: Select a warehouse
2222

2323
You’ll first choose the Destination warehouse to which Segment will sync profiles. Profiles Sync supports the Snowflake, Redshift, BigQuery, Azure, and Postgres warehouse Destinations. Your initial setup will depend on the warehouse you choose.
2424

@@ -57,25 +57,65 @@ The following Segment access [roles](/docs/segment-app/iam/roles/) apply to Prof
5757

5858
### Step 2: Connect the warehouse and enable Profiles Sync
5959

60-
With your warehouse configured, you can now connect it to Segment.
60+
After selecting your warehouse, you can connect it to Segment.
6161

6262
During this step, you’ll copy credentials from the warehouse you just set up and enter them into the Segment app. The specific credentials you’ll enter depend on the warehouse you chose during Step 1.
6363

6464
Segment may also display IP addresses you’ll need to allowlist in your warehouse. Make sure to copy the IP addresses and enter them into your warehouse account.
6565

66-
Follow these steps to connect your warehouse:
66+
To connect your warehouse:
6767

68-
1. In your Segment workspace, navigate to **Unify > Profiles Sync**.
69-
2. Select **Add warehouse**, choose the warehouse you just set up, then select **Next**.
70-
3. Segment shows an IP address to allowlist. Copy it to your warehouse Destination.
71-
4. Segment prompts you to enter specific warehouse credentials. Enter them, then select **Test Connection**.
68+
1. Configure your database.
69+
- Be sure to log in with a user who has read and write permissions so that Segment can write to your database.
70+
- Segment shows an IP address to allowlist. Copy it to your warehouse Destination.
71+
2. Enter a schema name to help you identify this space in the warehouse, or use the default name provided.
72+
- The schema name can't be changed once the warehouse is connected.
73+
4. Enter your warehouse credentials, then select **Test Connection**.
7274
5. If the connection test succeeds, Segment enables the **Next** button. Select it.
7375
* If the connection test fails, verify that you’ve correctly entered the warehouse credentials, then try again.
74-
6. Set up a **Sync Schedule**, and select **Next**.
75-
7. From the [Set Selective Sync](#using-selective-sync) page, select the tables and columns you'd like to sync and click **Next**. Segment displays the Profiles Sync overview page.
76-
7. Select **Request sync to be enabled**.
7776

78-
Segment staff then receives and enables live sync for your account.
77+
78+
### Step 3: Set Selective Sync
79+
80+
Set up Selective Sync to control the exact tables and columns that Segment will sync to your connected data warehouse.
81+
82+
> info ""
83+
> Data will be backfilled to your warehouse based on the last two months of history.
84+
85+
You can sync the following tables:
86+
87+
**Profile raw tables**
88+
- `external_id_mapping_updates`
89+
- `id_graph_updates`
90+
- `profile_traits_updates`
91+
92+
**Profile materialized tables**
93+
- `user_identifier`
94+
- `user_traits`
95+
- `profile_merges`
96+
97+
> info ""
98+
> Materialized view tables are disabled by default. If you'd like to use tables that Segment materializes, you can enable them with Selective Sync. Alternitively, you can use Segment's [open-source dbt models](https://github.com/segmentio/profiles-sync-dbt){:target="_blank"}, or materialize views with your own tools.
99+
100+
**Event type tables**
101+
- `Identify`
102+
- `Page`
103+
- `Group`
104+
- `Screen`
105+
- `Alias`
106+
- `Track`
107+
108+
**Track event tables**
109+
110+
To view and select individual track tables, don’t sync track tables during the initial setup. Edit your sync settings after enabling Profiles Sync and waiting for the first sync to complete.
111+
112+
| Type | Tables |
113+
| ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
114+
| Profile raw tables | - `external_id_mapping_updates` <br> - `id_graph_updates` <br> - `profile_traits_updates` |
115+
| Profile materialized tables | - `user_identifier` <br> - `user_traits` <br> - `profile_merges` |
116+
| Event type tables | - `Identify` <br> - `Page` <br> - `Group` <br> - `Screen` <br> - `Alias` <br> - `Track` |
117+
| Track event tables | To view and select individual track tables, don't sync track tables during the initial setup. Edit your sync settings after enabling Profiles Sync and waiting for the first sync to complete. |
118+
79119

80120
#### Using Selective Sync
81121

@@ -120,7 +160,16 @@ Reach out to [Segment support](https://app.segment.com/workspaces?contact=1){:ta
120160
> success ""
121161
> While historical backfill is running, you can start building [materialized views](/docs/unify/profiles-sync/tables/#tables-you-materialize) and running [sample queries](/docs/unify/profiles-sync/sample-queries).
122162
123-
### Step 3: Materialize key views using a SQL automation tool
163+
<!-- TO DO: add a section below about materialized tables vs dbt script.
164+
165+
-->
166+
167+
### Optional: Materialize key views using a SQL automation tool
168+
169+
This option allows you to materialize views on your own, or use Segment's open source dbt models.
170+
171+
> success ""
172+
> You can alternatively use tables that Segment materializes and syncs to your data warehouse. [Learn more](/docs/unify/profiles-sync/tables/#tables-segment-materializes) about the tables Segment materializes.
124173
125174
To start seeing unified profiles in your warehouse and build attribution models, you'll need to materialize the tables that Profiles Sync lands into three key views:
126175

0 commit comments

Comments
 (0)