Guide du développeur Snowflake Data Clean Rooms¶

Outils de développement¶

Voici les principaux outils de développement pour les clean rooms :

• Environnement de codage : Tout environnement de codage capable d’exécuter des procédures stockées dans votre compte Snowflake fonctionnera. La plupart des développeurs utilisent des feuilles de calcul dans Snowsight (l’outil basé sur le navigateur) ou sur le site Snowflake CLI.

• **UI des salles blanches : ** utiliser l’UI des salles blanches pour configurer, gérer ou créer des salles blanches. La plupart des analystes de salles blanches utilisent l’UI plutôt que du code, il est donc important de voir et de tester l’expérience de vos salles blanches dans l’UI. En outre, il existe un certain nombre de fonctionnalités qui ne sont disponibles que dans l’UI des salles blanches.

• Snowsight est utile pour explorer des bases de données et d’autres objets et pour rechercher des objets.

• API des salles blanches : la documentation e l’API est divisée en rubriques fournisseur et consommateur.

Configuration du codage¶

Voici comment configurer votre environnement de codage pour les salles blanches :

-- 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;`

Paramétrage des comptes, des utilisateurs et des rôles¶

Vous n’êtes pas obligé d’utiliser l’UI des salles blanches pour développer des salles blanches : la plupart des fonctionnalités de salle blanche sont disponibles en appelant l’API. Cependant, des fonctionnalités sont disponibles uniquement dans l’UI, et certaines sont plus rapides à exécuter dans l’UI. Et, comme de nombreux utilisateurs utilisent exclusivement l’UI, il est important de voir comment votre salle blanche se comporte dans l’UI. Par conséquent, vous devez demander à un administrateur de salle blanche de vous ajouter en tant que gestionnaire de salle blanche ou à un niveau supérieur dans les comptes de salle blanche appropriés.

En fonction de votre cas d’utilisation, vous pouvez également configurer un compte Snowflake supplémentaire dans différentes régions d’hébergement Web pour tester le comportement inter-Cloud.

Nommez vos comptes Snowflake de test de manière significative pour indiquer leur utilisation typique : par exemple, « Compte consommateur », « Compte fournisseur » et « Compte inter-Cloud ». Cela peut s’avérer utile lorsque vous avez plusieurs comptes de test et que vous devez choisir un compte sur la page de connexion des salles blanches.

Voir ce qui est installé avec l’environnement des salles blanches¶

Snowflake Data Clean Rooms crée de nombreuses bases de données locales lors de l’installation. Vous pouvez trouver des détails sur les tâches et les objets qui sont exécutés ou installés avec un paquet de salle blanche dans Snowflake Data Clean Rooms : objets installés.

Données d’échantillon¶

L’environnement des salles blanches installe quelques ensembles de données d’échantillon que vous pouvez utiliser.

Vous pouvez également générer des données de test synthétiques avec Snowflake

Confirmez que vous utilisez le même compte dans les UI de clean rooms et dans le code¶

Vous devez souvent ouvrir un environnement de codage et les UI de clean rooms pour le même compte Snowflake, par exemple, lorsque vous créez une clean room dans le code, puis que vous vérifiez son apparence dans les UI de clean rooms. Il est important de confirmer que vous utilisez le même compte Snowflake dans chaque cas.

Snowsight n’a pas de raccourci pour ouvrir l’UI des salles blanches pour le même compte, ou l’inverse, vous devez donc vous assurer de vous connecter au même compte dans chaque environnement.

Noms Clean room vs ID des clean rooms¶

Lorsque vous utilisez l’API, pour les procédures qui prennent un argument de nom de salle blanche, déterminez s’il faut utiliser le nom de la salle blanche ou l’ID de la salle blanche comme suit :

• Si la clean room a été créée à l’aide de l’API, utilisez le nom de la clean room.

• Si la salle blanche a été créée dans l’UI des salles blanches, utilisez l’ID de la salle blanche. Vous pouvez voir à la fois le nom de la salle blanche et l’ID en appelant provider.view_cleanrooms ou provider.describe_cleanroom.

Mettre à jour votre salle blanche chaque fois que l’UI est modifiée¶

Lorsque vous modifiez des propriétés de salle blanche qui affectent l’UI, appelez provider.create_or_update_cleanroom_listing pour propager les changements.

Interopérabilité entre les clean rooms créées en code ou dans l’UI¶

Lorsque vous créez une salle blanche à l’aide de l’API, certaines fonctionnalités ne sont pas modifiables dans l’UI des salles blanches. Par exemple, vous ne pouvez pas ajouter de modèles supplémentaires, même des modèles Snowflake de stock, dans le code pour une salle blanche créée par UI. Vous ne pouvez pas non plus modifier les paramètres de confidentialité différentielle.

Le consommateur ne peut pas définir de politiques de jointure ou effectuer d’autres actions de base sur une salle blanche jointe¶

Confirmez que vous avez installé votre clean room avec le rôle approprié (SAMOOHA_APP_ROLE). Si vous n’avez pas utilisé SAMOOHA_APP_ROLE lors de l’installation de la clean room, vous rencontrerez de nombreux problèmes, généralement des erreurs d’autorisation. Si c’est le cas, même consumer.uninstall_cleanroom échouera et vous devrez prendre des mesures supplémentaires pour désinstaller puis réinstaller la clean room avec le rôle correct.

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

Impossible de trouver une clean room que vous avez créée¶

Si vous avez créé une clean room dans un compte mais que vous ne la voyez pas dans le compte du collaborateur, voici quelques raisons possibles :

• La clean room a été créée dans une région d’hébergement Cloud différente et vous n’avez pas activé l’exécution automatique inter-Cloud.

• Vous n’avez pas publié votre clean room en appelant provider.create_or_update_cleanroom_listing.

• Vous appelez consumer.view_cleanrooms() au lieu de provider.view_cleanrooms() (ou l’inverse).

• Vous n’avez pas partagé la clean room, vous avez partagé la clean room avec le mauvais compte, ou vous avez ouvert le mauvais compte de collaborateur dans l’UI/CLI Clean rooms de Snowsight. Confirmez que le compte sur lequel vous pensez voir votre clean room est celui avec lequel vous avez partagé la clean room, et que vous êtes connecté à ce compte partagé.

• Il y a un petit délai entre la publication d’une clean room et le moment où elle devient visible pour le collaborateur.

Fonction inconnue¶

Si vous appelez une procédure et obtenez une erreur comme l’extrait suivant :

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

Voici quelques causes possibles :

Vous avez saisi le mauvais espace de noms.

Veillez à appeler la version consumer ou provider appropriée de votre procédure. De nombreuses procédures comportent une version pour le fournisseur et une version pour le consommateur.

Vous avez mal saisi le nom de la fonction.

Consultez le guide de référence pour connaître le nom correct.

Un rôle d’exécution avec accès limité vous a été attribué et la fonction que vous avez appelée n’est pas autorisée par votre rôle.

Testez ceci en exécutant le code SQL suivant :

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

Copy

Si l’extrait de code renvoie TRUE, vous avez des autorisations de rôle d’exécution avec accès limité sur l’API de salle blanche. Si vous avez besoin d’un niveau accès plus élevé, demandez à un administrateur de salle blanche de vous accorder un accès complet. Voir la liste des procédures de rôle d’exécution autorisées dans la documentation de consumer.grant_run_on_cleanrooms_to_role.

Vous n’avez pas le rôle SAMOOHA_APP_ROLE

Pour savoir si vous pouvez utiliser le rôle SAMOOHA_APP_ROLE, exécutez la commande suivante :

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

Si vous n’obtenez aucun résultat, demandez à un administrateur de vous donner l’accès API à la salle blanche.

Voir si un utilisateur a installé une salle blanche¶

Vous pouvez vérifier si un utilisateur donné a installé une salle blanche donnée en exécutant le code SQL suivant. Remplacez $consumer_locator et $cleanroom_name avec le localisateur de consommateur et le nom de la salle blanche.

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

Vérifier les requêtes ou l’historique des analyses¶

Vous pouvez voir l’historique de vos requêtes pour les analyses exécutées dans l’UI ou dans le code. Les historiques sont stockés et vérifiés séparément.