Snowflake

Step-by-step guide on setting up Snowflake as a destination in RudderStack.

Snowflake is a cloud-based data warehouse provided as Software-as-a-Service (SaaS). It offers all the modern data warehouse features like scalability, ease of use, secure access to your data, advanced analytics capabilities, and more.

RudderStack lets you configure Snowflake as a destination to seamlessly store your event data.

Refer to the Warehouse Schemas guide for information on how the events are mapped to the Snowflake tables.

Find the open-source transformer code for this destination in the RudderStack GitHub repo.

Setting user permissions in Snowflake

To enable RudderStack access, make sure you have an ACCOUNTADMIN, or an account that has the MANAGE GRANTS privilege.

The following sections illustrate how to set up a virtual warehouse, a database, a role, and an user in Snowflake:

Creating a virtual warehouse

In your Snowflake console, create a X-Small warehouse:

Set your data warehouse size as per your data volume requirements.

Alternatively, you can create a new warehouse by running the following SQL commands:

CREATE WAREHOUSE "RUDDER_WAREHOUSE"
  WITH WAREHOUSE_SIZE = 'XSMALL'
    WAREHOUSE_TYPE = 'STANDARD'
    AUTO_SUSPEND = 600
    AUTO_RESUME = TRUE;

You can set AUTO_SUSPEND to ~10 mins and enable AUTO_RESUME to avoid any extra costs.

Creating a database

Create a new database to avoid conflicts with your existing data, as RudderStack creates its own tables while storing your events.

The following image demonstrates the Create Database option in Snowflake.

Alternatively, you can create a new database by running the following SQL command:

CREATE DATABASE "RUDDER_EVENTS";

Creating a role for RudderStack

Run the following SQL commands to create a new role with the required permissions to load your data into the newly-created warehouse:

  1. Create a new role called RUDDER:

CREATE ROLE "RUDDER";
  1. Grant access to the warehouse RUDDER_WAREHOUSE:

GRANT USAGE ON WAREHOUSE "RUDDER_WAREHOUSE" TO ROLE "RUDDER";
  1. Grant access to the database RUDDER_EVENTS:

GRANT USAGE ON DATABASE "RUDDER_EVENTS" TO ROLE "RUDDER";
GRANT CREATE SCHEMA ON DATABASE "RUDDER_EVENTS" TO ROLE "RUDDER";
GRANT ALL ON ALL SCHEMAS IN DATABASE "RUDDER_EVENTS" TO ROLE "RUDDER";

Creating a user

Finally, create a user to connect RudderStack to the newly-created Snowflake warehouse, as shown:

Alternatively, you can use SQL to create a user in Snowflake, as shown:

CREATE USER "RUDDER_USER"
  MUST_CHANGE_PASSWORD = FALSE
  DEFAULT_ROLE = "RUDDER"
  PASSWORD = "<your_password>";
GRANT ROLE "RUDDER" TO USER "RUDDER_USER";

Configuring Snowflake destination in RudderStack

To start sending data to Snowflake, you will first need to add it as a destination in RudderStack and connect it to a data source. Once the destination is enabled, the events will automatically start flowing to your Snowflake instance.

Follow these steps to configure your Azure data lake as a destination in RudderStack:

  1. From your RudderStack dashboard, configure the data source. Then, select Snowflake from the list of destinations.

  2. Assign a name to your destination and click on Next.

Connection settings

Enter the following credentials in the Connection Credentials page:

  • Account: Enter the account ID of your Snowflake warehouse. This account ID is part of the Snowflake URL.

The following examples illustrate the slight differences in the account ID for various cloud providers:

Account ID exampleCorresponding Snowflake URLSnowflake cloud provider

qya56091.us-east-1

https://qya56091.us-east-1.snowflakecomputing.com

AWS

rx18795.east-us-2.azure

https://rx18795.east-us-2.azure.snowflakecomputing.com

Microsoft Azure

