使用 Snowflake Collaboration Data Clean Room¶

-- Basic Snowflake Collaboration Data Clean Rooms example.
-- This file represents user "alice" in a two-collaborator clean room example.

-- Run this worksheet in a Snowflake account with access to the latest version of
-- Snowflake Data Clean Rooms.

-- This file demonstrates the following actions:
-- * How to register a template and a dataset
-- * How to create a collaboration with pre-registered resources.
-- * How to add a template to a collaboration that has already been created, and the
--   template approval flow.
-- * How to run an analysis.

-- For more information, read docs.snowflake.com/user-guide/cleanrooms/v2/using

USE WAREHOUSE APP_WH;
USE ROLE SAMOOHA_APP_ROLE;

-- Secondary roles must be disabled to call link_data_offerings and join.
USE SECONDARY ROLES NONE;

-- Register a data offering to use in the initial collaboration definition.
CALL samooha_by_snowflake_local_db.registry.register_data_offering(
    $$
    api_version: 2.0.0
    spec_type: data_offering
    version: v1
    name: alice_data
    datasets:
     - alias: customer_list
       data_object_fqn: SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS
       object_class: custom
       allowed_analyses: template_only
       schema_and_template_policies:
         hashed_email:
           category: join_standard
           column_type: hashed_email_b64_encoded
           
         status:
           category: passthrough
    $$
    );
-- Save the ID of the registered data offering. 
SET my_data_offering_id = '<data_offering_id>';

CALL samooha_by_snowflake_local_db.registry.view_registered_data_offerings();

-- Register a template to use in the initial collaboration definition.
CALL samooha_by_snowflake_local_db.registry.register_template(
$$
api_version: 2.0.0
spec_type: template
name: alice_test_template
version: 2026_01_12_V1
type: sql_analysis
description: A test template
template:
  SELECT t1.status, COUNT(*)
    FROM IDENTIFIER( {{ source_table[0] }} ) AS t1
    JOIN IDENTIFIER( {{ source_table[1] }} ) AS t2
    ON t1.hashed_email = t2.hashed_email
    GROUP BY t1.status;
$$);

-- Save the ID of the registered template.
SET my_template_id = '<template_id>';
CALL samooha_by_snowflake_local_db.registry.view_registered_templates();


-- Create a collaboration with the previously registered template and data offering.
-- The collaboration supports two collaborators, with aliases alice (this account) and bob.
-- Owner: alice
-- Analysis runners:
--   * alice, using her own data, and the template you created and registered earlier.
--   * bob, with no listed templates or data.
-- Data providers:
--   * alice and bob, for alice
--   * alice and bob, for bob
-- Resources added: The template and data offering alice registered earlier.
-- You will add more templates and data offerings to these users later. Only these
-- users are invited to the collaboration, and no additional users can be added later.
-- Replace the <...> placeholders with the appropriate values.
-- Account data sharing IDs are -- SELECT CURRENT_ORGANIZATION_NAME() || '.' || CURRENT_ACCOUNT_NAME();
CALL samooha_by_snowflake_local_db.collaboration.initialize(
$$
api_version: 2.0.0
spec_type: collaboration
name: my_first_collaboration
owner: alice
collaborator_identifier_aliases:
  alice: <my account data sharing ID>
  bob: <other account data sharing ID>
analysis_runners:
  bob:
    data_providers:
      alice:
        data_offerings: []
      bob:
        data_offerings: []
  alice:
    data_providers:
      alice:
        data_offerings:
        - id: <data offering ID>
      bob:
        data_offerings: []
    templates:
    - id: <template ID>
$$
);
SET collaboration_id = '<collaboration_id>';

-- Creating a collaboration is asynchronous. Check to see when collaboration is CREATED.
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_id);

-- Collaboration is visible here when it's created.
CALL samooha_by_snowflake_local_db.collaboration.view_collaborations();

-- Join the collaboration that you created.
CALL samooha_by_snowflake_local_db.collaboration.join($collaboration_id);

-- Joining a collaboration is asynchronous. Call get_status until the status is JOINED.
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_id);

-- Auto-approve any template requests from other collaborators that affect you.
CALL samooha_by_snowflake_local_db.collaboration.enable_template_auto_approval(
  $collaboration_id
);

-- SWITCH TO collaborator to join the collaboration and add a template.

-- Create a new template.
CALL samooha_by_snowflake_local_db.registry.register_template(
    $$
    api_version: 2.0.0
    spec_type: template
    name: limit_5_template
    version: 2026_01_12_V1
    type: sql_analysis
    description: test_description
    template:
      select * from identifier({{ source_table[0] }}) limit 5;
    
    $$
);
SET limit_5_template = '<template ID>';

-- Ask bob if they want to use your new template.
CALL samooha_by_snowflake_local_db.collaboration.add_template_request(
  $collaboration_id,
  $limit_5_template,
  ['alice', 'bob']   -- List of collaborators who can use this template.
  );

-- SWITCH TO bob to approve the request. Request wasn't approved automatically
-- because bob didn't enable auto-approve.

-- See if bob approved the request.
CALL samooha_by_snowflake_local_db.collaboration.view_update_requests($collaboration_id);

-- See what the collaboration spec looks like now, after all the resource updates.
-- Collaboration updates are asynchronous, so if all changes that you made aren't present,
-- wait a minute or two, and then try again.
CALL samooha_by_snowflake_local_db.collaboration.view_collaborations() ->>
  SELECT "COLLABORATION_SPEC" FROM $1 WHERE "SOURCE_NAME" = $collaboration_id;

