Aller au contenu principal

groupe de commandesvolumes

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 volumes de la CLI Databricks contient des commandes pour gérer les volumes dans Unity Catalog. Les volumes offrent des fonctionnalités pour l'accès, le stockage, la gouvernance, l'organisation et le traitement des fichiers. Consultez Qu'est-ce que les volumes Unity Catalog ?.

Création de volumes Databricks

Créer un nouveau volume.

L'utilisateur pourrait créer soit un volume externe, soit un volume géré. Un volume externe sera créé à l'emplacement externe spécifié, tandis qu'un volume géré sera situé à l'emplacement default spécifié par le schéma parent, le catalogue parent ou le métastore.

Pour que la création de volume aboutisse, l'utilisateur doit remplir les conditions suivantes :

  • L'appelant doit être un administrateur de métastore, ou le propriétaire du catalogue et du schéma parents, ou disposer du privilège USE_CATALOG sur le catalogue parent et du privilège USE_SCHEMA sur le schéma parent.
  • L'appelant doit disposer du privilège CREATE VOLUME sur le schéma parent.

Pour un volume externe, les conditions suivantes doivent également être remplies :

  • L'appelant doit disposer du privilège CREATE EXTERNAL VOLUME sur l'emplacement externe.
  • Il n'y a pas d'autres tables, ni volumes existants dans l'emplacement de stockage spécifié. – L'emplacement de stockage spécifié n'est pas sous l'emplacement d'autres tables, volumes, catalogues ou schémas.
databricks volumes create CATALOG_NAME SCHEMA_NAME NAME VOLUME_TYPE [flags]

Arguments

CATALOG_NAME

Le nom du catalogue où se trouvent le schéma et le volume

SCHEMA_NAME

Nom du schéma où se trouve le volume.

NAME

Le nom du volume

VOLUME_TYPE

Le type de volume. Un volume externe est situé dans l'emplacement externe spécifié. Un volume géré se trouve à l'emplacement par default spécifié par le schéma parent, le catalogue parent ou le Metastore. Voir les volumes gérés par rapport aux volumes externes. Valeurs prises en charge : EXTERNAL, MANAGED

Options

--comment string

Le commentaire joint au volume.

--json JSON

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

--storage-location string

L'emplacement de stockage sur le cloud.

Indicateurs globaux

Exemples

L'exemple suivant crée un volume géré :

Bash
databricks volumes create my_catalog my_schema my_volume MANAGED

L'exemple suivant crée un volume externe avec un commentaire :

Bash
databricks volumes create my_catalog my_schema my_external_volume EXTERNAL --storage-location s3://my-bucket/my-volume --comment "External volume for data processing"

suppression de volumes Databricks

Supprimer un volume du catalogue et du schéma parents spécifiés.

L'appelant doit être un administrateur de metastore ou un propriétaire du volume. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks volumes delete NAME [flags]

Arguments

NAME

Le nom à trois niveaux (entièrement qualifié) du volume

Options

Indicateurs globaux

Exemples

L’exemple suivant supprime un volume :

Bash
databricks volumes delete my_catalog.my_schema.my_volume

liste des volumes Databricks

Liste les volumes pour le métastore actuel sous le catalogue et le schéma parents.

Les volumes renvoyés sont filtrés en fonction des privilèges de l'utilisateur appelant. Par exemple, l'administrateur du metastore peut lister tous les volumes. Un utilisateur standard doit être le propriétaire ou avoir le privilège READ VOLUME sur le volume pour recevoir les volumes dans la réponse. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

Il n’y a aucune garantie d’un ordre spécifique des éléments dans le tableau.

databricks volumes list CATALOG_NAME SCHEMA_NAME [flags]

Arguments

CATALOG_NAME

L'identifiant du catalogue

SCHEMA_NAME

L'identifiant du schéma

Options

--include-browse

Faut-il inclure les volumes dans la réponse pour lesquels le principal ne peut accéder qu'à des métadonnées sélectives.

--max-results int

Nombre maximal de volumes à renvoyer (longueur de page).

--page-token string

Jeton opaque renvoyé par une requête précédente.

Indicateurs globaux

Exemples

L'exemple suivant répertorie tous les volumes d'un catalogue et d'un schéma :

Bash
databricks volumes list my_catalog my_schema

lecture des volumes Databricks

Obtenez un volume du métastore pour un catalogue et un schéma spécifiques.

L'appelant doit être un administrateur de métastore ou un propriétaire du volume (ou disposer du privilège READ VOLUME sur celui-ci). Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

databricks volumes read NAME [flags]

Arguments

NAME

Le nom à trois niveaux (entièrement qualifié) du volume

Options

--include-browse

Faut-il inclure les volumes dans la réponse pour lesquels le principal ne peut accéder qu'à des métadonnées sélectives.

Indicateurs globaux

Exemples

L'exemple suivant récupère des informations sur un volume :

Bash
databricks volumes read my_catalog.my_schema.my_volume

L'exemple suivant obtient des informations sur le volume, y compris les métadonnées de navigation :

Bash
databricks volumes read my_catalog.my_schema.my_volume --include-browse

Mise à jour des volumes Databricks

Mettre à jour le volume spécifié sous le catalogue et le schéma parents spécifiés.

L'appelant doit être un administrateur de metastore ou un propriétaire du volume. Dans ce dernier cas, l'appelant doit également être le propriétaire ou avoir le privilège USE_CATALOG sur le catalogue parent et le privilège USE_SCHEMA sur le schéma parent.

Actuellement, seuls le nom, le propriétaire ou le commentaire du volume peuvent être mis à jour.

databricks volumes update NAME [flags]

Arguments

NAME

Le nom à trois niveaux (entièrement qualifié) du volume

Options

--comment string

Le commentaire joint au volume.

--json JSON

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

--new-name string

Nouveau nom pour le volume.

--owner string

L'identifiant de l'utilisateur qui possède le volume.

Indicateurs globaux

Exemples

L'exemple suivant met à jour le commentaire d'un volume :

Bash
databricks volumes update my_catalog.my_schema.my_volume --comment "Updated comment for my volume"

L'exemple suivant modifie le propriétaire d'un volume :

Bash
databricks volumes update my_catalog.my_schema.my_volume --owner someone@example.com

L'exemple suivant renomme un volume :

Bash
databricks volumes update my_catalog.my_schema.my_volume --new-name my_new_volume_name

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