Verwenden von Snowflake Collaboration Data Clean Rooms¶

Anforderungen¶

• Snowflake Data Clean Rooms muss auf die neueste Version aktualisiert sein.

• Eigentümer und Datenanbieter müssen die Snowflake Enterprise Edition verwenden. Analysenausführende können die Standard Edition verwenden.

• Sie benötigen Zugriff auf die Data Clean Rooms Collaboration- API, um Zusammenarbeiten sehen oder verwalten zu können. Weitere Informationen dazu finden Sie unter Verwalten des Zugriffs auf die DCR Collaboration-API.

• Sie sollten Sekundärrollen in Ihrer Umgebung deaktivieren, wenn Sie die Collaboration-API verwenden:

  USE SECONDARY ROLES NONE;
  

  Copy

Grundlegender Workflow für die Zusammenarbeit im Clean Room¶

Hier ist ein einfaches Szenario für die Zusammenarbeit im Clean Room:

1. Der Eigentümer der Zusammenarbeit kann optional alle Vorlagen oder Datenangebote registrieren, die in der anfänglichen Konfiguration der Zusammenarbeit vorhanden sein sollen.

2. Der Eigentümer bittet optional alle vorgesehenen Teilnehmenden, Vorlagen oder Datenangebote zu registrieren, die in der Erstkonfiguration der Zusammenarbeit angezeigt werden sollen. Die Mitarbeiter geben dann die Ressourcen-IDs von allen Elementen an, die sie registriert haben.

3. Der Eigentümer erstellt dann eine Zusammenarbeit. Die Zusammenarbeit wird durch eine Zusammenarbeits-YAML-Spezifikation definiert, die die Teilnehmenden, deren Rollen und alle Ressourcen auflistet, die in der ersten Version der Zusammenarbeit vorhanden sein sollen.

   • Wenn eine Zusammenarbeit erstellt wird, ist die Menge der Teilnehmenden und ihrer Rollen festgelegt: Nur Teilnehmende mit einer Rolle in der Definition der Zusammenarbeit werden zum Beitritt eingeladen. Ebenso ist der Satz der Analyseausführenden festgelegt. Jeder Teilnehmende kann jedoch auch ein Datenanbieter werden, indem er neue Daten mit der Zusammenarbeit verknüpft.

   • Wenn Ihre Zusammenarbeit Benutzende in anderen Cloudhosting-Regionen umfasst, müssen diese die Cloud-übergreifende automatische Ausführung für ihr Konto aktivieren, bevor sie die Zusammenarbeit überprüfen und ihr beitreten können.

4. Der Eigentümer tritt der von ihm erstellten Zusammenarbeit bei, wodurch die Zusammenarbeit aktiv wird. Die Zusammenarbeit ist jetzt für jeden Teilnehmenden in der Spezifikation sichtbar und zum Beitreten verfügbar.

5. Teilnehmende überprüfen die Zusammenarbeit und treten ihr bei.

6. Teilnehmende können dann optional Ressourcen zur Zusammenarbeit hinzufügen, wie z. B. Vorlagen, und, auch wenn es sich um einen Datenanbieter handelt, Datenangebote.

7. Analyseausführende können dann alle Vorlagen ausführen, die ihnen in der Zusammenarbeit zugewiesen sind, wobei sie alle Daten verwenden können, die ihnen in der Zusammenarbeit zur Verfügung stehen (sowie optional nicht freigegebene lokale Daten). Der Analyseausführende trägt die Kosten der Analyse. Vorlagen können die Abfrageergebnisse entweder in der Antwort zurückgeben oder Ergebnisse für den Aufrufenden oder einen anderen Teilnehmenden aktivieren.

In den folgenden Abschnitten werden die Details zu jedem dieser Schritte beschrieben.

Erstellen einer Zusammenarbeit¶

