Skip to content

Commit f81941c

Browse files
committed
Azure RETL docs [netlify-build]
1 parent eee06e8 commit f81941c

File tree

5 files changed

+82
-5
lines changed

5 files changed

+82
-5
lines changed

src/_data/sidenav/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,8 @@ sections:
185185
- section_title: Reverse ETL Source Setup Guides
186186
slug: connections/reverse-etl/reverse-etl-source-setup-guides
187187
section:
188+
- path: /connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup
189+
title: Azure Reverse ETL Setup
188190
- path: /connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup
189191
title: BigQuery Reverse ETL Setup
190192
- path: /connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup

src/connections/reverse-etl/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@ To add your warehouse as a source:
3838
> You need to be a user that has both read and write access to the warehouse.
3939
4040
1. Navigate to **Connections > Sources** and select the **Reverse ETL** tab in the Segment app.
41-
2. Click **Add Reverse ETL source**.
41+
2. Click **+ Add Reverse ETL source**.
4242
3. Select the source you want to add.
4343
4. Follow the corresponding setup guide for your Reverse ETL source.
44+
* [Azure Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/azure-setup/)
4445
* [BigQuery Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup/)
4546
* [Databricks Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup/)
4647
* [Postgres Reverse ETL setup guide](/docs/connections/reverse-etl/reverse-etl-source-setup-guides/postgres-setup/)
@@ -49,7 +50,7 @@ To add your warehouse as a source:
4950
5. Add the account information for your source.
5051
* For Snowflake users: Learn more about the Snowflake Account ID [here](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html){:target="_blank"}.
5152
5. Click **Test Connection** to test to see if the connection works.
52-
6. Click **Create Source** if the test connection is successful.
53+
6. Click **Add source** if the test connection is successful.
5354

