DESCRIBE VOLUME

  • Article

S’applique à : coche marquée oui Databricks SQL coche marquée oui Databricks Runtime 13.3 LTS et versions ultérieures coche marquée oui Unity Catalog uniquement

Retourne les métadonnées d’un schéma existant. Les informations de métadonnées incluent le nom du volume, le schéma, le catalogue, le type, le commentaire et le propriétaire. Si l’option facultative EXTENDED est spécifiée, retourne les informations de métadonnées de base ainsi que les autres propriétés de catalogue.

Syntaxe

DESCRIBE VOLUME volume_name

Paramètres

  • volume_name : nom d’un volume existant dans le catalogue Unity. Si le nom n’existe pas, une exception est levée.

Retours

Un jeu de résultats dans une ligne unique avec les colonnes suivantes :

  • name STRING NOT NULL: le nom du volume ; il identifie l’objet volume.
  • catalog STRING NOT NULL: le nom du catalogue contenant le volume.
  • database STRING NOT NULL: le nom du schéma contenant le volume.
  • owner STRING NOT NULL:le principal propriétaire du volume.
  • storageLocation STRING: le chemin d’accès de l’emplacement externe où réside le volume externe. NULL pour les volumes managés.
  • volumeType STRING NOT NULL: le type du volume, valeurs possibles : EXTERNAL, MANAGED.
  • comment STRING: un commentaire joint au volume.

Exemples

- Describe an external volume
> DESCRIBE VOLUME my_external_volume
  name               catalog         database       owner storageLocation                    volumeType comment
  ------------------ --------------- -------------- ----- ---------------------------------- ---------- ---------------
  my_external_volume default_catalog default_schema Alice s3://my-bucket/my-location/my-path EXTERNAL   My first volume

- Describe a managed volume
> DESCRIBE VOLUME managed_volume
  name           catalog         database       owner storageLocation                      volumeType comment
  -------------- --------------- -------------- ----- ------------------------------------ ---------- -----------------------
  managed_volume default_catalog default_schema Alice s3://<metastore-root>/volumes/<uuid> MANAGED    My first managed volume