[Ultimate]{class="badge positive"}
Connect Snowflake to Experience Platform using the Flow Service API
Read this guide to learn how you can connect your Snowflake source account to ÃÛ¶¹ÊÓƵ Experience Platform using the .
Getting started
This guide requires a working understanding of the following components of ÃÛ¶¹ÊÓƵ Experience Platform:
- Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Experience Platform services.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Experience Platform instance into separate virtual environments to help develop and evolve digital experience applications.
Using Experience Platform APIs
For information on how to successfully make calls to Experience Platform APIs, see the guide on getting started with Experience Platform APIs.
The following section provides additional information that you will need to know in order to successfully connect to Snowflake using the Flow Service API.
Connect Snowflake to Experience Platform on Azure azure
Read the steps below for information on how to connect your Snowflake source to Experience Platform on Azure.
Gather required credentials
You must provide values for the following credential properties to authenticate your Snowflake source.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
---|---|
Credential | Description |
account |
An account name uniquely identifies an account within your organization. In this case, you must uniquely identify an account across different Snowflake organizations. To do this, you must prepend your organization name to the account name. For example: orgname-account_name . Read the guide on retrieving your Snowflake account identifier for additional guidance. For more information, refer to the . |
warehouse |
The Snowflake warehouse manages the query execution process for the application. Each Snowflake warehouse is independent from one another and must be accessed individually when bringing data over to Experience Platform. |
database |
The Snowflake database contains the data you want to bring the Experience Platform. |
username |
The username for the Snowflake account. |
password |
The password for the Snowflake user account. |
role |
The default access control role to use in the Snowflake session. The role should be an existing one that has already been assigned to the specified user. The default role is PUBLIC . |
connectionString |
The connection string used to connect to your Snowflake instance. The connection string pattern for Snowflake is jdbc:snowflake://{ACCOUNT_NAME}.snowflakecomputing.com/?user={USERNAME}&password={PASSWORD}&db={DATABASE}&warehouse={WAREHOUSE} |
To use key-pair authentication, you must generate a 2048-bit RSA key pair and then provide the following values when creating an account for your Snowflake source.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Credential | Description |
account |
An account name uniquely identifies an account within your organization. In this case, you must uniquely identify an account across different Snowflake organizations. To do this, you must prepend your organization name to the account name. For example: orgname-account_name . Read the guide on retrieving your Snowflake account identifier for additional guidance. For more information, refer to the . |
username |
The username of your Snowflake account. |
privateKey |
The Base64-encoded private key of your Snowflake account. You can generate either encrypted or unencrypted private keys. If you are using an encrypted private key, then you must also provide a private key passphrase when authenticating against Experience Platform. Read the guide on retrieving your Snowflake private key for more information. |
privateKeyPassphrase |
The private key passphrase is an additional layer of security that you must use when authenticating with an encrypted private key. You are not required to provide the passphrase if you are using an unencrypted private key. |
database |
The Snowflake database that contains the data you want to ingest to Experience Platform. |
warehouse |
The Snowflake warehouse manages the query execution process for the application. Each Snowflake warehouse is independent from one another and must be accessed individually when bringing data over to Experience Platform. |
For more information about these values, refer the .
PREVENT_UNLOAD_TO_INLINE_URL
flag to FALSE
to allow data unloading from your Snowflake database to Experience Platform.Create a base connection for Snowflake on Experience Platform on Azure azure-base
A base connection retains information between your source and Experience Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.
To create a base connection ID, make a POST request to the /connections
endpoint while providing your Snowflake authentication credentials as part of the request body.
API format
POST /connections
accordion | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Request | ||||||||||
The following request creates a base connection for Snowflake:
|
accordion | ||
---|---|---|
Response | ||
A successful response returns the newly created connection, including its unique connection identifier (
|
accordion | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | ||||||||||||||||||||
|
accordion | ||
---|---|---|
Response | ||
A successful response returns the newly created connection, including its unique connection identifier (
|
accordion | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Request | ||||||||||||||||||
|
accordion | ||
---|---|---|
Response | ||
A successful response returns the newly created connection, including its unique connection identifier (
|
Connect Snowflake to Experience Platform on Amazon Web Services (AWS) aws
Read the steps below for information on how to connect your Snowflake source to Experience Platform on AWS.
Create a base connection for Snowflake on Experience Platform in AWS aws-base
API format
POST /connections
Request
The following request creates a base connection for Snowflake to ingest date to Experience Platform on AWS:
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
---|---|
Property | Description |
auth.params.host |
The host URL that your Snowflake account connects to. |
auth.params.port |
The port number that is used by Snowflake when connecting to a server over the internet. |
auth.params.username |
The username associated with your Snowflake account. |
auth.params.database |
The Snowflake database from where the data will be pulled from. |
auth.params.password |
The password associated with your Snowflake account. |
auth.params.warehouse |
The Snowflake warehouse that you are using. |
auth.params.schema |
The name of the schema associated with your Snowflake database. You must ensure that the user you want to give database access to, also has access to this schema. |
Response
A successful response returns details of the newly created connection, including its unique identifier (id
). This ID is required to explore your storage in the next tutorial.
code language-json |
---|
|
By following this tutorial, you have created a Snowflake base connection using the Flow Service API. You can use this base connection ID in the following tutorials: