Provider-run analysis¶

Overview¶

The default clean room configuration enables only the consumer to run an analysis in the clean room. However, the provider can request permission from the consumer to run templates using consumer data in a specific clean room. Provider-run analysis can be enabled and run using either the clean rooms UI or code.

The following diagram shows the data flow and the main components in a basic provider-run analysis:

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

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

3. The encrypted results are temporarily written to the consumer DB in the consumer’s account.

4. 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: Installed objects.

-- Estimate the number of credits consumed in the past 5 days.
SELECT * FROM TABLE(SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.LIBRARY.PRA_CONSUMPTION_UDTF(-5));

Provider-run analyses in the UI¶

Here is how to enable provider-run analysis in a new clean room using the clean rooms UI:

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

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

   • This setting cannot be changed after a clean room is created; if you want to change permission for a specific account to run queries in a published clean room, you must delete the clean room and create a new one.

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

   • When the consumer joins the clean room, they are warned before joining that provider-run analysis is enabled for that clean room.

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

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

   • The consumer is billed for all analyses in this clean room, whether run by the provider or consumer.

Provider-run analyses in the API¶

Here is how to enable provider-run analysis in a new clean room using the clean rooms API:

1. Provider

   1. Create and configure your clean room and data and policies in the standard way.

   2. Add consumers in the standard way.

   3. 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_analysis after 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.

   1. Publish the clean room.

   2. Let your consumers know that the clean room is available, the name of the clean room, and what templates you want to run in the clean room.

2. Consumer

   1. Install the clean room and link in your data in the standard way.

   2. Set any join and column policies needed on your data.

   3. Allow provider analysis for specific templates in the clean room by calling either consumer.enable_templates_for_provider_run (for multiple templates) or consumer.approve_template (for one template).

      Note

      If the provider changes a template after the consumer approves it, the consumer must approve the template again. Until the template is re-approved, the old cached version of the approved template will be run by the provider.

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

   5. Tell the provider that you have installed the clean room and approved provider-run analyses.

3. Provider

   1. After the consumer has installed the clean room, you must enable your analyses to access consumer data by enabling data sharing from the consumer to the provider account. The process for this depends on whether the provider and consumer are in the same cloud region or different cloud regions:

      • If the provider and consumer are in the same cloud region, the provider calls provider.mount_request_logs_for_all_consumers once. 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.

   2. Call provider.view_warehouse_sizes_for_template to 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 supported warehouse_type and warehouse_size values 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.

   3. Run the analysis by calling provider.submit_analysis_request with 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.

   4. Check the status of the analysis by calling provider.check_analysis_status. When status is reported as COMPLETED, call provider.get_analysis_result to get the analysis results.