DESCRIBE VOLUME

  • [アーティクル]

適用対象:check marked yes Databricks SQL Databricks Runtime 13.3 LTS 以降 Unity Catalog のみ

既存のボリュームのメタデータを返します。 メタデータ情報には、ボリューム名、スキーマ、カタログ、種類、コメント、所有者が含まれます。 省略可能な EXTENDED オプションを指定すると、基本的なメタデータ情報と他のカタログ プロパティが返されます。

構文

DESCRIBE VOLUME volume_name

パラメーター

  • volume_name: Unity Catalog 内の既存のボリュームの名前。 名前が存在しない場合は、例外がスローされます。

返品

次の列を含む単一行の結果セット:

  • name STRING NOT NULL: ボリュームの名前。ボリューム オブジェクトを識別します。
  • catalog STRING NOT NULL: ボリュームを含むカタログの名前。
  • database STRING NOT NULL: ボリュームを含むスキーマの名前。
  • owner STRING NOT NULL: ボリュームを所有するプリンシパル。
  • storageLocation STRING: 外部ボリュームが存在する外部の場所のパス。 マネージド ボリュームの場合は NULL。
  • volumeType STRING NOT NULL: ボリュームの種類。値は EXTERNAL、MANAGED を使うことができます。
  • comment STRING: ボリュームにアタッチされたコメント。

例

- 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