Aller au contenu principal

groupe de commandesclean-rooms

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Le groupe de commandes clean-rooms au sein de la CLI Databricks vous permet de gérer les clean rooms. Une clean room utilise OpenSharing et le compute serverless pour fournir un environnement sécurisé et protégeant la confidentialité où plusieurs parties peuvent collaborer sur des données d'entreprise sensibles sans accès direct aux données de chacun. Consultez Qu'est-ce que Databricks Clean Rooms ?.

databricks clean-rooms création

Créez une nouvelle salle blanche avec les collaborateurs spécifiés. Cette méthode est asynchrone ; le champ de nom renvoyé à l'intérieur du champ clean_room peut être utilisé pour interroger le statut de la salle blanche, en utilisant la méthode get. Lorsque cette méthode retourne, la salle blanche sera dans un état PROVISIONING, avec seulement le nom, le propriétaire, le commentaire, created_at et le statut renseignés. La salle blanche sera utilisable une fois qu'elle entrera dans un état ACTIVE.

L'appelant doit être un administrateur de métastore ou disposer du privilège CREATE_CLEAN_ROOM sur le métastore.

databricks clean-rooms create [flags]

Arguments

Aucun

Options

--comment string

Commentaire pour la salle blanche.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--name string

Le nom de la salle blanche.

--owner string

Il s'agit du nom d'utilisateur Databricks du propriétaire de l'élément sécurisable de la salle blanche locale pour la gestion des autorisations.

Indicateurs globaux

Exemples

L'exemple suivant crée une salle blanche avec un nom et un propriétaire :

Bash
databricks clean-rooms create --name "my-clean-room" --owner "someone@example.com"

L'exemple suivant crée une salle blanche avec un commentaire :

Bash
databricks clean-rooms create --name "analytics-clean-room" --owner "someone@example.com" --comment "Clean room for analytics collaboration"

databricks clean-rooms create-output-catalog

Créez le catalogue de sortie de la salle blanche.

databricks clean-rooms create-output-catalog CLEAN_ROOM_NAME [flags]

Arguments

CLEAN_ROOM_NAME

Nom de la salle blanche.

Options

--catalog-name string

Le nom du catalogue de sortie dans Unity Catalog.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant crée un catalogue de sortie pour une salle blanche :

Bash
databricks clean-rooms create-output-catalog my-clean-room --catalog-name "my_output_catalog"

supprimer les clean-rooms databricks

Supprimer une salle blanche. Après suppression, la salle blanche sera supprimée du metastore. Si les autres collaborateurs n'ont pas supprimé la salle blanche, ils l'auront toujours dans leur métastore, mais elle sera à l'état SUPPRIMÉ et aucune opération autre que la suppression ne pourra être effectuée dessus.

databricks clean-rooms delete NAME [flags]

Arguments

NAME

Nom de la salle blanche.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime une salle blanche :

Bash
databricks clean-rooms delete my-clean-room

databricks clean-rooms get

Obtenez les détails d'une salle blanche en fonction de son nom.

databricks clean-rooms get NAME [flags]

Arguments

NAME

Nom de la salle blanche.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient les détails d'une salle blanche :

Bash
databricks clean-rooms get my-clean-room

L'exemple suivant obtient les détails de la salle blanche à l'aide d'un profil spécifique :

Bash
databricks clean-rooms get analytics-clean-room --profile production

liste des salles blanches Databricks

Répertorier toutes les salles blanches du metastore. Seules les salles blanches auxquelles l'appelant a accès sont renvoyées.

databricks clean-rooms list [flags]

Arguments

Aucun

Options

--page-size int

Nombre maximal de salles blanches à renvoyer (c'est-à-dire, la longueur de la page).

--page-token string

Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.

Indicateurs globaux

Exemples

L'exemple suivant répertorie toutes les salles blanches accessibles :

Bash
databricks clean-rooms list

L'exemple suivant répertorie les salles blanches avec une taille de page spécifique :

Bash
databricks clean-rooms list --page-size 10

Mise à jour de Databricks Clean Rooms

Mettre à jour une salle blanche. L'appelant doit être le propriétaire de la salle blanche, disposer du privilège MODIFY_CLEAN_ROOM ou être administrateur du métastore.

Lorsque l'appelant est un administrateur du métastore, seul le champ owner peut être mis à jour.

databricks clean-rooms update NAME [flags]

Arguments

NAME

Nom de la salle blanche.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Exemples

L'exemple suivant met à jour une salle blanche à l'aide de la configuration JSON.

Bash
databricks clean-rooms update my-clean-room --json '{"comment": "Updated clean room description"}'

L'exemple suivant met à jour un propriétaire de salle blanche (administrateur du metastore uniquement) :

Bash
databricks clean-rooms update my-clean-room --json '{"owner": "new-someone@example.com"}'

L'exemple suivant met à jour une salle blanche à l'aide d'un fichier JSON :

Bash
databricks clean-rooms update my-clean-room --json @update-config.json

Drapeaux globaux

--debug

Activer ou non la journalisation de débogage.

-h ou --help

Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.

--log-file chaîne

Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.

--log-format Format

Le type de format de log, text ou json. La valeur par default est text.

--log-level chaîne

Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.

-o, --output Type

Le type de sortie de commande, text ou json. La valeur par default est text.

-p, --profile chaîne

Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

Le format pour afficher les logs de progression : default, append, inplace ou json

-t, --target chaîne

Le cas échéant, la cible de bundle à utiliser