ah76025.us-central1.gcp

https://ah76025.us-central1.gcp.snowflakecomputing.com

Google Cloud Platform

  • Database: Enter the name of the database created in the Creating a database section above.

  • Warehouse: Enter the name of the warehouse created in the Creating a virtual warehouse section above.

  • User: Enter the name of the user created in the Creating a user section above.

  • Password: Enter the password you set for the above user.

  • Namespace: Enter the schema name for the warehouse where RudderStack will create all the tables.

If you don't specify any namespace, RudderStack will set this to the source name by default.

  • Sync Frequency: Specify how often RudderStack should sync the data to your Snowflake warehouse.

  • Sync Starting At: This optional setting lets you specify the particular time of the day (in UTC) when you want RudderStack to sync the data to the warehouse.

  • Exclude Window: This optional setting lets you set a time window when RudderStack will not sync the data to the warehouse.

Configuring the object storage

RudderStack lets you configure the following object storage configuration settings while setting up your Snowflake destination:

  • Use RudderStack-managed Object Storage: Enable this setting to use RudderStack-managed buckets for object storage.

This option is applicable only for RudderStack-hosted data planes. For self-hosted data planes, you will have to specify your own object storage configuration settings.

  • Choose your Cloud: Select the cloud provider for your Snowflake instance.

Refer to the following settings depending on your cloud provider:

AWS Azure GCP

  • Staging S3 Storage Bucket Name: Specify the name of your S3 bucket where RudderStack will store the data before loading it into Snowflake.

  • Prefix: If specified, RudderStack will create a folder in the bucket with this prefix and push all the data within that folder.

  • Storage Integration: Refer to the Configuring Snowflake integration section for details.

  • AWS Access Key ID: Enter your AWS access key ID obtained from the AWS console.

  • AWS Secret Access Key: Enter the AWS secret access key. Refer to this Permissions section for more information.

  • Enable Server-side Encryption for S3: Toggle on this setting to enable server-side encryption for your S3 bucket.

  • Staging Azure Blob Storage Container Name: Specify the name of your Azure container where RudderStack will store the data before loading it into Snowflake.

  • Prefix: If specified, RudderStack will create a folder in the bucket with this prefix and push all the data within that folder.

  • Storage Integration: Refer to the Configuring Snowflake integration section for details.

  • Azure Blob Storage Account Name: Enter the account name for the Azure container.

  • Azure Blob Storage Account Key: Enter the account key for your Azure container. Refer to the Blob Storage setup section for more information.

  • Staging GCS Object Storage Bucket Name: Specify the name of your GCS bucket where RudderStack will store the data before loading it into Snowflake.

  • Prefix: If specified, RudderStack will create a folder in the bucket with this prefix and push all the data within that folder.

  • Storage Integration: Refer to the Configuring Snowflake integration section for details.

  • Credentials: Paste the contents of your GCP service account credentials JSON. The service account should have a role with storage.objectCreator access.

Configuring cloud storage integration with Snowflake

This section lists the steps required to configure the Storage Integration setting specified in the Configuring the object storage section above, depending on your cloud provider.

AWS

If you have Amazon Web Services (AWS) as your cloud provider and want to use S3 as your object storage, you will need to follow a few more steps to configure your cloud storage integration with Snowflake. You can find the detailed instructions in this Snowflake documentation.

  1. Create a policy in AWS: In the following JSON, replace <bucket_name> and <prefix> with the name of your S3 bucket and the prefix set in the Configuring the object storage section above, and create the policy with a name of your choice.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:GetObject",
        "s3:GetObjectVersion",
        "s3:DeleteObject",
        "s3:DeleteObjectVersion"
      ],
      "Resource": "arn:aws:s3:::<bucket_name>/<prefix>/*"
    },
    {
      "Effect": "Allow",
      "Action": "s3:ListBucket",
      "Resource": "arn:aws:s3:::<bucket_name>",
      "Condition": {
        "StringLike": {
          "s3:prefix": ["<prefix>/*"]
        }
      }
    }
  ]
}
  1. Create a role and attach the above policy in AWS: Follow the steps listed below:

    1. Create a role of type Another AWS account.

    2. Enter your AWS account ID and enable the Require External ID option.

    3. For external ID, you can add a dummy value like 0000. This can be modified later.

    4. Attach the policy created in Step 1. Assign a name to this role and keep the role ARN handy for the next step.