Um eine Zusammenarbeit zu erstellen, entwerfen Sie eine Zusammenarbeitsspezifikation, die alle Teilnehmenden und deren Rollen definiert. Optional registriert der Eigentümer der Zusammenarbeit sie und verknüpft alle anderen Ressourcen, die im Rahmen der anfänglichen Zusammenarbeit zur Verfügung gestellt werden sollen, und er schließt die Ressourcen in die Zusammenarbeitsspezifikation ein. Wenn der Eigentümer erwartet, dass Ressourcen von Teilnehmenden verwendet werden, kann der Eigentümer diese Benutzenden auch auffordern, ihre Ressourcen zu registrieren und dem Eigentümer die Ressourcen-IDs zu nennen, die in die Zusammenarbeitsspezifikation aufgenommen werden sollen.

Der Eigentümer ruft dann INITIALIZE auf, um mit der Erstellung der Zusammenarbeit zu beginnen. Standardmäßig verbindet INITIALIZE auch automatisch den Eigentümer mit der Zusammenarbeit. Dies ist ein asynchroner Prozess, daher muss GET_STATUS so lange aufgerufen werden, bis der Status JOINED lautet. Wenn der Status der Zusammenarbeit JOINED lautet, ist die Zusammenarbeit aktiv, und alle Teilnehmenden können die Zusammenarbeit sehen und ihr beitreten.

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: example_com.acct_abc
  bob: another_example.acct_xyz
analysis_runners:
  bob:
    data_providers:
      alice:
        data_offerings: []
      bob:
        data_offerings: []
  alice:
    data_providers:
      alice:
        data_offerings: []
      bob:
        data_offerings: []
    templates: []
$$,
'APP_WH'
);
SET collaboration_name = '<collaboration_name>';

-- INITIALIZE automatically joins the owner. Check status until JOINED.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.GET_STATUS($collaboration_name);

-- Collaboration is visible here when it's joined.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_COLLABORATIONS();

Ressourcen zu einer Zusammenarbeit hinzufügen¶

Jeder Teilnehmende kann Ressourcen zu einer Zusammenarbeit hinzufügen oder Ressourcen entfernen, die er der Zusammenarbeit hinzugefügt hat. Es gibt zwei Schritte, um eine Ressource zu einer Zusammenarbeit hinzuzufügen:

1. Der Ressourceneigentümer erstellt eine Ressourcendefinitionsspezifikation für die Ressource und verwendet sie, um die Ressource in seinem Konto zu registrieren. Sie können die Ressource in der Standard-Registry Ihres Kontos registrieren, oder Sie können eine benutzerdefinierte Registry verwenden.

2. Ein Teilnehmender verknüpft die Ressource mit einer Zusammenarbeit. Nachdem die Ressource mit verknüpft wurde, kann sie von den angegebenen Teilnehmenden verwendet werden. Einige Ressourcentypen, wie z. B. Vorlagen, können von jedem Teilnehmenden eingebunden werden. Andere Ressourcen, wie z. B. Datenangebote, können nur von Benutzenden mit einer Datenanbieterrolle verknüpft werden. Ressourcen stehen in der Regel nur bestimmten Teilnehmenden zur Verfügung, die in der Zusammenarbeitsspezifikation und der Ressourcenfreigabe definiert sind.

Ressourcen können einer Zusammenarbeit entweder vor oder nach dem Erstellen einer Zusammenarbeit hinzugefügt werden.

Ressourcen unterstützen die Versionierung. Das Erstellen einer neuen Ressource mit einer neuen Version entfernt jedoch nicht die vorherige Version aus der Zusammenarbeit.

Ressourcen werden eindeutig benannt, indem der vom Benutzenden angegebene Name und die Version (und Alias bei Datenangeboten) kombiniert werden.

Sie können die folgenden Ressourcen zu einer Zusammenarbeit hinzufügen:

api_version: 2.0.0
spec_type: data_offering
version: v0
name: examplecorp_sales_by_state
datasets:
 - alias: AL
   data_object_fqn: mydb.mysch.al_data
 - alias: NY
   data_object_fqn: mydb.mysch.ny_data
 - alias: CA
   data_object_fqn: mydb.mysch.ca_data

CREATE OR REPLACE AGGREGATION POLICY my_db.public.my_agg_policy AS ()
  RETURNS AGGREGATION_CONSTRAINT ->
    AGGREGATION_CONSTRAINT(MIN_GROUP_SIZE => 5);