-- Run an analysis.
-- Tables are scoped as <data_offering_id>.<alias>.
CALL samooha_by_snowflake_local_db.collaboration.view_data_offerings(
  $collaboration_id
);
SET $bob_offering = '<bob data offering ID>';

CALL samooha_by_snowflake_local_db.collaboration.view_templates(
  $collaboration_id
);

CALL samooha_by_snowflake_local_db.collaboration.run(
  $collaboration_id,
  $my_template_id,
  [                                            -- Populate the source_table template variable.
    'alice.' || $my_data_offering_id || '.customer_list',  -- Specify which view in the data offering to use.
    'bob.' || $bob_offering || '.my_customer_list'
  ],
  [],
  {}
  );

-- Multi-step cleanup process to delete the collaborations.
-- Doesn't delete registered resources.
CALL samooha_by_snowflake_local_db.collaboration.teardown($collaboration_id);
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_id);

-- When get_status reports LOCAL_DROP_PENDING, call teardown again.
CALL samooha_by_snowflake_local_db.collaboration.teardown($collaboration_id);

-- Basic Snowflake Collaboration Data Clean Rooms example.
-- This file represents user "bob" in a two-collaborator clean room example.

-- Run this worksheet in a Snowflake account with access to the latest version of
-- Snowflake Data Clean Rooms.

-- This file  demonstrates the following actions:
-- * Joining a collaboration
-- * Registering and adding a template and a data offering to an existing collaboration.
-- * Running an analysis.

-- For more information, read docs.snowflake.com/user-guide/cleanrooms/v2/using

USE WAREHOUSE APP_WH;
USE ROLE SAMOOHA_APP_ROLE;

-- Secondary roles can't be active when calling join or link_data_offering.
USE SECONDARY ROLES NONE;

-- Create a template.
CALL samooha_by_snowflake_local_db.registry.register_template(
    $$
    api_version: 2.0.0
    spec_type: template
    name: limit_10_template
    version: 2026_01_12_V1
    type: sql_analysis
    description: test_description
    template:
      SELECT * FROM IDENTIFIER({{ SOURCE_TABLE[0] }}) LIMIT 10;
    $$
);
SET limit_10_template = 'limit_10_template_2026_01_12_V1'; --'<template_id>';

-- See which collaborations you are invited to, or have joined.
CALL samooha_by_snowflake_local_db.collaboration.view_collaborations();

-- Use SOURCE_NAME column value from the response to view_collaborations().
SET collaboration_id = '<collaboration_id>';

-- Use OWNER_ACCOUNT column value from the response to view_collaborations().
SET collaborator_data_sharing_id = '<collaborator_id>';

-- Review and join the collaboration.
-- Joining is asynchronous, so you must call get_status until the status is JOINED before
-- you can perform actions on the collaboration.
CALL samooha_by_snowflake_local_db.collaboration.review($collaboration_id, $collaborator_data_sharing_id);
CALL samooha_by_snowflake_local_db.collaboration.join($collaboration_id);
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_id);

-- Offer to share a template with alice but not yourself.
-- Alice enabled auto-approve on her account, so this request will
-- be auto-approved, and the template will be added immediately.
CALL samooha_by_snowflake_local_db.collaboration.add_template_request($collaboration_id, $limit_10_template, ['alice']);
CALL samooha_by_snowflake_local_db.collaboration.view_update_requests($collaboration_id);

-- View templates that you can use in this collaboration. Notice that you can only see your own templates because
-- the initial collaboration spec permitted the other template only to alice, not to you (bob).
CALL samooha_by_snowflake_local_db.collaboration.view_templates($collaboration_id);

-- SWITCH TO other account and request adding a template, and then come back to approve the request.

-- You haven't enabled template auto-approve, so you must approve the request before the template is added.
CALL samooha_by_snowflake_local_db.collaboration.view_update_requests($collaboration_id);
CALL samooha_by_snowflake_local_db.collaboration.approve_update_request(
  $collaboration_id,
  '<request_ID>'
);

-- Register your own data offering.
CALL samooha_by_snowflake_local_db.registry.register_data_offering(
    $$
    api_version: 2.0.0
    spec_type: data_offering
    version: v1
    name: bob_data
    datasets:
     - alias: my_customer_list
       data_object_fqn: SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS_2
       object_class: custom
       allowed_analyses: template_only
       schema_and_template_policies:
         hashed_email:
           category: join_custom
         status:
           category: passthrough
    $$
);

SET my_data_id = '<data offering id>';

-- Share the data offering with yourself and alice.
CALL samooha_by_snowflake_local_db.collaboration.link_data_offering(
  $collaboration_id,
  $my_data_id,
  ['alice', 'bob']
);

-- Run an analysis with your template.
CALL samooha_by_snowflake_local_db.collaboration.run(
  $collaboration_id,
  $limit_10_template,
  [
    $my_data_id || '.my_customer_list',
  ],
  [], -- No local data needed.
  {}  -- No template arguments needed.
);
  
-- SWITCH TO other account to run an analysis.

-- Try running an analysis using the template that you shared with alice but not yourself.
-- This will fail, because you aren't listed as an analysis
-- runner for this template.
CALL samooha_by_snowflake_local_db.collaboration.run(
  $collaboration_id,
  $limit_10_template,
  [
    $my_data_id || '.my_customer_list'
  ],
  [],
  {}
  );