Analyse exécutée par le fournisseur

Overview

La configuration par défaut de la clean room permet uniquement au consommateur d’effectuer une analyse dans la clean room. Toutefois, le fournisseur peut demander l’autorisation au consommateur d’exécuter des modèles utilisant les données du consommateur dans une clean room spécifique. L’analyse effectuée par le fournisseur peut être activée et exécutée à l’aide de l’UI clean room ou d’un code.

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

Basic data flow direction in a 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 : objets installés.

Templates that support provider-run analyses

The following templates support provider-run analyses:

  • Audience Overlap & Segmentation

  • SQL Query (UI only)

  • Modèles personnalisés (API uniquement)

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));
Copy

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 Mise en œuvre de l’activation dans votre clean room.

  • Si le consommateur et le fournisseur se trouvent dans des régions Cloud différentes, vous devez activer exécution automatique inter-Cloud dans les deux comptes et pour les deux clean rooms.

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

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.

    • Ce paramètre ne peut pas être modifié après la création d’une salle blanche ; si vous souhaitez modifier l’autorisation d’un compte spécifique pour exécuter des requêtes dans une salle blanche publiée, vous devez supprimer la salle blanche et en créer une nouvelle.

  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.

    • Lorsque le consommateur rejoint la salle blanche, il est averti avant de rejoindre que l’analyse exécutée par le fournisseur est activée pour cette salle blanche.

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

    • Le consommateur est facturé pour toutes les analyses dans cette salle blanche, qu’elles soient effectuées par le fournisseur ou par le consommateur.

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

    1. Créez et configurez votre clean room, vos données et vos politiques de manière standard.

    2. Ajoutez des consommateurs de la manière habituelle.

    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. Publier la clean room.

    2. Faites savoir à vos consommateurs que la clean room est disponible, le nom de la clean room, et les modèles que vous voulez exécuter dans la clean room.

  2. Consommateur

    1. Installez la salle blanche et liez vos données de manière standard.

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

    3. Autorisez l’analyse du fournisseur pour des modèles spécifiques dans la salle blanche en appelant soit consumer.enable_templates_for_provider_run (pour plusieurs modèles) ou consumer.approve_template (pour un modèle).

      Note

      Si le fournisseur modifie un modèle après que le consommateur l’a approuvé, ce dernier doit approuver à nouveau le modèle. Jusqu’à ce que le modèle soit réapprouvé, l’ancienne version mise en cache du modèle approuvé sera exécutée par le fournisseur.

    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. Informez le fournisseur que vous avez installé la clean room et approuvé les analyses effectuées par le fournisseur.

  3. Fournisseur

    1. Une fois que le consommateur a installé la salle blanche, vous devez permettre à vos analyses d’accéder aux données du consommateur en activant le partage de données du consommateur au compte du fournisseur. Le processus pour cela diffère selon si le fournisseur et le consommateur se trouvent dans la même région Cloud ou s’ils se trouvent dans des régions Cloud différentes :

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

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:

  1. Le consommateur appelle consumer.set_provider_run_configuration et spécifient les tailles et les types d’entrepôt qu’un fournisseur peut utiliser pour un modèle spécifié.

    CALL samooha_by_snowflake_local_db.consumer.set_provider_run_configuration(
  $cleanroom_name,
  {
    $template_name: {
      'warehouse_type': 'STANDARD',
      'warehouse_size': ['MEDIUM', 'LARGE']}
  });
    Copy

  2. Le fournisseur appelle provider.view_warehouse_sizes_for_template pour voir quels tailles et types d’entrepôt sont autorisés pour les analyses exécutées par le fournisseur sur ce modèle.

    CALL samooha_by_snowflake_local_db.provider.view_warehouse_sizes_for_template(
  $cleanroom_name,
  $template_name,
  $consumer_account_loc
);
    Copy

  3. 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.
  )
);
    Copy

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.

  1. :download :Téléchargez le notebook d'exemples </samples/clean-rooms/provider-analysis-notebook.ipynb>.

  2. Installez le notebook à la fois dans vos comptes de fournisseur et de consommateur.

    Pour charger un notebook, procédez comme suit :

    1. Dans le menu de navigation, sélectionnez Projects » Notebooks.

    2. Sélectionnez + Notebook » Import .ipynb file.

    3. Sélectionnez le fichier .ipynb que vous avez téléchargé.

    4. Nommez le fichier comme vous le souhaitez et choisissez une base de données et un schéma.

    5. Conservez l’entrepôt par défaut APP_WH.

    6. Sélectionnez Create.

    7. Ouvrez le carnet dans le compte fournisseur et complétez la partie fournisseur pour créer la clean room.

    8. Ouvrez le Notebooks dans le compte du consommateur et complétez la partie consommateur pour installer et configurer la clean room et exécuter le modèle.

Astuce

Les procédures suivantes permettent de déterminer quel côté peut effectuer une analyse dans la clean room :

Analyse exécutée par le consommateur (autorisée par défaut) : Les modifications s’appliquent immédiatement.

  • provider.enable_consumer_run_analysis

  • provider.disable_consumer_run_analysis

Analyse exécutée par le fournisseur (désactivée par défaut) : Les modifications nécessitent une réinstallation par le consommateur.

  • provider.enable_provider_run_analysis (requires the consumer to approve by calling consumer.enable_templates_for_provider_run)

  • provider.disable_provider_run_analysis

Langage: Français