プロバイダーデータ分析¶
Overview¶
デフォルトのclean room構成では、コンシューマーのみがclean room内で分析を実行できます。ただし、プロバイダーは、特定のclean roomでコンシューマーデータを使用してテンプレートを実行する許可をコンシューマーにリクエストできます。プロバイダーが実行する分析は、clean room UI またはコードのいずれかを使用して有効にし、実行することができます。
The following diagram shows the data flow and the main components in a basic provider-run analysis:
In a basic provider-run analysis, the consumer and provider both link their data into the clean room. Source data is linked into the clean room as private views in the account where the data lives.
When the provider runs an analysis, the provider's data is shared with the clean room app in the consumer's account. The analysis runs on the consumer's account.
The encrypted results are temporarily written to the consumer DB in the consumer's account.
The encrypted results are copied to the analysis results back share on the provider's account (also called the governance back share) and decrypted. Because the analysis runs on the consumer's account, the consumer is billed for the analysis.
For more information, see Snowflake Data Clean Rooms: インストールされたオブジェクト.
Templates that support provider-run analyses¶
The following templates support provider-run analyses:
Audience Overlap & Segmentation
SQL Query (UI only)
カスタムテンプレート (API のみ)
Billing and cost details¶
Provider-run analyses run in the consumer's account, and consumers are billed for a provider-run analysis. To stop incurring costs from provider-run analyses, the consumer must uninstall the clean room.
A consumer can estimate the number of credits consumed by the provider within the last N days by executing the following query. Specify the number of previous days as a negative number.
-- Estimate the number of credits consumed in the past 5 days.
SELECT * FROM TABLE(SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.LIBRARY.PRA_CONSUMPTION_UDTF(-5));
When a provider runs an analysis in the clean rooms UI, the clean room uses auto-scaling logic based on dataset sizes to choose a warehouse for your analysis.
When a provider creates and runs a clean room using the API, the provider can explicitly choose a warehouse size using the API. The consumer can limit the size and type of warehouses available to the provider when running a given template.
General notes¶
Providers can activate results to their own account using the UI or the API, or to third-party providers if using the UI. For information about how to enable activation and view results, see clean roomにアクティベーションを実装する.
コンシューマーとプロバイダーが異なるクラウドリージョンにある場合、両方のアカウントと両方のclean roomで Cross-Cloud Auto-Fulfillment を有効にする必要があります。
Note that provider-run cross-cloud queries can take some time to run because provider source data must be replicated from the provider to the consumer, and query results from the consumer to the provider, all across cloud regions.
Any templates run by the provider require column names or aliases for all columns generated in the results. If a column is aggregated (for example,
SUM(col1)) or calls a custom function (for example,cleanroom.my_function(p.hashed_email)), you must explicitly specify an alias for the column name as shown here:SELECT SUM(col1) AS TOTAL FROM my_db.my_sch.T; -- Correct SELECT SUM(col1) FROM my_db.my_sch.T; -- Error: aggregated column needs an explicit alias.
Provider-run analyses in the UI¶
Here is how to enable provider-run analysis in a new clean room using the clean rooms UI:
The provider creates and configures a clean room, using one of the supported templates. Configure the clean room up to the Share Clean Room step.
In the Share Clean Room step of clean room configuration, the provider selects Enable run analysis & query next to their own account to enable them to run all templates in this clean room that support provider-run analysis.
この設定をクリーンルームの作成後に変更することはできません。公開されたクリーンルームでクエリを実行するために特定のアカウントの権限を変更したい場合は、クリーンルームを削除して新しいクリーンルームを作成する必要があります。
The consumer joins and configures the clean room as is usual for all templates in the clean room, including any templates that support provider analysis. If the consumer does not want to enable a provider to run a specific template, they can omit required details for that template.
コンシューマーがクリーンルームに参加すると、参加する前にそのクリーンルームでプロバイダー実行分析が有効であることが警告されます。
The consumer can run queries as soon as the clean room is joined, but there is a delay of up to 30 minutes before the provider can run the template. This setup delay is only occurs during the initial join step; if the provider later adds other provider-run templates, the provider can run them as soon as the consumer configures their clean room for that template.
After the join step completes, the clean room is available for both provider run analyses and consumer run analyses.
Important:
Providers must wait about 10 minutes after the consumer installs the clean room before they can run an analysis. The delay is for additional background configuration required for provider-run analyses.
コンシューマーは、プロバイダーまたはコンシューマーが実行するかどうかに関係なく、このクリーンルームですべての分析に対して請求されます。
Provider-run analyses in the API¶
Here is how to enable provider-run analysis in a new clean room using the clean rooms API:
プロバイダー
clean room、データ、ポリシーを通常の方法で作成し、構成します。
コンシューマーを通常の方法で追加します。
Enable provider-run analysis for specific consumer accounts in the clean room by calling
provider.enable_provider_run_analysis.Important:
You must call
provider.enable_provider_run_analysisafter adding consumers to a clean room, but before any consumer installs the clean room. Each consumer account must approve this request for their data to be accessible for provider-run analyses in this clean room.Any time the provider changes the provider-run analysis setting for a clean room, the clean room must be re-installed by all consumers for the change to take effect. Because it can be difficult to force all collaborators to re-install a clean room, it is more reliable for the provider to delete a published, shared clean room when changing the analysis permissions, then create a new clean room with the desired permissions.
clean roomを公開します。
clean roomが使用可能であること、clean roomの名前、clean roomで実行したいテンプレートをコンシューマーに知らせましょう。
コンシューマー
標準的な方法でクリーンルームをインストールし、データにリンクを行います。
Set any join and column policies needed on your data.
``consumer.enable_templates_for_provider_run``(複数のテンプレートの場合)または``consumer.approve_template``(1つのテンプレートの場合)のいずれかを呼び出すことで、クリーンルーム内の特定のテンプレートに対するプロバイダー分析を許可します。
注釈
コンシューマーがテンプレートを承認した後にプロバイダーがテンプレートを変更した場合、コンシューマーはテンプレートを再度承認する必要があります。テンプレートが再承認されるまで、承認されたテンプレートの古いキャッシュバージョンはプロバイダーによって実行されます。
(Optional) Provider-run analyses are billed to the consumer. A consumer can limit the warehouse type or sizes available for provider-run analyses: see Restricting warehouse size and type limits.
clean roomをインストールし、プロバイダーが実行する分析を承認したことを、プロバイダーに伝えます。
プロバイダー
コンシューマーがクリーンルームをインストールした後、コンシューマーからプロバイダーアカウントへのデータ共有を有効にして、分析がコンシューマーデータにアクセスできるようにする必要があります。このプロセスは、プロバイダーとコンシューマーが同じクラウドリージョンにあるか、異なるクラウドリージョンにあるかによって異なります。
If the provider and consumer are in the same cloud region, the provider calls
provider.mount_request_logs_for_all_consumersonce. If a new consumer account installs the clean room later and you want to use their data in this template, you must re-run this procedure to be able to access that data.If the provider and consumer are in different cloud regions, the provider and consumer must enable cross-cloud auto-fulfillment. When a provider runs an analysis across regions, the query can take some time to complete, because query data is sent from the provider's region to the consumer's region and back.
Call
provider.view_warehouse_sizes_for_templateto see if the consumer has limited the type and size of warehouse used for the analysis. If the consumer has limited your warehouse selection, you must provide supportedwarehouse_typeandwarehouse_sizevalues in your analysis request in the next step. If the consumer has not specified warehouse limits, those fields are optional in your request. For more information, see Restricting warehouse size and type limits.Run the analysis by calling
provider.submit_analysis_requestwith the template name, the table names, and the template arguments. If the consumer has specified limits on warehouse sizes or types, you must also specify the warehouse size and type in your request.Save the request ID returned by
provider.submit_analysis_request; the ID is needed to check the status and results of the analysis.
Check the status of the analysis by calling
provider.check_analysis_status. When status is reported asCOMPLETED, callprovider.get_analysis_resultto get the analysis results.
Restricting warehouse size and type limits¶
Here is how a consumer sets a warehouse size and type limitation, and how a provider chooses a warehouse size and type when running an analysis:
コンシューマーは``consumer.set_provider_run_configuration``を呼び出し、プロバイダーが指定されたテンプレートに使用できるウェアハウスのサイズとタイプを指定します。
CALL samooha_by_snowflake_local_db.consumer.set_provider_run_configuration( $cleanroom_name, { $template_name: { 'warehouse_type': 'STANDARD', 'warehouse_size': ['MEDIUM', 'LARGE']} });
プロバイダーは``provider.view_warehouse_sizes_for_template``を呼び出し、そのテンプレートに対するプロバイダー実行分析について許可されるウェアハウスのサイズとタイプを確認します。
CALL samooha_by_snowflake_local_db.provider.view_warehouse_sizes_for_template( $cleanroom_name, $template_name, $consumer_account_loc );
The provider specifies which supported warehouse size and type to use in their analysis run request.
CALL samooha_by_snowflake_local_db.provider.submit_analysis_request( $cleanroom_name, $consumer_locator_id, $template_name, ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'], ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'], object_construct( 'dimensions', ['c.REGION_CODE'], 'measure_type', ['AVG'], 'measure_column', ['c.DAYS_ACTIVE'], 'warehouse_type', 'STANDARD', -- Any other value would cause the request to fail. 'warehouse_size', 'LARGE' -- Only MEDIUM and LARGE supported. ) );
Install and run the code example¶
You can download and install a complete running example to create and run a provider-run analysis. To run this example, you need two Snowflake accounts in the same organization and cloud hosting region with the Snowflake Data Clean Room environment installed.
プロバイダーとコンシューマーアカウントの両方にノートブックをインストールします。
ノートブックをアップロードするには、次を実行します。
ナビゲーションメニューで Projects » Notebooks を選択します。
+ Notebook » Import .ipynb file を選択します。
ダウンロードした.ipynbファイルを選択します。
ファイルに好きな名前を付けて、データベースとスキーマを選択します。
デフォルトのウェアハウス
APP_WHをそのまま使用します。Create を選択します。
プロバイダーアカウントでノートブックを開き、プロバイダーの部分を入力してclean roomを作成します。
コンシューマーアカウントでノートブックを開き、コンシューマーの部分を入力してclean roomをインストールおよび構成し、テンプレートを実行します。
Tip
以下のプロシージャは、clean room内でどちらの側から分析を実行するかを管理します:
**コンシューマー実行分析**(デフォルトで許可):変更はすぐに適用されます。
provider.enable_consumer_run_analysis
provider.disable_consumer_run_analysis
**プロバイダー実行分析**(デフォルトで無効):変更にはコンシューマーによる再インストールが必要です。
provider.enable_provider_run_analysis(requires the consumer to approve by calling consumer.enable_templates_for_provider_run)
provider.disable_provider_run_analysis