5455
After you add your data warehouse as a source, you can [add a model](#step-2-add-a-model) to your source.
5556

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
title: Azure Reverse ETL Setup
3+
---
4+
5+
> info "Public beta"
6+
> The Azure source for Reverse ETL is 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"}.
7+
8+
Set up Azure as your Reverse ETL source.
9+
10+
At a high level, when you set up Azure dedicated SQL pools for Reverse ETL, the configured user needs read permissions for any resources (databases, schemas, tables) the query needs to access. Segment keeps track of changes to your query results with a managed schema (`__SEGMENT_REVERSE_ETL`), which requires the configured user to allow write permissions for that schema.
11+
12+
## Required permissions
13+
Make sure the user you use to connect to Segment has permissions to use that warehouse. You can follow the process below to set up a new user with sufficient permissions for Segment’s use.
14+
15+
> info ""
16+
> Execute all commands in the database where your data resides, except the first `CREATE LOGIN` command, which you need to execute in the master database.
17+
18+
* To create a login and user for Segment, run:
19+
20+
```
21+
CREATE LOGIN SegmentReverseETLLogin WITH PASSWORD = 'Str0ng_password'; -- password of your choice
22+
CREATE USER SegmentReverseETLUser FOR LOGIN SegmentReverseETLLogin;
23+
```
24+
25+
* To grant access to the user to read data from all schemas in the database, run:
26+
27+
```
28+
EXEC sp_addrolemember 'db_datareader', 'SegmentReverseETLUser';
29+
```
30+
31+
* To grant Segment access to read from certain schemas, run:
32+
33+
```
34+
CREATE ROLE SegmentReadRole;
35+
GRANT SELECT ON SCHEMA::[schema_name] TO SegmentReadRole;
36+
EXEC sp_addrolemember 'SegmentReadRole', 'SegmentReverseETLUser';
37+
```
38+
39+
* To grant Segment access to create a schema to keep track of the running syncs, run:
40+
41+
```
42+
GRANT CREATE SCHEMA TO SegmentReverseETLUser;
43+
```
44+
45+
* If you want to create the schema yourself and then give Segment access to it, run:
46+
47+
```
48+
CREATE SCHEMA __segment_reverse_etl;
49+
GRANT CONTROL ON SCHEMA::__segment_reverse_etl TO SegmentReverseETLUser;
50+
GRANT CREATE TABLE ON DATABASE::[database_name] TO SegmentReverseETLUser;
51+
```
52+
53+
## Set up guide
54+
To set up Azure as your Reverse ETL source:
55+
1. Log in to your Azure account.
56+
2. Navigate to your **dedicated SQL pool**. Segment supports both dedicated SQL pool (formerly SQL DW) and dedicated SQL pool in Synapse workspace.
57+
3. Navigate to **Settings > Connection strings** and select the **JDBC** tab to find the server, port, and database name.
58+
4. Open [your Segment workspace](https://app.segment.com/workspaces){:target="_blank"}.
59+
5. Navigate to **Connections > Sources** and select the **Reverse ETL** tab.
60+
6. Click **+ Add Reverse ETL source**.
61+
7. Select **Azure** and click **Add Source**.
62+
8. Enter the configuration settings for you Azure source based on the information from Step 3.
63+
* Hostname:
64+
* Use `xxxxxxx.sql.azuresynapse.net` if you’re connecting to a dedicated SQL pool in Synapse workspace.
65+
* Use `xxxxxxx.database.windows.net` if you’re connecting to a dedicated SQL pool (formerly SQL DW)
66+
* Port: `1433` (default)
67+
* Database name: The name of your dedicated SQL pool.
68+
* Username: The login name you created with `CREATE LOGIN` in the [required permissions](#required-permissions) section.
69+
* Password: The password that's associated with the login name.
70+
9. Click **Test Connection** to see if the connection works. If the connection fails, make sure you have the right permissions and credentials, then try again.
71+
10. Click **Add source** if the test connection is successful.
72+
73+
Once you've successfully added your Azure source, [add a model](/docs/connections/reverse-etl/#step-2-add-a-model) and follow the rest of the steps in the Reverse ETL setup guide.
74+

src/connections/reverse-etl/reverse-etl-source-setup-guides/bigquery-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To set up the Segment BigQuery connector:
2626
14. Navigate to the Segment UI and paste all the credentials you copied from step 13 into the **Enter your credentials** section.
2727
19. Enter your **Data Location**.
2828
20. Click **Test Connection** to test to see if the connection works. If the connection fails, make sure you have the right permissions and credentials and try again.
29-
6. Click **Create Source** if the test connection is successful.
29+
6. Click **Add source** if the test connection is successful.
3030

3131
Once you've added BigQuery as a source, you can [add a model](/docs/connections/reverse-etl#step-2-add-a-model).
3232

src/connections/reverse-etl/reverse-etl-source-setup-guides/databricks-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To set up Databricks as your Reverse ETL source:
3939
4. Select **SQL Warehouses** and select the warehouse you want to use. Note that Segment doesn't support the `Compute` connection parameters.
4040
5. Go to the **Connection details** tab and **keep** this page open.
4141
6. Open [your Segment workspace](https://app.segment.com/workspaces){:target="_blank”}.
42-
7. Navigate to **Connections > Sources > Reverse ETL**.
42+
7. Navigate to **Connections > Sources** and select the **Reverse ETL** tab.
4343
8. Click **+ Add Reverse ETL source**.
4444
9. Select **Databricks** and click **Add Source**.
4545
10. Enter the configuration setting for your Databricks source based on information from step 5
@@ -49,7 +49,7 @@ To set up Databricks as your Reverse ETL source:
4949
* Token: `<your-token>`
5050
* Catalog [optional]: `hive_metastore` (default)
5151
11. Click **Test Connection** to see if the connection works. If the connection fails, make sure you have the right permissions and credentials, then try again.
52-
12. Click **Create Source** if the test connection is successful.
52+
12. Click **Add source** if the test connection is successful.
5353
5454
> info ""
5555
> To generate a token, follow the steps listed in the [Databricks docs](https://docs.databricks.com/dev-tools/auth.html#pat){:target="_blank"}. Segment recommends you create a token with no expiration date by leaving the lifetime field empty when creating it. If you already have a token with an expiration date, be sure to keep track of the date and renew it on time.

0 commit comments

Comments
 (0)