Creating, joining, removing, and uninstalling clean rooms¶

The Clean Rooms page in the web app lets you, as a provider, manage the lifecycle of a clean room, including creating and sharing. If you don’t have access to the clean rooms web app, speak to a clean rooms administrator for your Snowflake account.

To create and share a clean room, do the following:

1. Sign in to your clean room environment in the web app.

2. In the left navigation, select Clean Rooms.

3. Select + Clean Room. The creation process has the following steps:

   1. Use the Add Data step to name the clean room and select the tables that are being shared with the consumer. The name can be 80 characters maximum, case-insensitive a-z, 0-9, spaces, and underscores.

   2. Use the Specify Join Policies step to enable identity providers enabled by your clean rooms account administrator and select which columns the consumer can join on.

   3. Use the Configure Analysis & Query step to define which templates are available in the clean room, template-specific configuration settings, and addtional features such as activation and privacy settings.

   4. Use the Share Clean Room step to invite consumers to use the clean room to collaborate. You can also use the Enable Run Analysis & Query option to specify which collaborators can run analyses in the clean room.

For a full walkthrough of creating a new clean room in the web application, try the clean rooms web app tutorial

To create a new clean room in code, you must be granted the SAMOOHA_APP_ROLE role in your account.

USE WAREHOUSE app_wh;
USE ROLE samooha_app_role;
SET cleanroom_name = 'Developer Tutorial';
CALL samooha_by_snowflake_local_db.provider.cleanroom_init(
  $cleanroom_name,
  'INTERNAL');      -- Use EXTERNAL to share outside your Snowflake org

After creating your clean room, you must, at minimum, perform the following steps to configure a basic clean room:

1. Import data into the clean room.

2. Set join policies on your data.

3. Specify one or more templates in the clean room.

4. Set column policies on your data for each template.

5. Set a default release directive.

6. Specify consumers to share the clean room with.

7. Publish the clean room.

For a full walkthrough of creating a new clean room in code, try the clean rooms code tutorial

The Clean Rooms page in the web app lets you, as a consumer, install clean rooms that have been shared with you by a provider. To install a clean room, do the following:

1. Sign in to your clean room environment in the web app.

2. In the left navigation, select Clean Rooms.

3. On the Invited tab, find the clean room and select Join. You should get a direct link to this page in an invitation email when you are added as a collaborator in the web application.

4. Select the tables that you want to use to collaborate with the provider’s data, then select Next.

5. Select any identity providers available in your clean rooms environment that you need to use in this clean room.

6. Specify which columns in your table can be joined, and the corresponding columns from the provider’s data.

7. Select Next.

8. Provide template-specific settings for any templates assigned to the clean room.

9. Click Finish, and optionally run a template immediately, or schedule a repeating run of that template.

If you have been invited to join a clean room as a consumer, you can install, configure, and run the clean room in code.

To join a clean room in code, open up the account that was invited to add the clean room, and run the following code:

USE WAREHOUSE app_wh;
USE ROLE samooha_app_role;
SET cleanroom_name = 'Developer Tutorial'; -- Get the actual clean room name and provider's account locator from the provider.
CALL samooha_by_snowflake_local_db.consumer.
  install_cleanroom($cleanroom_name, <PROVIDER_LOCATOR>);

After the clean room is installed, you must take the following steps, at minimum, to be able to run templates in that clean room:

1. Link your data.

2. Set join and column policies on your tables and for the templates that you want to run.

3. Run the template.

For a full walkthrough of joining a clean room in code, try the clean rooms code tutorial

To use the web application to delete a clean room that you created, do the following:

1. Sign in to your clean room environment in the web app.

2. In the left navigation, select Clean Rooms.

3. In the clean room to delete, select More () > Delete.

• To delete a single clean room using the API, call provider.drop_cleanroom.

• To list your created clean rooms, call provider.view_cleanrooms:

  USE ROLE samooha_app_role;
  USE WAREHOUSE app_wh;
  
  -- List created and published clean rooms
  CALL samooha_by_snowflake_local_db.provider.view_cleanrooms();
  SELECT CLEANROOM_ID AS "cleanroom_name"
    FROM TABLE(RESULT_SCAN(last_query_id()))
    WHERE STATE = 'CREATED' AND IS_PUBLISHED = TRUE;
  
  -- Specify a clean room name from the list and drop it
  CALL samooha_by_snowflake_local_db.provider.drop_cleanroom($cleanroom_name);
  

  Copy

For a full walkthrough of creating, configuring, using, and deleting a clean room in code, try the clean rooms code tutorial

1. Sign in to your clean room environment in the web app.

2. In the left navigation, select Clean Rooms.

3. Navigate to Clean Rooms » Joined

4. In the clean room to uninstall, select More () > Leave.

To list your installed (joined) clean rooms

Call samooha_by_snowflake_local_db.consumer.view_cleanrooms and filter rows to IS_ALREADY_INSTALLED = TRUE. This shows clean rooms that are installed rather than simply invitations to join.

USE ROLE samooha_app_role;
USE WAREHOUSE app_wh;

CALL samooha_by_snowflake_local_db.consumer.view_cleanrooms();
SELECT CLEANROOM_ID AS "cleanroom_name"
  FROM TABLE(RESULT_SCAN(last_query_id()))
  WHERE IS_ALREADY_INSTALLED = TRUE;

CALL samooha_by_snowflake_local_db.consumer.uninstall_cleanroom($cleanroom_name);

To uninstall (unjoin) a single clean room:

USE ROLE samooha_app_role;
USE WAREHOUSE app_wh;
CALL samooha_by_snowflake_local_db.consumer.
  uninstall_cleanroom($cleanroom_name).

For a full walkthrough of creating, configuring, using, and deleting a clean room in code, try the clean rooms code tutorial