Snowflake Data Clean Rooms : guide de référence pour l’API de consommateur¶
Le contenu suivant détaille toutes les APIs du développeur fournies par Snowflake Data Clean Rooms pour les consommateurs. Toutes les fonctions s’inscrivent dans le schéma suivant :
samooha_by_snowflake_local_db.consumer
Configuration de l’environnement¶
Exécutez les commandes suivantes pour configurer l’environnement Snowflake avant d’utiliser les APIs du développeur pour travailler avec une Snowflake Data Clean Room. Si vous n’avez pas le rôle SAMOOHA_APP_ROLE, veuillez contacter votre administrateur de compte.
use role samooha_app_role;
use warehouse app_wh;
Attribuez un nom à la salle blanche que le fournisseur vous a communiquée :
set cleanroom_name = 'Test Cleanroom 1';
Installation d’une salle blanche¶
Installez la salle blanche que le fournisseur a partagée via les commandes suivantes :
consumer.install_cleanroom¶
Description : installe la salle blanche sur le compte du consommateur avec le fournisseur associé et la salle blanche sélectionnée.
Entrée : cleanroom_name (chaîne), provider_account_locator (chaîne)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.install_cleanroom($cleanroom_name, '<PROVIDER_ACCOUNT_LOCATOR>');
consumer.is_enabled¶
Description : Une fois la salle blanche installée, il faut environ 1 minute au fournisseur pour finir de la configurer et l’activer de son côté. Cette fonction permet à l’utilisateur de vérifier le statut de la salle blanche et de voir si elle est activée ou non. L’indicateur passe généralement à True au bout d’une minute environ après l’installation de la salle blanche.
Entrée : cleanroom_name (chaîne)
Sortie : is enabled (booléen)
Exemple :
call samooha_by_snowflake_local_db.consumer.is_enabled($cleanroom_name);
consumer.uninstall_cleanroom¶
Description : désinstalle la salle blanche sur le compte du consommateur. Cette opération supprime toutes les bases de données associées à la salle blanche, y compris la base de données partagée de la salle blanche. Notez que la salle blanche peut toujours être réinstallée avec consumer.install_cleanroom.
Entrée : cleanroom_name (chaîne)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.uninstall_cleanroom($cleanroom_name);
Configuration de l’analyse d’exécution par le fournisseur¶
library.is_provider_run_enabled¶
Description : vérifie si l’analyse de l’exécution du fournisseur est activée dans cette salle blanche. Remarque : une autorisation explicite doit encore être donnée en appelant consumer.enable_templates_for_provider_run (voir ci-dessous).
Entrée : cleanroom_name (chaîne)
Sortie : enabled message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.is_provider_run_enabled($cleanroom_name)
library.is_consumer_run_enabled¶
Description : vérifie si l’analyse du cycle du consommateur est activée dans cette salle blanche. Cet indicateur détermine si le consommateur de la salle blanche (l’installateur) peut effectuer des analyses, ou agir en tant que fournisseur de données dans le cadre de la collaboration.
Entrée : cleanroom_name (chaîne)
Sortie : enabled message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.is_consumer_run_enabled($cleanroom_name)
consumer.enable_templates_for_provider_run¶
Description : si, dans une salle blanche, l’analyse de l’exécution par le fournisseur est activée (c’est-à-dire que le fournisseur de la salle blanche a marqué la salle blanche pour permettre aux fournisseurs d’effectuer des analyses), cette procédure doit être appelée par le consommateur pour les activer. Cette procédure est nécessaire pour donner une approbation explicite, modèle par modèle, aux fournisseurs qui souhaitent effectuer des analyses.
Le dernier paramètre booléen permet au consommateur d’activer la confidentialité différentielle pour les analyses du fournisseur, s’il est défini sur TRUE.
Entrée : cleanroom_name (chaîne), template_names (tableau), enable_differential_privacy(booléen)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.enable_templates_for_provider_run($cleanroom_name, ['prod_overlap_analysis'], FALSE);
Enregistrer et annuler l’enregistrement des données¶
Utilisez la commande suivante pour enregistrer et annuler l’enregistrement des bases de données, des schémas et des objets. Les tables et les vues doivent être enregistrées avant de pouvoir être liées à la salle blanche. Si vous enregistrez une base de données ou un schéma, tous les objets de cette base de données ou de ce schéma sont enregistrés.
consumer.register_db¶
Description : l’ajout d’une base de données dans la salle blanche vous permet de lier n’importe quel ensemble de données de la base. Si ce n’est pas le cas, les autorisations devront être accordées à samooha_app_role individuellement.
Entrée : db_name (chaîne)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.register_db('SAMOOHA_SAMPLE_DATABASE');
library.register_schema¶
Description : similaire à register_db
, mais opère au niveau d’un schéma. Une table ou une chaîne représentant le nom pleinement qualifié du schéma peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier les objets au schéma à la salle blanche.
Si vous souhaitez enregistrer un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.register_managed_access_schema
plutôt.
Entrée : schema_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.register_managed_access_schema¶
Description : similaire à register_schema
, mais enregistre un schéma qui a été créé avec le paramètre WITH MANAGED ACCESS. Une table ou une chaîne représentant le nom pleinement qualifié du schéma peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier les objets au schéma à la salle blanche.
Entrée : schema_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.register_table_or_view¶
Description : enregistre les tables et les vues de tous types.
Entrée : object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Sortie : message de réussite (string)
Exemples
Pour enregistrer une table :
call samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
Pour enregistrer une table Iceberg :
call samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
true,
false,
false);
library.register_table¶
Description : similaire à register_db
, mais opère au niveau d’une table. Une table ou une chaîne représentant le nom pleinement qualifié de la table peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier la table à la salle blanche.
Si vous souhaitez enregistrer des tables dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.register_managed_access_table
plutôt.
Entrée : table_name (tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_managed_access_table¶
Description : similaire à register_table
, mais enregistre les tables dans un schéma qui a été créé avec le paramètre WITH MANAGED ACCESS. Une table ou une chaîne représentant le nom pleinement qualifié de la table peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier la table à la salle blanche.
Entrée : table_name (tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_view¶
Description : similaire à register_db
, mais opère au niveau d’un vue. Un tableau ou une chaîne représentant le nom pleinement qualifié de la vue peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier la vue à la salle blanche.
Si vous souhaitez enregistrer des vues dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.register_managed_access_view
plutôt.
Entrée : view_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_managed_access_view¶
Description : similaire à register_view
, mais enregistre les vues dans un schéma qui a été créé avec le paramètre WITH MANAGED ACCESS. Un tableau ou une chaîne représentant le nom pleinement qualifié de la vue peut être transmis, et des sélections d’attributions au rôle SAMOOHA_APP_ROLE sont effectuées, permettant à l’utilisateur de lier la vue à la salle blanche.
Entrée : view_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.register_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_db¶
Description : annule la procédure register_db
et supprime les autorisations au niveau de la base de données accordées au rôle SAMOOHA_APP_ROLE et à l’application native Snowflake Data Clean Room. Cette opération supprime également toute base de données de l’élément déroulant d’UI.
Entrée : db_name (chaîne)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_db('SAMOOHA_SAMPLE_DATABASE');
library.unregister_schema¶
Description : annule l’enregistrement d’un schéma, ce qui empêche les utilisateurs de lier leurs tables et vues à la salle blanche.
Si vous souhaitez annuler l’enregistrement d’un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.unregister_managed_access_schema
plutôt.
Entrée : schema_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.unregister_managed_access_schema¶
Description : similaire à unregister_schema
, mais annule l’enregistrement d’un schéma qui a été créé avec le paramètre WITH MANAGED ACCESS.
Entrée : schema_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.unregister_table_or_view¶
Description : annule l’enregistrement des tables et des vues de tous types.
Entrée : object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Sortie : message de réussite (string)
Exemples
Pour annuler l’enregistrement d’une table :
call samooha_by_snowflake_local_db.library.unregister_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
library.unregister_table¶
Description : similaire à unregister_db
, mais opère au niveau d’une table. Un tableau ou une chaîne représentant le nom de table complet peut être transmis pour annuler l’enregistrement des tables. Les utilisateurs ne peuvent pas lier des tables non enregistrées à une salle blanche.
Si vous souhaitez annuler l’enregistrement des tables dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.unregister_managed_access_table
plutôt.
Entrée : table_name (tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_managed_access_table¶
Description : similaire à unregister_table
, mais annule l’enregistrement des tables dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS).
Entrée : table_name (tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_view¶
Description : similaire à unregister_db
, mais opère au niveau d’un vue. Un tableau ou une chaîne représentant le nom de vue complet peut être transmis pour annuler l’enregistrement des vues. Les utilisateurs ne peuvent pas lier des vues non enregistrées à une salle blanche.
Si vous souhaitez annuler l’enregistrement des vues dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS), utilisez library.unregister_managed_access_view
plutôt.
Entrée : view_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
bibliothèque.unregister_managed_access_view¶
Description : similaire à unregister_view
, mais annule l’enregistrement des vues dans un schéma d’accès géré (c’est-à-dire un schéma créé avec le paramètre WITH MANAGED ACCESS).
Entrée : view_name (array)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.library.unregister_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
Ajouter des ensembles de données¶
consumer.link_datasets¶
Description : un utilisateur peut lier une table Snowflake dans la salle blanche et la partager en créant une vue sécurisée de la table depuis la salle blanche.
Entrée : cleanroom_name (chaîne), tables_list (tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.link_datasets($cleanroom_name, ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
Définition de politiques de sécurité pour l’analyse du cycle du fournisseur¶
consumer.set_join_policy¶
Description : spécifie les colonnes sur lesquelles le fournisseur est autorisé à effectuer une jointure lors de l’exécution de modèles dans la salle blanche, lors de l’utilisation de l’analyse d’exécution du fournisseur. Notez que la politique de colonne est replace only, donc si la fonction est appelée à nouveau, la politique de colonne précédemment définie est complètement remplacée par la politique actuelle.
Notez que les contrôles sont effectués en analysant la requête SQL à exécuter sur les données pour toute colonne non autorisée. Les requêtes comportant des caractères génériques peuvent ne pas être détectées par ces contrôles, et il convient de faire preuve de discernement lors de la conception du modèle d’analyse.
Entrée : cleanroom_name(chaîne), table_and_col_names(tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.set_join_policy($cleanroom_name, ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:EMAIL', 'SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES:EMAIL']);
consumer.set_column_policy¶
Description : définit les colonnes des données sur lesquelles le fournisseur peut effectuer des opérations. Cette fonction ne doit être appelée qu’après l’ajout du modèle. Il s’agit également d’une fonction du modèle, de sorte que les entrées doivent être de la forme template_name:full_table_name:column_name. Notez que la politique de colonne est replace only, donc si la fonction est rappelée, la politique de colonne précédemment définie est complètement remplacée par la politique actuelle.
La politique de colonne ne doit pas être appliquée aux colonnes d’identité telles que l’adresse e-mail. Elle ne doit être utilisée que pour les colonnes d’agrégats et de groupes.
Notez que les contrôles sont effectués en analysant la requête SQL à exécuter sur les données pour toute colonne non autorisée. Les requêtes comportant des caractères génériques peuvent ne pas être détectées par ces contrôles, et il convient de faire preuve de discernement lors de la conception du modèle d’analyse.
Les vérifications sont effectuées sur des arguments SQL Jinja appelés dimensions ou measure_columns. Veillez à utiliser ces balises pour activer cette vérification.
Entrée : cleanroom_name(chaîne), analysis_and_table_and_columns(tableau)
Sortie : success message (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.set_column_policy($cleanroom_name,
['prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:STATUS',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:AGE_BAND',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:DAYS_ACTIVE',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES:CAMPAIGN']);
Modèles¶
Les commandes suivantes permettent aux utilisateurs de travailler avec les modèles disponibles dans la salle blanche.
consumer.view_template_definition¶
Description : les définitions du modèle de salle blanche sont disponibles pour aider à déterminer quels paramètres doivent être transmis au modèle.
Note
Notez que toutes les procédures de Samooha sont chiffrées et ne sont pas visibles par défaut. Cependant, tous les modèles personnalisés que vous ajoutez vous seront visibles.
Entrée : cleanroom_name (chaîne), template_name (chaîne)
Sortie : la définition du modèle (chaîne)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_template_definition($cleanroom_name, 'prod_overlap_analysis');
consumer.get_arguments_from_template¶
Description : définit la manière dont les données doivent être organisées et les données requises pour chaque modèle afin de garantir que le résultat est facilement assimilable.
Entrée : cleanroom_name (chaîne), template_name (chaîne)
Sortie : liste et spécification des arguments (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.get_arguments_from_template($cleanroom_name, 'prod_overlap_analysis');
Chaînes de modèles¶
Les commandes suivantes permettent aux utilisateurs de travailler avec les chaînes de modèles disponibles dans la salle blanche. Pour des informations générales sur l’utilisation des chaînes de modèles, voir Utilisation des APIs du développeur pour exécuter les modèles de manière séquentielle.
consumer.view_added_template_chains¶
Description : permet de voir les chaînes de modèles actuellement actives dans la salle blanche.
Entrée : cleanroom_name (chaîne)
Sortie : les chaînes de modèles ajoutées (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_added_template_chains($cleanroom_name);
consumer.view_template_chain_definition¶
Description : renvoie les attributs d’une chaîne de modèles.
Entrée : cleanroom_name (string), template_chain_name (string)
Sortie : la définition de la chaîne de modèles (string)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_template_chain_definition($cleanroom_name, 'insights_chain');
consumer.get_arguments_from_template_chain¶
Description : renvoie les arguments attendus pour tous les modèles de la chaîne de modèles.
Entrée : cleanroom_name (string), template__chain_name (string)
Sortie : liste et spécification des arguments (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.get_arguments_from_template_chain($cleanroom_name, 'insights_chain');
Exécuter des analyses et des activations¶
Les commandes suivantes exécutent une analyse ou une activation spécifique en fonction du modèle spécifié.
consumer.run_analysis¶
Description : exécute une analyse à l’aide d’un modèle ou d’une chaîne de modèles. Les tables du consommateur et du fournisseur doivent être spécifiées séparément et certaines entrées peuvent être vides si elles ne sont pas nécessaires. Le modèle ou la chaîne de modèles exécute la logique qui a été configurée pour l’analyse spécifique et renvoie les données jointes sous forme de table. La seule donnée facultative est « epsilon », c’est-à-dire la part des différents budgets de protection de la confidentialité que la requête doit consommer. La valeur par défaut est 0,1, si elle n’est pas spécifiée.
Entrée : cleanroom_name (string), {template_name | template_chain_name} (string), consumer_tables (array), provider_tables (array), analysis_arguments (object)
Sortie : sortie des calculs de modèles (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.run_analysis(
$cleanroom_name, -- cleanroom
'prod_overlap_analysis', -- template name
['SAMOOHA_SAMPLE_DATABASE.MYDATA.CONVERSIONS'], -- Consumer tables
['SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES'], -- Provider tables
object_construct( -- Rest of the custom arguments needed for the template
'dimensions', ['p.CAMPAIGN'], -- always use p. to refer to fields in provider tables, and c. to refer to fields in consumer tables. Use p2, p3, etc. for more than one provider table and c2, c3, etc. for more than one consumer table.
'measure_column', ['p.EXP_COST'],
'measure_type', ['COUNT'],
'where_clause', 'p.EMAIL=c.EMAIL'
)
);
consumer.run_activation¶
Description : exécute un modèle qui renvoie les résultats au fournisseur pour activation.
Pour plus d’informations sur l’activation des résultats auprès du fournisseur, voir Utilisation des APIs du développeur pour activer les résultats auprès du fournisseur.
Entrée : cleanroom_name (string), segment_name (string), template_name (string), consumer_tables (array), provider_tables (array), activation_arguments (object)
Sortie : Success message
Exemple :
call samooha_by_snowflake_local_db.consumer.run_activation(
$cleanroom_name,
'my_activation_segment',
'activation_custom_template',
['consumer_source_table'],
['provider_source_table'],
object_construct( -- Custom arguments needed for the template
'dimensions', ['p.CAMPAIGN'], -- always use p. to refer to fields in provider tables, and c. to refer to fields in consumer tables. Use p2, p3, etc. for more than one provider table and c2, c3, etc. for more than one consumer table.
'where_clause', 'p.EMAIL=c.EMAIL'
));
Modèles définis par le consommateur¶
Les APIs suivantes vous permettent d’ajouter des modèles définis par le consommateur à une salle blanche. Pour plus d’informations, voir Utilisation des API du développeur pour ajouter des modèles définis par le consommateur.
consumer.create_template_request¶
Description : envoie une requête au fournisseur d’une salle blanche lui demandant d’approuver un modèle personnalisé afin qu’il puisse être ajouté à la salle blanche.
Entrée : cleanroom_name (string), template_name (string), template_definition (string)
Sortie : success message (chaîne)
Exemple :
CALL samooha_by_snowflake_local_db.consumer.create_template_request('dcr_cleanroom',
'my_analysis',
$$
SELECT
identifier({{ dimensions[0] | column_policy }})
FROM
identifier({{ my_table[0] }}) c
INNER JOIN
identifier({{ source_table[0] }}) p
ON
c.identifier({{ consumer_id }}) = identifier({{ provider_id | join_policy }})
{% if where_clause %} where {{ where_clause | sqlsafe | join_and_column_policy }} {% endif %};
$$);
consumer.list_template_requests¶
Description : répertorie les requêtes effectuées par le consommateur pour ajouter un modèle à une salle blanche.
Entrée : cleanroom_name (chaîne)
Sortie : request_id(chaîne), supplier_identifier(chaîne), template_name(chaîne), template_definition(chaîne), request_status(chaîne), reason(chaîne)
Exemple :
CALL samooha_by_snowflake_local_db.consumer.list_template_requests('dcr_cleanroom');
Méthodes d’obtention des métadonnées de la salle blanche¶
Les méthodes suivantes montrent les propriétés pertinentes de la salle blanche :
consumer.describe_cleanroom¶
Description : crée un résumé textuel contenant toutes les informations sur ce qui a été ajouté à la salle blanche, y compris les modèles, les ensembles de données, les politiques, etc.
Entrée : cleanroom_name(chaîne)
Sortie : chaîne de description complète de la salle blanche (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.describe_cleanroom($cleanroom_name);
consumer.view_provider_datasets¶
Description : permet de voir tous les ensembles de données qui ont été ajoutés à la salle blanche par le fournisseur.
Entrée : cleanroom_name(chaîne)
Sortie : tous les noms des ensembles de données des fournisseurs dans la salle blanche (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_provider_datasets($cleanroom_name);
consumer.view_join_policy¶
Description : décrit les colonnes que les utilisateurs peuvent rejoindre en toute sécurité à l’intérieur d’une salle blanche, définies par le consommateur sur les ensembles de données des consommateurs.
Entrée : cleanroom_name (chaîne)
Sortie : la politique de jointure (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_join_policy($cleanroom_name);
consumer.view_provider_join_policy¶
Description : décrit les colonnes que les utilisateurs peuvent rejoindre en toute sécurité à l’intérieur d’une salle blanche, définies par le fournisseur sur les ensembles de données du fournisseur.
Entrée : cleanroom_name (chaîne)
Sortie : la politique de jointure (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_provider_join_policy($cleanroom_name);
consumer.view_added_templates¶
Description : permet de voir tous les modèles actifs dans la salle blanche.
Entrée : cleanroom_name (chaîne)
Sortie : les modèles ajoutés (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_added_templates($cleanroom_name);
consumer.view_column_policy¶
Description : donne une vue de toutes les politiques de colonne qui ont été appliquées à la salle blanche par le consommateur.
Entrée : cleanroom_name (chaîne)
Sortie : la politique de colonne (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_column_policy($cleanroom_name);
consumer.view_provider_column_policy¶
Description : permet de voir toutes les politiques de colonne qui ont été appliquées à la salle blanche par le fournisseur.
Entrée : cleanroom_name (chaîne)
Sortie : la politique de colonne (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_provider_column_policy($cleanroom_name);
consumer.view_cleanrooms¶
Description : vue de toutes les salles blanches récemment créées, triées en fonction de leur date de création.
Entrée :
Sortie : toutes les salles blanches existantes classées par date de création (table)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_cleanrooms();
consumer.is_dp_enabled¶
Description : vérifie si la confidentialité différentielle a été activée dans la salle blanche.
Entrée : cleanroom_name(chaîne)
Sortie : si la salle blanche a activé DP (booléen)
Exemple :
call samooha_by_snowflake_local_db.consumer.is_dp_enabled($cleanroom_name);
consumer.view_remaining_privacy_budget¶
Description : visualise le budget de confidentialité restant qui peut être utilisé pour effectuer des requêtes à partir de la salle blanche. Une fois le budget épuisé, d’autres appels à run_analysis ne seront pas autorisés jusqu’à ce que le budget soit réinitialisé. Le budget est réinitialisé quotidiennement.
Lorsque la confidentialité différentielle n’est pas activée, le budget de confidentialité est fixé à un niveau arbitrairement élevé (par exemple, 10000) et n’est pas épuisé.
Entrée : cleanroom_name (chaîne)
Sortie : budget restant pour la protection de la confidentialité (float)
Exemple :
call samooha_by_snowflake_local_db.consumer.view_remaining_privacy_budget($cleanroom_name);
Méthodes d’aide générales¶
Utilisez les méthodes suivantes pour vous aider à tirer parti de la fonctionnalité de la salle blanche.
library.enable_local_db_auto_upgrades¶
Description : active la tâche, samooha_by_snowflake_local_db.admin.expected_version_task
, qui met automatiquement à niveau la Snowflake Native App pour Snowflake Data Clean Rooms à mesure que de nouvelles versions sont publiées.
Entrée : Aucune
Sortie : success message (chaîne)
Exemple :
CALL samooha_by_snowflake_local_db.library.enable_local_db_auto_upgrades();
library.disable_local_db_auto_upgrades¶
Description : désactive la tâche, samooha_by_snowflake_local_db.admin.expected_version_task
, qui met automatiquement à niveau la Snowflake Native App pour Snowflake Data Clean Rooms à mesure que de nouvelles versions sont publiées.
Entrée : Aucune
Sortie : success message (chaîne)
Exemple :
CALL samooha_by_snowflake_local_db.library.disable_local_db_auto_upgrades();