# Tell data clean rooms to set your aggregation policy on the hashed_email column of
# the data offering
api_version: 2.0.0
version: 1
name: my_favorite_dataset
datasets:
  - alias: test_freeform_restricted_agg
    data_object_fqn: samooha_provider_sample_database.audience_overlap.customers
    allowed_analyses: template_and_freeform_sql
    object_class: custom
    freeform_sql_policies:
      aggregation_policy:
        name: my_db.public.my_agg_policy
        entity_keys:
          - hashed_email
...

Umbenennen der Quellspalte¶

Die Spaltennamen, die der Vorlage oder dem Freiform-SQL-Aufrufenden angezeigt werden, werden durch die Werte category und column_type festgelegt, die die Spalte in der Datenangebotsdefinition beschreiben. Das Umbenennen von Spalten erfolgt entsprechend dieser Rubrik:

• Wenn category für die Spalte join_custom oder passthrough lautet, wird der ursprüngliche Spaltenname angezeigt.

• Wenn category den Wert join_standard hat, wird die Spalte als column_type-Wert umbenannt.

• Wenn category den Wert timestamp hat, wird die Spalte im Datenangebot in timestamp umbenannt.

Beispiel: Wenn die Spalte in der Quelltabelle den Namen user_email_address hat, hängt die Offenlegung der Spalte in der Vorlage oder in Freiform-SQL davon ab, wie sie in der Definition des Datenangebots definiert ist:

• Wenn die Spaltenkategorie join_standard lautet und column_type vorhanden ist:

  ... Snippet from data offering yaml ...
  schema_and_template_policies:
       user_email_address:
         category: join_standard
         column_type: hashed_email_sha256
  

  Copy

  Dann wird der Wert column_type in Abfragen und Vorlagen verwendet:

  SELECT HASHED_EMAIL_SHA256 FROM source_table[0];
  

  Copy

• Wenn die Spaltenkategorie join_custom lautet:

  ... Snippet from data offering yaml ...
  schema_and_template_policies:
       user_email_address:
         category: join_custom
         column_type: hashed_email_sha256
  

  Copy

  Dann wird der ursprüngliche Quellspaltenname in Abfragen und Vorlagen verwendet:

  -- column_type is ignored for join_custom columns.
  SELECT user_email_address FROM source_table[0];
  

  Copy

Einer Zusammenarbeit beitreten¶

Sie müssen einer Zusammenarbeit beitreten, damit alle Ressourcen, die Sie zu einer Zusammenarbeit beigesteuert haben, in der Zusammenarbeit verfügbar sind, oder um eine Analyse in der Zusammenarbeit ausführen zu können.

• Der Ersteller wird beim Aufrufen von INITIALIZE automatisch verknüpft (es sei denn,``auto_join_warehouse`` wird bereitgestellt). Wenn die automatische Verknüpfung deaktiviert ist, ruft der Ersteller JOIN separat auf.

• Nicht Erstellende rufen REVIEW und dann JOIN auf.

  Wichtig

  Wenn sich Ihr Konto in einer anderen Cloud-Hosting-Region befindet als die des Eigentümers der Zusammenarbeit:

  • Die REVIEW-Anforderung schlägt fehl, wenn die Cloud-übergreifende automatische Ausführung für Ihr Konto nicht aktiviert ist.

  • REVIEW löst zusätzliche asynchrone Einrichtungsschritte aus. Rufen Sie REVIEW wiederholt auf, bis eine Erfolgreich-Antwort zurückgegeben wird, die anzeigt, dass das Setup abgeschlossen ist.

Das Verknüpfen ist ein asynchroner Prozess. Rufen Sie GET_STATUS auf, um zu sehen, wann der Status als JOINED aufgeführt ist.

Analyse ausführen¶