Keep this role ARN handy for the next step.

  1. Create the cloud storage integration in Snowflake: Replace <integration_name> with the name of your choice and <iam_role> with the role ARN obtained in Step 2 and run the following command:

CREATE STORAGE INTEGRATION <integration_name>
  TYPE = EXTERNAL_STAGE
  STORAGE_PROVIDER = S3
  ENABLED = TRUE
  STORAGE_AWS_ROLE_ARN = '<iam_role>'
  STORAGE_ALLOWED_LOCATIONS = ('s3://<bucket_name>/<path>/', 's3://<bucket_name>/<path>/')
  [ STORAGE_BLOCKED_LOCATIONS = ('s3://<bucket_name>/<path>/', 's3://<bucket_name>/<path>/') ]

Record the value for <integration_name>.

  1. Retrieve the AWS IAM user for your Snowflake account as shown:

Copy
DESC INTEGRATION <integration_name>;
  1. Grant the IAM user permissions to access the bucket objects in AWS. Choose the role you created in Step 2 and edit the trust relationship as shown in the following JSON:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "AWS": "<snowflake_user_arn>"
      },
      "Action": "sts:AssumeRole",
      "Condition": {
        "StringEquals": {
          "sts:ExternalId": "<snowflake_external_id>"
        }
      }
    }
  ]
}

Note that <snowflake_user_arn> is the STORAGE_AWS_ROLE_ARN option seen in Step 4, whereas <snowflake_external_id> is the STORAGE_AWS_EXTERNAL_ID.

  1. Grant integration access to the Snowflake role you created in the Creating a role for RudderStack section by running the following command:

GRANT usage ON integration <integration_name> TO ROLE "RUDDER"

Here, <integration_name> is the integration created in the Step 3.

Azure

If you have Microsoft Azure as your cloud provider and want to leverage Azure Blob Storage as your object storage, you will need to follow a few more steps to configure your storage integration with Snowflake. You can find the detailed instructions in this Snowflake documentation.

  1. Create a storage account and container in Azure: First, create a storage account in Azure. Then, navigate to Storage Explorer > Blob Containers > Create a Blob Container.

  2. Run the following commands to create a cloud storage integration in Snowflake:

CREATE STORAGE INTEGRATION <integration_name>
TYPE = EXTERNAL_STAGE
STORAGE_PROVIDER = AZURE
ENABLED = TRUE
AZURE_TENANT_ID = '<tenant_id>'
STORAGE_ALLOWED_LOCATIONS = ('azure://<account>.blob.core.windows.net/<container>/<path>/', 'azure://<account>.blob.core.windows.net/<container>/<path>/')
[ STORAGE_BLOCKED_LOCATIONS = ('azure://<account>.blob.core.windows.net/<container>/<path>/', 'azure://<account>.blob.core.windows.net/<container>/<path>/') ]

You can get your <tenant_id> by navigating to Azure Active Directory > Properties > Directory ID.

  1. Grant Snowflake access to the storage locations: Run the following command and replace <integration_name> with the integration name created in Step 2.

DESC INTEGRATION <integration_name>;

