DESC VOLUME

Views detailed information about a Volume, including creator, creation time, storage path, connection name, and directory configuration.

Syntax

DESC VOLUME [schema_name.]<volume_name>;

DESCRIBE VOLUME and DESC VOLUME are equivalent.

Parameters

ParameterDescription
schema_nameName of the owning schema; current schema is used if omitted
volume_nameName of the Volume to view

Examples

  1. View External Volume details:

DESC VOLUME my_oss_vol;

Sample output:

+------------------------+--------------------------------+ | info_name | info_value | +------------------------+--------------------------------+ | name | my_oss_vol | | creator | qiliang | | created_time | 2026-05-20 00:23:49.074 | | last_modified_time | 2026-05-20 00:23:49.074 | | external | true | | url | oss://mcp-data-hangzhou/test/ | | connection_name | quick_start.oss_conn | | recursive | true | | directory_enabled | true | | directory_auto_refresh | true | +------------------------+--------------------------------+

  1. View Named Volume details:

DESC VOLUME my_named_vol;

  1. View a Volume under a specific schema:

DESC VOLUME my_schema.my_oss_vol;

Output Field Descriptions

FieldDescription
nameVolume name
creatorCreator username
created_timeCreation time
last_modified_timeLast modification time
externalWhether it is external storage (true means external storage mount, false means internal storage)
urlObject storage path (only has a value for External Volumes)
connection_nameAssociated Storage Connection name (only has a value for External Volumes)
recursiveWhether to recursively scan subdirectories
directory_enabledWhether the directory feature is enabled
directory_auto_refreshWhether to automatically refresh file metadata

Required Privileges

PrivilegeDescription
READ METADATAView Volume object metadata