Sie können Analysen entweder durchführen, indem Sie eine Vorlage in der Abfrage ausführen oder indem Sie eine Freiform-SQL-Abfrage für die Zusammenarbeitsdaten ausführen. Sie müssen ein benannter Analyseausführender in einer Zusammenarbeit sein, um eine Analyse durchführen zu können. Die Zusammenarbeitsspezifikation bestimmt, ob Sie eine Vorlage ausführen, Ergebnisse aktivieren oder Freiform-SQL-Abfragen ausführen können. Ihre Möglichkeiten sowie die Daten und Vorlagen, die Sie verwenden können, sind in der Spezifikation für die Zusammenarbeit beschrieben.

Der Analyseausführende trägt die Kosten für die Durchführung einer Analyse.

-- See which data offerings are available.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_DATA_OFFERINGS($collaboration_name);

-- See which templates you can run.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_TEMPLATES($collaboration_name);

-- Pass in the arguments in analysis YAML format.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.RUN(
  $collaboration_name,
  $$
    api_version: 2.0.0
    spec_type: analysis
    name: My_analysis
    description: Sales results Q2 2025
    template: sales_join_template

    template_configuration:
      view_mappings:
        source_tables:
          -  user1_alias.data_offering_v1.table1
          -  user2_alias.another_data_offering_v1.table_2
      arguments:
         conv_purchase_id: PURCHASE_ID
         conv_purchase_amount: PURCHASE_AMOUNT
         publisher_impression_id: IMPRESSION_ID
         publisher_campaign_name: CAMPAIGN_NAME
         publisher_device_type: DEVICE_TYPE
  $$ );

api_version: 2.0.0
version: 1
name: my_favorite_dataset
datasets:
  - alias: test_freeform_restricted_agg
    data_object_fqn: samooha_provider_sample_database.audience_overlap.customers
    object_class: custom
    allowed_analyses: template_and_freeform_sql
...

-- See what data offerings are available. Your own local data will be listed here as well.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.VIEW_DATA_OFFERINGS($collaboration_name);

-- Pass in the arguments in analysis YAML format.
CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.COLLABORATION.RUN(
  $collaboration_name,
  $$
    api_version: 2.0.0
    spec_type: analysis
    name: my_analysis
    description: Cross-purchase results for Q4 2025
    template: mytemplate_v1

    template_configuration:
      view_mappings:
        source_tables:
          - ADVERTISER1.ADVERTISER_DATA_V1.CUSTOMERS
          - PUBLISHER.ADVERTISER_DATA_V1.CUSTOMERS
      local_view_mappings:
        my_tables:
          - PARTNER.MY_DATA_V1.MY_CUSTOMERS # Populate my_table array with my own table.
      arguments:  # Template arguments, as name: value pairs
         conv_purchase_id: PURCHASE_ID
         conv_purchase_amount: PURCHASE_AMOUNT
         publisher_impression_id: IMPRESSION_ID
         publisher_campaign_name: CAMPAIGN_NAME
         publisher_device_type: DEVICE_TYPE
  $$ );

Abfrageergebnisse aktivieren¶

So aktivieren Sie die Ergebnisse einer Abfrage:

1. Stellen Sie sicher, dass für alle Aktivierungsspalten die folgenden Eigenschaften in der entsprechenden Spezifikation festgelegt sind:

   Data offering specCollaboration specAnalysis spec

   Die Datenangebotsspezifikation für die Tabelle mit der aktivierten Spalte muss activation_allowed: TRUE für diese Spalte festlegen:

    api_version: 2.0.0
    spec_type: data_offering
    name: 2025_orders
    version: 2025_01_01_v1
    description: Activating Cleveland sales results for 2025
   
    datasets:
     - alias: customers
       data_object_fqn: db1.schema1.orders
       allowed_analyses: template_only
       object_class: custom
       schema_and_template_policies:
         email:
           category: join_standard
           column_type: hashed_email_sha256
           activation_allowed: TRUE
         purchase_amount:
           category: passthrough
           activation_allowed: TRUE
   

   Copy

   Bemerkung

   Für jede Spalte, die in der Vorlage mit angewendetem activation_policy-Filter verwendet wird, muss der activation_allowed-Wert in der Datenangebotsspezifikation auf TRUE festgelegt sein. Das folgende Beispiel zeigt eine Vorlage, bei der die Aktivierungsrichtlinie auf zwei Spalten angewendet wird, die vom Analyseausführenden bereitgestellt werden:

   BEGIN
     CREATE OR REPLACE TABLE cleanroom.activation_data_analysis_results AS
       SELECT count(*) AS ITEM_COUNT, c.status, c.age_band
       FROM IDENTIFIER({{ my_table[0] }}) AS c
       JOIN IDENTIFIER({{ source_table[0] }}) AS p
       ON {{ c_join_col | sqlsafe | activation_policy }} = {{ p_join_col | sqlsafe | activation_policy }}
       GROUP BY c.status, c.age_band
       ORDER BY c.age_band;
     RETURN 'analysis_results';
   END;
   

   Copy