Record the values for AZURE_CONSENT_URL and AZURE_MULTI_TENANT_APP_NAME.

  1. Go to the URL obtained in AZURE_CONSENT_URL and accept the consent requirements.

  2. Grant Snowflake access to the container: Navigate to Azure Services > Storage Accounts and select the storage account created in Step 1.

  3. Add the role: Navigate to Access Control (IAM) > Add Role Assignment. Select either Storage Blob Data Reader with Read access, or Storage Blob Data Contributor with Read and Write access.

  4. Add Assign Access: Add Service Principal as the security principal type for the role. Search for AZURE_MULTI_TENANT_APP_NAME that you obtained in Step 3.

  5. Grant integration access to the Snowflake role you created in the Creating a role for RudderStack section by running the following command:

GRANT USAGE ON integration <integration_name> to role "RUDDER";

Here, <integration_name> is the integration you created in Step 2.

GCP

If you have Google Cloud Platform as your cloud provider and want to leverage Google Cloud Storage as your object storage, you will need to follow a few more steps to configure your storage integration with Snowflake. You can find the detailed instructions in this Snowflake documentation.

  1. Create a Cloud Storage integration in Snowflake: Run the following command:

CREATE STORAGE INTEGRATION <integration_name>
  TYPE = EXTERNAL_STAGE
  STORAGE_PROVIDER = GCS
  ENABLED = TRUE
  STORAGE_ALLOWED_LOCATIONS = ('gcs://<bucket>/<path>/', 'gcs://<bucket>/<path>/')

Replace <integration_name> with the name of your Cloud Storage integration, <bucket> with Staging GCS Object Storage Bucket Name, and <path> with the prefix set in the Configuring the object storage section above.

  1. The following command retrieves the Cloud Storage service account ID created for your Snowflake account, where <integration_name> is the integration name you specified in Step 1.

DESC STORAGE INTEGRATION <integration_name>;

The output of this command will have a property named as STORAGE_GCP_SERVICE_ACCOUNT. Retrieve this property value. It should be of the format service-account-id@UNIQUE_STRING.iam.gserviceaccount.com.

  1. Grant service account permissions to access the bucket objects: Create a custom IAM role with the required permissions to access the bucket and fetch the objects by following these steps:

    1. Log into the GCP console as a Project Editor.

    2. From the dashboard, go to IAM & Admin > Roles.

    3. Click on CREATE ROLE.

    4. Enter the title and description for the custom role.

    5. Click on ADD PERMISSIONS.

    6. Filter the following permissions in the Enter property name or value and add them to the list. Then, click on ADD.

    Permission name

    storage.buckets.get

    storage.objects.get

    storage.objects.list

    storage.objects.create

  2. Assign the custom role to the Cloud Storage service account:

    1. In your GCP console dashboard, go to Cloud Storage > Browser.

    2. Select the bucket to configure the access.

    3. Select SHOW INFO PANEL in the upper right corner. The information panel for the bucket will pop out.

    4. In the Add Members section, get the service account name from the DESC command run in Step 2.

    5. From the Select a role dropdown, select Storage > Custom > <role>, where <role> is the custom Cloud Storage role.

    6. Click on the ADD button. The service account name will be added to the Storage Object Viewer role dropdown in the information panel.

  3. Grant integration access to the Snowflake role you created in the Creating a role for RudderStack section by running the following command:

GRANT USAGE ON INTEGRATION <integration_name> TO ROLE "RUDDER";

Here, <integration_name> is the integration name you set up in Step 1.

IPs to be whitelisted

To enable network access to RudderStack, you will need to whitelist the following RudderStack IPs:

  • 3.216.35.97

  • 34.198.90.241

  • 54.147.40.62

  • 23.20.96.9

  • 18.214.35.254

  • 35.83.226.133

  • 52.41.61.208

  • 44.227.140.138

  • 54.245.141.180

  • 3.66.99.198

  • 3.64.201.167

If you have your deployment in the EU region, you can whitelist only the following two IPs:

  • 3.66.99.198

  • 3.64.201.167

All the outbound traffic is routed through these RudderStack IPs.

Contact us

For queries on any of the sections covered in this guide, you can contact us or start a conversation in our Slack community.

Last updated