Skip to content

Commit 78b209a

Browse files
stayseesongstayseesong
authored
Merge pull request #7951 from segmentio/DOC-1264
unified warehouse credentials public beta
2 parents a273682 + b520407 commit 78b209a

File tree

7 files changed

+128
-70
lines changed

7 files changed

+128
-70
lines changed

‎src/connections/storage/catalog/azuresqldw/index.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -56,24 +56,24 @@ To connect your Azure database to Segment, [give Segment access to your SQL Data
5656
EXEC sp_set_firewall_rule N'<rule name>', '52.25.130.38', '52.25.130.38';
5757
```
5858

59-
### Configure an Azure Synapse Analytics Destination in Segment
60-
61-
In order to set up the Azure Synapse Analytics destination in Segment, you'll need the following pieces of information:
62-
63-
- **Server Name:** the name of the SQL Server resource that houses your SQL Data Warehouse
64-
- **Database:** the name of the SQL Data Warehouse database resource
65-
- **Username:** the name of the user you created above
66-
- **Password:** the password of the user you created above
67-
68-
To add a Azure Synapse Analytics destination in the Segment app:
69-
1. Log in to Segment and select the **Connections** tab. Click **Add Destination**.
70-
2. Select the **Storage Destinations** tab and click the **Azure SQL Data Warehouse** destination.
71-
3. Select the source(s) you want to sync with the Azure SQL Data Warehouse destination, and click **Next**.
72-
4. Provide a name for your destination, and then enter data into each of the fields in the "Enter your Credentials" section. For the **Server Name** field, enter only the part of the server name prior to `.database.windows.net`.
73-
5. Click **Connect**.
74-
75-
> warning "Initial sync timeline"
76-
> The first sync after you configure your Azure Synapse destination with Segment can take up to 24 hours to complete.
59+
### Connect Azure to Segment
60+
61+
> info "Unified warehouse credentials in public beta"
62+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
63+
64+
To connect Azure to Segment:
65+
1. Navigate to your product area in the Segment app.
66+
* For storage destinations, navigate to **Connections > Destinations** and select the **Storage** tab. Click **+ Add storage destination**.
67+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
68+
2. Select *Azure* as your warehouse.
69+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Azure instance.
70+
* **Server**: Your Azure dedicated SQL pool server.
71+
* **Port**: The port used for connecting to your Azure dedicated SQL pool. The default port for Azure dedicated SQL pool is 1433, but your port may be different.
72+
* **Database name**: The name of your Azure dedicated SQL pool that Segment uses in order to sync data.
73+
* **Username**: The Azure user that Segment uses to run SQL in your warehouse.
74+
* **Password**: The password of the user above.
75+
4. Test your connection.
76+
5. Click **Save**.
7777

7878
## Best Practices
7979

‎src/connections/storage/catalog/bigquery/index.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,21 @@ The downloaded file will be used to create your warehouse in the Segment app.
4747

4848
If you have trouble creating a new service account, refer to [Google Cloud's documentation about service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts){:target="_blank"} for more information.
4949

50-
### Create the Warehouse in Segment
51-
52-
To create the warehouse in Segment:
53-
1. From the homepage of the Segment app, select **Connections > Add Destination** and search for **BigQuery**.
54-
2. Click **BigQuery**.
55-
3. Select the source(s) you'd like to sync with the BigQuery destination, and click **Next**.
56-
3. Enter a name for your destination in the **Name your destination** field.
57-
4. Enter your Project ID in the **Project ID** field.
58-
<br/>*Optional:* Enter a [region code](https://cloud.google.com/compute/docs/regions-zones/){:target="_blank"} in the **Location** field (the default is *US*.)
59-
5. Copy the contents of the JSON key that you created for the Segment service account into the **Credentials** field.
60-
6. Click **Connect**.
61-
62-
If Segment is able to connect to your project, a warehouse will be created and your first sync will begin shortly.
50+
### Connect BigQuery to Segment
51+
52+
> info "Unified warehouse credentials in public beta"
53+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
54+
55+
1. Navigate to the product area in the Segment app.
56+
* For Storage destinations, navigate to **Connections > Destinations** and select the **Storage**tab. Click **+ Add storage destination**.
57+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
58+
2. Select *BigQuery* as your warehouse.
59+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your BigQuery instance.
60+
* **Project ID**: The Google Cloud project where your BigQuery database resides. Project IDs start with a letter and contain 6 – 63 lowercase letters, digits or dashes. Some project IDs also include domain name separated by a colon
61+
* **Location**: The region where you want your BigQuery datasets to reside
62+
* **Service account credentials**: The JSON credential that Segment will use to load data into your BigQuery database. Create a service account just for Segment to use
63+
4. Test your connection.
64+
5. Click **Save**.
6365

6466
## Schema
6567

‎src/connections/storage/catalog/databricks/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,27 @@ Use the following steps to set up Databricks in Segment:
4343
4. (Optional) Select a source(s) to connect to the destination.
4444
5. Follow the steps below to [connect your Databricks warehouse](#connect-your-databricks-warehouse).
4545

46+
## Connect Databricks to Segment
47+
48+
> info "Unified warehouse credentials in public beta"
49+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
50+
51+
To connect Databricks to Segment:
52+
53+
1. Navigate to your product area in the Segment app.
54+
* For Storage destinations, navigate to **Connections > Destinations** and select the **Storage** tab. Click **+ Add storage destination**.
55+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
56+
2. Select *Databricks* as your warehouse.
57+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Databricks instance:
58+
* **Hostname**: URL of your Databricks server
59+
* **HTTP path**: URL of your Databricks compute resources
60+
* **Port**: The port used for connecting to your Databricks warehouse. The default port for Databricks is 443, but your port may be different
61+
* **Unity Catalog name**: The catalog that Segment uses in order to sync data
62+
* **Service principal client ID**: The client ID used for accessing your Databricks warehouse
63+
* **Password**: The OAuth secret used to connect to your Databricks warehouse
64+
4. Test your connection.
65+
5. Click **Save**.
66+
4667
## Connect your Databricks warehouse
4768

4869
Use the five steps below to connect to your Databricks warehouse.

‎src/connections/storage/catalog/db2/index.md‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,24 @@ To grant the Segment user access to your database:
4343
```
4444
3. Click **Run All** to execute the `GRANT` command.
4545

46-
### Create Segment Db2 Destination
47-
48-
To set up an IBM Db2 destination in the Segment app:
49-
50-
1. Open the Segment app, navigate to **Connections** and click **Add Destination**.
51-
2. Search for and select **IBM Db2 Warehouse**.
52-
3. Select the sources you want to connect to the IBM Db2 warehouse, and click **Next**.
53-
4. Enter a name for your destination, and enter the following credentials:
54-
- Host (You can find this in your Db2 instance, under Administration > Connections)
55-
- Port (50001 is the default for Db2)
56-
- Database name (You can find this in your Db2 instance, under Administration > Connections)
57-
- User (This is the User ID that you created above)
58-
- Password (This is the password that you created above)
59-
- Security ([Enter "SSL" in this field](#ssltls))
60-
5. Click **Connect** to connect your Db2 warehouse to Segment.
46+
### Connect IBM Db2 to Segment
47+
48+
> info "Unified warehouse credentials in public beta"
49+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
50+
51+
To connect IBM Db2 to Segment:
52+
53+
1. Navigate to **Connections > Destinations** and select the **Storage** tab in the Segment app. Click **+Add storage destination**.
54+
2. Select *IBM Db2* as your warehouse.
55+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Db2 instance:
56+
* **Hostname**: The Db2 hostname (You can find this in your Db2 instance, under Administration > Connections)
57+
* **Port**: The port used for connecting to your Db2 warehouse. The default port for Db2 is 50001, but your port may be different
58+
* **Database name**: The database that Segment uses in order to sync data (You can find this in your Db2 instance, under Administration > Connections)
59+
* **Security**: Enter “SSL” in this field
60+
* **Username**: The Db2 user that Segment uses to run SQL in your warehouse
61+
* **Password**: The password of the user above
62+
4. Test your connection.
63+
5. Click **Save**.
6164

6265
## Security
6366

‎src/connections/storage/catalog/postgres/index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,26 @@ To create a new inbound rule:
8888

8989
8. Click **Save rules**.
9090

91+
## Connect Postgres to Segment
92+
93+
> info "Unified warehouse credentials in public beta"
94+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
95+
96+
To connect Postgres to Segment:
97+
98+
1. Navigate to your product area in the Segment app:
99+
* For Storage destinations, navigate to **Connections > Destinations** and select the **Storage** tab. Click **+ Add storage destination**.
100+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
101+
2. Select *Postgres* as your warehouse.
102+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Postgres instance:
103+
* **Hostname**: The Postgres hostname
104+
* **Port**: The port used for connecting to your Postgres warehouse
105+
* **Database name**: The database that Segment uses in order to sync data
106+
* **Username**: The Postgres user that Segment uses to run SQL in your warehouse
107+
* **Password**: The password of the user above
108+
4. Test your connection.
109+
5. Click **Save**.
110+
91111
## Sync schedule
92112

93113
{% include content/warehouse-sync-sched.md %}

‎src/connections/storage/catalog/redshift/index.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,23 @@ When you configure your warehouse in Segment, use the username/password you've c
5959

6060
## Connect Redshift to Segment
6161

62-
After creating a Redshift warehouse, the next step is to connect Segment:
63-
64-
1. In the Segment App, navigate to the Connections tab and click **Add Destination**
65-
2. Search for and select `Redshift`
66-
3. Add the necessary connection details, add your Redshift credentials
67-
4. Select which sources and collections/properties will sync to this Warehouse
62+
> info "Unified warehouse credentials in public beta"
63+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
64+
65+
To connect Redshift to Segment:
66+
67+
1. Navigate to your product area in the Segment app:
68+
* For Storage destinations, navigate to **Connections > Destinations** and select the **Storage** tab. Click **+ Add storage destination**.
69+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
70+
2. Select *Redshift* as your warehouse.
71+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Redshift instance:
72+
* **Hostname**: The Redshift URL
73+
* **Port**: The port used for connecting to your Redshift warehouse
74+
* **Database name**: The database that Segment uses in order to sync data
75+
* **Username**: The Redshift user that Segment uses to run SQL in your warehouse
76+
* **Password**: The password of the user above
77+
4. Test your connection.
78+
5. Click **Save**.
6879

6980
## Security
7081

‎src/connections/storage/catalog/snowflake/index.md‎

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -221,27 +221,28 @@ USE DATABASE "SEGMENT_EVENTS";
221221

222222
### Step 6: Connect Snowflake to Segment
223223

224-
After configuring your Snowflake resources, connect them to Segment.
225-
226-
1. In the Segment App, select Add Destination.
227-
2. Search for and select "Snowflake".
228-
3. Enter a name for your destination.
229-
4. Enter your Snowflake credentials as follows:
230-
- **Account**: The account id of your cluster, not the url (for example, url: `my-business.snowflakecomputing.com`, account-id: `my-business`. **Note:** If you are using Snowflake on AWS, the account id includes the region. For example, your url might be: `my-business.us-east-1.snowflakecomputing.com/` and your account-id would be: `my-business.us-east-1`)
231-
- **Warehouse**: The name of the warehouse that you created in [Step 1: Create a virtual warehouse](#step-1-create-a-virtual-warehouse)
232-
- **Database**: The database name that you created in [Step 2: Create database](#step-2-create-database)
233-
- **Username**: The username that you created in [Step 4: Create a user for Segment](#step-4-create-user-for-segment)
234-
- **Authentication method**: Select the authentication method that you used when creating a user in [Step 4: Create a user for Segment](#step-4-create-user-for-segment). You can select either Key pair or Password.
235-
236-
If you selected Key pair as your authentication method:
237-
- **Private key**: Upload your private key (stored in .p8 format) that you created in [Step 4: Create a user for Segment](#step-4-create-user-for-segment)
238-
- **Passphrase** _(Optional)_ : If you created an encrypted key, enter the passphrase you created in [Step 4: Create a user for Segment](#step-4-create-user-for-segment)
224+
> info "Unified warehouse credentials in public beta"
225+
> With unified warehouse credientials you can create warehouse credentials and use them across Segment warehouse products. Segment is actively working on this feature. Some functionality may change before it becomes generally available.
226+
227+
To connect Snowflake to Segment:
228+
229+
1. Navigate to your product area:
230+
* For Storage destinations, navigate to **Connections > Destinations** and select the **Storage** tab. Click **+ Add storage destination**.
231+
* For Profiles Sync, navigate to **Unify > Profiles Sync**.
232+
2. Select *Snowflake* as your warehouse.
233+
3. Select an existing warehouse credential or create a new warehouse credential by completing the following fields for your Snowflake instance.
234+
* Account ID: The Snowflake account ID that uniquely identifies your organization account, including a region suffix if applicable.
235+
* Database name: The database that Segment uses in order to sync data
236+
* Warehouse: The warehouse in your Snowflake account that Segment uses to run SQL
237+
* Username: The Snowflake user that Segment uses to run in your warehouse
238+
* Authentication
239+
* Private key: View Snowflake’s key pair set up doc.You can upload .p8 file format. Key length must be at least 2048-bit. An encrypted key is recommended but not required.
240+
4. Test your connection.
241+
5. Click **Save**.
239242

240243
> info "Segment supports uploading one key at a time"
241244
> Although you can create up to two keys in Snowflake, Segment only supports authenticating with one key at a time. To change the key that is in Segment, return to your Snowflake destination's settings and upload a new key in the **Private Key** field.
242-
243-
If you selected Password as your authentication method:
244-
- **Password**: The password that you set in [Step 4: Create a user for Segment](#step-4-create-user-for-segment)
245+
245246

246247
## Security
247248

0 commit comments

Comments
 (0)