2. Der Analyseausführende ruft RUN auf, um die Analyse auszuführen.

   • Wenn Sie die Aktivierung für sich selbst vornehmen, sind die Ergebnisse sofort im Konto des Aufrufenden in der Tabelle consumers_database.ACTIVATION_RESULTS.CONSUMER_DIRECT_ACTIVATION_SUMMARY verfügbar. Wie Sie die Abfrageergebnisse anzeigen können, erfahren Sie im letzten Schritt.

   • Bei Aktivierung für einen anderen Teilnehmenden:

     1. Der Teilnehmende ruft VIEW_ACTIVATIONS auf, bis der Status SHARED zurückgegeben wird. Die Aktivierung für ein anderes Konto kann bei großen Resultsets einige Zeit in Anspruch nehmen, da die Daten an das Konto des Teilnehmenden übertragen und entschlüsselt werden müssen.

     2. Wenn der Status der Aktivierung SHARED lautet, ruft der Teilnehmende PROCESS_ACTIVATION auf, um die Ergebnisse an sein Konto zu senden. Die Antwort auf PROCESS_ACTIVATION schließt die Tabellen- und Segmentnamen mit ein. Hierdurch wird der Aktivierungsstatus auf PROCESSED festgelegt.

3. Um Abfrageergebnisse abzurufen, führen Sie den folgenden SQL-Befehl aus, und geben Sie den Namen Ihrer Ergebnistabelle und optional einen Segmentnamen zum Filtern der Ergebnisse an:

   SELECT *
     FROM <results_table_name>
       [WHERE segment = <segment_name>];
   

   Copy

Zusammenarbeit verlassen oder löschen¶

• Nicht-Eigentümer verlassen eine Zusammenarbeit, indem sie COLLABORATION.LEAVE aufrufen. Alle von ihnen bereitgestellten Datenangebote werden aus der Zusammenarbeit entfernt. Sie können einer Zusammenarbeit nicht wieder beitreten, nachdem Sie sie verlassen haben.

• Zusammenarbeitseigentümer können eine Zusammenarbeit nicht verlassen. Die Eigentümerschaft kann nicht übertragen werden. Ein Eigentümer einer Zusammenarbeit kann eine Zusammenarbeit für alle Teilnehmenden löschen, indem er COLLABORATION.TEARDOWN aufruft.

Beide Prozesse sind asynchron. Sie müssen GET_STATUS aufrufen, um den Status zu überwachen, und LEAVE oder TEARDOWN erneut aufrufen, wenn GET_STATUS den Status als LOCAL_DROP_PENDING anzeigt.

Cloud-übergreifende automatische Ausführung aktivieren¶

Wenn Sie sich nicht in der gleichen Cloud-Host-Region befinden wie der Eigentümer der Zusammenarbeit, muss die Cloud-übergreifende automatische Ausführung (LAF) für Ihr Konto aktiviert sein, damit Sie der Zusammenarbeit beitreten können. Wenn Sie versuchen, eine Zusammenarbeit in einer anderen Cloud-Region zu überprüfen und LAF nicht für Ihr Konto aktiviert ist oder Sie nicht über die richtigen Berechtigungen verfügen, erhalten Sie beim Aufruf von REVIEW für die Zusammenarbeit eine Fehlermeldung.

