Snowflake Data Clean Rooms 開発者ガイド¶

開発ツール¶

clean room用の主な開発ツールを以下に示します：

• コーディング環境： Snowflakeアカウントでストアドプロシージャを実行できる環境であれば、どのようなコーディング環境でもかまいません。ほとんどの開発者は、Snowsight（ブラウザベースのツール）または Snowflake CLI を使用しています。

• The clean rooms UI: Use the clean rooms UI to configure, manage, or create clean rooms. Most clean room analysts use the UI rather than code, so it's important to see and test the experience of your clean rooms in the UI. Additionally, there are a handful of features that are available only in the clean rooms UI.

• Snowsight は、データベースやその他のオブジェクトを探索したり、検索したりするのに便利です。

• Clean rooms API: API documentation is divided into provider and consumer topic pages.

コーディング設定¶

-- Set up environment.
USE ROLE SAMOOHA_APP_ROLE;
USE WAREHOUSE app_wh;

-- Call your clean rooms API functions.
...

GRANT USAGE ON WAREHOUSE <your_warehouse> TO SAMOOHA_APP_ROLE;`

アカウント、ユーザー、ロールのセットアップ¶

You aren't required to use the clean rooms UI to develop clean rooms: most clean room functionality is available by calling the API. However, a few features are available only in the UI, and some are faster to perform in the UI. And because many users use the UI exclusively, it's important to see how your clean room behaves in the UI. Therefore, you should ask a clean room administrator to add you as a clean room manager or higher in the appropriate clean room accounts.

ユースケースに応じて、異なるウェブホスティング地域に追加のSnowflakeアカウントを設定し、 クロスクラウドの動作 をテストしてもよいかもしれません。

Name your test Snowflake accounts meaningfully to indicate their typical usage: for example, "Consumer account," "Provider account," and "Cross-cloud account." This can help when you have multiple test accounts and must choose an account on the clean rooms login page.

クリーンルーム環境でインストールされたものを見る¶

Snowflake Data Clean Roomsは、インストール時に多くのローカルデータベースを作成します。クリーンルームパッケージで実行またはインストールされるタスクとオブジェクトの詳細は、Snowflake Data Clean Rooms: インストールされたオブジェクト で確認できます。

サンプルデータ¶

クリーンルーム環境は、使用できる いくつかのサンプルデータセット をインストールします。

また、Snowflakeを使用して 合成テストデータを生成 できます。

clean room UI とコードで同じアカウントを使用していることを確認する¶

同じSnowflakeアカウントでコーディング環境とclean room UI を開くことも少なくありません（たとえば、コードでclean roomを作成し、その表示をclean room UI で確認する場合など）。その場合は、同じSnowflakeアカウントをそれぞれに使用しているかを確認することが重要です。

Snowsight does not have a shortcut to open the clean rooms UI for the same account, or the reverse, so you must be sure to log in to the same account in each environment.

Clean roomの名前とclean roomの ID¶

When using the API, for procedures that take a clean room name argument, determine whether to use the clean room name or the clean room ID as follows:

• API を使用してclean roomを作成した場合は、clean roomの 名前 を使用します。

• クリーンルームがクリーンルーム UI 内に作成された場合はクリーンルーム**ID**を使用します。provider.view_cleanrooms または provider.describe_cleanroom を呼び出すと、クリーンルーム名と ID の両方を見ることができます。

Update your clean room whenever you make UI changes¶

When you change any clean room properties that affect the UI, call provider.create_or_update_cleanroom_listing to propagate the changes.

コードまたは UI で作成されたclean roomの相互運用性¶

When you create a clean room using the API, some features are not modifiable in the clean rooms UI. For example, you cannot add additional templates, even stock Snowflake templates, in code for a UI-created clean room. You also cannot change the differential privacy settings.

コンシューマーは、結合済みクリーンルームで結合ポリシーを設定したり、他の基本的なアクションを実行したりすることはできません。¶

clean roomが適切なロール (SAMOOHA_APP_ROLE) でインストールされたことを確認してください。clean roomをインストールする際に SAMOOHA_APP_ROLE を使用していない場合、アクセス許可のエラーをはじめとする多くの問題が発生します。そのの場合は consumer.uninstall_cleanroom までもがエラーになり、clean roomをアンインストールしてから正しいロールで再インストールするという面倒な手間が必要になります。

-- Who owns the clean room?
SHOW SHARES LIKE 'SAMOOHA_CLEANROOM_REQUESTS_<cleanroom_name>';

-- If the owner role is not SAMOOHA_APP_ROLE, you must drop the share, then
-- uninstall the clean room.
DROP SHARE SAMOOHA_CLEANROOM_REQUESTS_<cleanroom_name>;
CALL samooha_by_snowflake_local_db.consumer.uninstall_cleanroom($cleanroom_name);
USE ROLE SAMOOHA_APP_ROLE;
CALL samooha_by_snowflake_local_db.consumer.install_cleanroom($cleanroom_name, '<provider_locator>');

自分で作ったclean roomが見つからない¶

アカウントでclean roomを作成したのに、コラボレーターのアカウントで表示されない場合、以下の理由が考えられます：

• clean roomが別のクラウドホスティングリージョンで作成され、 クロスクラウド自動フルフィルメント を有効にしていない。

• provider.create_or_update_cleanroom_listing を呼び出してclean roomを公開していない。

• provider.view_cleanrooms() ではなく、 consumer.view_cleanrooms() を呼び出している（またはその逆）。

• clean roomを共有していないか、間違ったアカウントでclean roomを共有しているか、またはSnowsight/Clean roomの UI/CLI を間違ったコラボレーターアカウントで開いている。clean roomが表示されるアカウントが、clean roomを共有したアカウントであり、その共有アカウントでサインインしたことを確認してください。

• clean roomを公開した後、それがコラボレーターに表示されるまで多少時間がかかります。

不明な関数¶

プロシージャを呼び出して、次のスニペットのようなエラーが発生した場合。

Unknown user-defined function SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.CONSUMER.<procedure name>

考えられる原因はいくつかあります。

間違った名前空間を入力してしまった。

プロシージャのバージョン（ consumer または provider ）を正しく判断して呼び出してください。多くのプロシージャには、プロバイダーとコンシューマーの両方のバージョンがあります。

関数の名前を誤入力してしまった。

適切な名前については、リファレンスガイドを確認してください。

制限付きアクセス実行ロールが付与されていますが、呼び出した関数はあなたのロールで許可されていません。

次の SQL コードを実行してこれをテストします。

USE DATABASE samooha_by_snowflake_local_db;
CALL IS_DATABASE_ROLE_IN_SESSION('samooha_run_role');

Copy

コードスニペットが TRUE を返す場合、クリーンルーム API での制限付きアクセス 実行ロール 権限があります。より広範囲なアクセスが必要な場合は、クリーンルーム管理者にフルアクセスを依頼してください。許可された実行ロールプロシージャのリストは、consumer.grant_run_on_cleanrooms_to_role ドキュメント をご参照ください。

SAMOOHA_APP_ROLE がない

SAMOOHA_APP_ROLE が使用できるかどうかを確認するには、次のコマンドを実行します。

-- Get current user name.
SELECT current_user();

-- Add current user name in place as indicated.
SHOW GRANTS TO USER <current_user_name> ->> select * from $1 where "role" = 'SAMOOHA_APP_ROLE';

Copy

結果が得られない場合は、管理者に API クリーンルームへのアクセス付与を依頼してください。

ユーザーがクリーンルームをインストールしているかどうかを確認する¶

指定したユーザーが指定したクリーンルームをインストールしているかどうかは、以下の SQL コードを実行することで確認できます。$consumer_locator および $cleanroom_name をコンシューマーロケーターとクリーンルーム名に置き換えます。

SELECT * FROM snowflake.data_sharing_usage.application_state
  WHERE consumer_account_locator = $consumer_locator
    AND CONTAINS(package_name, UPPER(REPLACE($cleanroom_name, ' ', '_')));

クエリや分析履歴の確認¶

UI またはコードで実行した分析のクエリ履歴を確認できます。これらの履歴は個別に保存され、チェックされます。