Installing the Snowflake Data Clean Rooms environment¶
Before you begin¶
If the Snowflake Data Clean Room environment is not installed for your account, follow the installation instructions on this page.
If the clean rooms environment is installed for your account, and you want access to it, ask an administrator to provide you appropriate privileges to conduct clean room operations in your account.
Supported regions¶
Snowflake Data Clean Rooms are available for Snowflake accounts in the following cloud regions:
Cloud platform |
Supported regions |
|---|---|
Amazon Web Services (AWS) |
|
Microsoft Azure |
|
Google Cloud (GCP) |
|
Requirements to install Snowflake Data Clean Rooms¶
Account, installer, and user requirements¶
When you install the clean rooms environment, you install it for all potential users in the Snowflake account. However, access to the clean rooms environment must be granted to users explicitly by a clean rooms administrator.
Here are the requirements to install Snowflake Data Clean Rooms in your Snowflake account:
The account must be the required Snowflake Edition:
To create collaborations and be an owner, you must have Standard Edition or higher.
To join a collaboration as an analysis runner, you must have Standard Edition or higher.
To join a collaboration as a data provider or activate data to another collaborator, you must have Enterprise Edition or higher.
The installer must fulfill these role and user requirements.
Reader accounts are not supported, because reader accounts do not allow the data sharing required to install and run the clean rooms application.
You must accept data sharing terms. If you have not accepted the Snowflake Customer-Controlled Data Sharing Functionality Terms, please contact Snowflake Support. Snowflake Data Clean Rooms leverage listings, which are part of the Snowflake Service and subject to your Service terms with Snowflake, including the Snowflake Customer-Controlled Data Sharing Functionality Terms and Snowflake Acceptable Use Policy.
You must unset any unsupported account-level parameters. See the list of unsupported account-level settings.
If you do not meet all these requirements and need to upgrade, contact Snowflake Support.
Unsupported account-level parameters¶
Snowflake Data Clean Rooms does not support certain account-level parameter values. The following table shows the required values for these parameters:
Parameter name |
Required value |
Notes |
|---|---|---|
DEFAULT_DDL_COLLATION |
No values supported, must be null |
Account-level collation is not supported. |
QUOTED_IDENTIFIERS_IGNORE_CASE |
|
To check a parameter in your account, run the following SQL command, substituting the parameter name for <parameter_name>:
For example:
Role and user requirements¶
Here are the role requirements for the person installing the clean rooms environment:
You must have an ACCOUNTADMIN role in a Snowflake account in order to install the clean rooms environment in that account.
The user with the ACCOUNTADMIN role must have a valid first name, last name, and email defined for their user object. To check, run DESCRIBE USER.
Install the Snowflake Data Clean Rooms environment¶
Follow these steps to install the clean rooms environment in your Snowflake account.
You must always install the native app (Step 1), but after that you can enable the clean rooms API for code usage (Step 2).
1. Install the native application¶
Install the native application from the marketplace:
Set your current role to ACCOUNTADMIN
Install the Snowflake Data Clean Rooms application from the Snowflake Marketplace
Select Open and accept the default options.
Installation takes several minutes. When done, proceed to step 2.
2. Install the clean rooms API¶
The clean rooms API is required to use clean rooms either through the UI or the API.
Here are the steps to install the clean rooms API in your Snowflake account:
After installing the native application, launch it in Snowflake. In the navigation menu, select Catalog » Apps » Snowflake Data Clean Rooms » Launch app. This opens a worksheet with SQL commands.
Run the SQL commands to install the clean rooms API, with the following notes:
If you renamed the native application during installation you will need to modify the script as indicated in the script comments.
If you want to review the full installation script before running it, uncomment the
DRY_RUN=TRUEscript line and run all commands up to and including that line to see the script contents. Note that you should not run the installation script exposed by that command manually, as it might result in an incomplete installation.Note that installation takes several minutes.
Confirm that you can access the API:
If this returns FALSE, confirm you are using SAMOOHA_APP_ROLE and if so please retry running the mount script command by ACCOUNTADMIN role again.
Next steps¶
After you have installed the clean room environment on your account successfully, you can proceed with the following:
Add developers. Grant access to roles in your Snowflake account, so they can access the clean room environments based on specific privileges.
Enable Cross-Cloud Auto-Fulfillment. By default, clean rooms can be shared only with participants in the same underlying cloud region. To enable collaborations with collaborators in different cloud regions, you must enable Cross-Cloud Auto-Fulfillment for your account.
Enable automatic clean room version updates. Enable the clean rooms API environment to be updated automatically whenever Snowflake releases a new version. You can also install updates manually, but we recommend enabling automatic updates.