Sie können Ihre Cloud-Hosting-Region ermitteln, indem Sie SELECT CURRENT_REGION(); ausführen.

So aktivieren Sie die Cloud-übergreifende automatische Ausführung für Ihr Konto:

1. Ein Organisationsadministrator muss LAF für Ihr Konto aktivieren, indem er SYSTEM$ENABLE_GLOBAL_DATA_SHARING_FOR_ACCOUNT aufruft. Weitere Informationen dazu finden Sie unter Berechtigungen für automatische Ausführung verwalten.

2. Damit Sie die richtigen Berechtigungen zum Ansehen einer LAF-Zusammenarbeit haben oder um ihr beitreten zu können, verwenden Sie die SAMOOHA_APP_ROLE oder eine Rolle, die über die Berechtigung MANAGE LISTING AUTO FULFILLMENT auf Kontoebene verfügt.

Teilnehmende, die sich in einer anderen Cloud-Hosting-Region befinden, erfahren zusätzliche Datenverzögerung aufgrund der Replikationshäufigkeit. Die Replikationshäufigkeit ist in einem Collaboration Data Clean Room noch nicht konfigurierbar.

Beispiel: Zusammenarbeit zwischen zwei Parteien¶

Das folgende Beispiel zeigt eine Zusammenarbeit mit zwei Parteien, wobei eine Partei (namens „alice“) die Erstellende der Zusammenarbeit, ein Datenanbieter für sich selbst und „bob“ sowie eine Analyseausführende ist. Die andere Partei (mit dem Namen „bob“) ist ein Datenanbieter für sich selbst und „alice“ sowie ein Analyseausführender.

Das Beispiel veranschaulicht die folgenden Aktionen:

• Erstellen einer Zusammenarbeit

• Registrieren von Vorlagen und Datenangeboten

• Hinzufügen einer Vorlage und eines Datenangebots zum Zeitpunkt der Erstellung der Zusammenarbeit

• Beitreten zu einer Zusammenarbeit

• Hinzufügen von Vorlagen und Ressourcen zu einer vorhandenen Zusammenarbeit

• Ausführen einer Analyse

Um dieses Beispiel auszuführen, müssen Sie über zwei separate Konten mit installierten Snowflake Data Clean Rooms verfügen.

Sie können die Dateien entweder herunterladen und in Ihr Snowflake-Konto hochladen oder den Beispielcode kopieren und in die Arbeitsblätter von zwei separaten Konten einfügen, indem Sie die Snowsight verwenden.

-- 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.

-- This scenario involves two collaborators: bob and alice
-- bob and alice each submits one data source
-- bob and alice are data providers for themselves and each other
-- bob submits one template that only alice can use
-- alice submits one template that they can both use, and one template that only alice can use

-- 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.
USE SECONDARY ROLES NONE;

CREATE DATABASE IF NOT EXISTS ALICE_DB;
CREATE SCHEMA IF NOT EXISTS ALICE_DB.ALICE_SCH;
CREATE OR REPLACE TABLE ALICE_DB.ALICE_SCH.ALICE_DATA AS SELECT * FROM samooha_sample_database.demo.customers LIMIT 100;

-- 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 offering name>
    datasets:
     - alias: customer_list
       data_object_fqn: ALICE_DB.ALICE_SCH.ALICE_DATA
       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 alice_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_only_template
version: <version_number>
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_b64_encoded = t2.hashed_email_b64_encoded
    GROUP BY t1.status;
$$);

-- Save the ID of the registered template.
SET my_template_id = '<alice_only_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_1_0
owner: alice
collaborator_identifier_aliases:
  alice: <my account data sharing ID>
  bob: <bob account data sharing ID>
analysis_runners:
  bob:
    data_providers:
      alice:
        data_offerings:
        - id: <alice data offering ID>
      bob:
        data_offerings: []
  alice:
    data_providers:
      alice:
        data_offerings:
        - id: <alice data offering ID>
      bob:
        data_offerings: []
    templates:
    - id: <alice only template ID>
$$,
'APP_WH'
);
SET collaboration_name = '<collaboration_name>';

-- INITIALIZE automatically joins the owner. Check status until JOINED.
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_name);

-- Collaboration is visible here when the owner has joined.
CALL samooha_by_snowflake_local_db.collaboration.view_collaborations();

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

-- SWITCH TO collaborator to join the collaboration and add a template
-- The template will be auto-approved.

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

-- Ask to add the template to the collaboration. You must ask bob, because you're
-- including bob in the sharing list. When you share a template with yourself,
-- you auto-approve it.
CALL samooha_by_snowflake_local_db.collaboration.add_template_request(
  $collaboration_name,
  $both_use_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_name);

-- 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_name;

-- SWITCH TO bob to add a data offering.

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

CALL samooha_by_snowflake_local_db.collaboration.view_templates(
  $collaboration_name
);

-- Run bob's template.
-- Replace the placeholders with your variables.
CALL samooha_by_snowflake_local_db.collaboration.run(
  $collaboration_name,
    $$
    api_version: 2.0.0
    spec_type: analysis
    description: <optional description of the analysis>
    template: '<alice_only_template>'
    template_configuration:
      view_mappings:
        source_tables:
          - '<alice_data_offering_view_name>'
          - '<bob_data_offering_view_name>'
    $$
  );

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

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

DROP DATABASE ALICE_DB;

-- 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 sample data.
CREATE DATABASE IF NOT EXISTS BOB_DB;
CREATE SCHEMA IF NOT EXISTS BOB_DB.BOB_SCH;
CREATE OR REPLACE TABLE BOB_DB.BOB_SCH.BOB_DATA AS SELECT * FROM samooha_sample_database.demo.customers_2 LIMIT 100;

-- 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_name = '<collaboration name>';

-- 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_name, $collaborator_data_sharing_id);
CALL samooha_by_snowflake_local_db.collaboration.join($collaboration_name);
CALL samooha_by_snowflake_local_db.collaboration.get_status($collaboration_name);

-- Demonstrate the auto-approve flow.
-- Alice enabled auto-approve on her account, so this request will
-- be auto-approved, and the template will be added immediately.

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

CALL samooha_by_snowflake_local_db.collaboration.add_template_request($collaboration_name, $auto_approve_template, ['alice', 'bob']);
CALL samooha_by_snowflake_local_db.collaboration.view_update_requests($collaboration_name);

-- 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_name);
CALL samooha_by_snowflake_local_db.collaboration.approve_update_request(
  $collaboration_name,
  '<request_ID>'
);

-- SWITCH TO bob to see the request status.

-- 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: v3
    name: bob_data
    datasets:
     - alias: my_customer_list
       data_object_fqn: BOB_DB.BOB_SCH.BOB_DATA
       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
    $$
);

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_name,
  $my_data_id,
  ['alice', 'bob']
);

CALL samooha_by_snowflake_local_db.collaboration.view_data_offerings(
  $collaboration_name
);

-- View templates that you can use in this collaboration. You can run only templates that list you in the
-- SHARED_WITH column.
CALL samooha_by_snowflake_local_db.collaboration.view_templates($collaboration_name);

-- Run an analysis with your template.
CALL samooha_by_snowflake_local_db.collaboration.run(
    $collaboration_name,
    $$
    api_version: 2.0.0
    spec_type: analysis
    description: <optional description of the analysis>
    template:  '<both_use_template>'
    template_configuration:
      view_mappings:
        source_tables:
          -  '<my_data_offering_view_name>'
          -  '<bob_data_offering_view_name>'
    $$
);
  
-- SWITCH TO other account to run an analysis.

-- Try running an analysis using alice-only template.
-- This will fail, because you aren't listed as an analysis
-- runner for this template.
CALL samooha_by_snowflake_local_db.collaboration.run(
  $collaboration_name,
  $$
  api_version: 2.0.0
  spec_type: analysis
  description: <optional description of the analysis>
  template: '<alice_only_template>'
  template_configuration:
    view_mappings:
      source_tables:
        - '<my_data_offering_view_name>'
        - '<bob_data_offering_view_name>'
  $$
);

-- Clean up resources.
DROP DATABASE BOB_DB;