Skip to main content
Version: Latest-3.3

DESC STORAGE VOLUME

Description

Describes a storage volume. This feature is supported from v3.1.

CAUTION

Only users with the USAGE privilege on a specific storage volume can perform this operation.

Syntax

DESC[RIBE] STORAGE VOLUME <storage_volume_name>

Parameters

ParameterDescription
storage_volume_nameThe name of the storage volume to describe.

Return value

ReturnDescription
NameThe name of the storage volume.
TypeThe type of the remote storage system. Valid values: S3 and AZBLOB.
IsDefaultWhether the storage volume is the default storage volume.
LocationThe location of the remote storage system.
ParamsThe credential information used to access the remote storage system.
EnabledWhether the storage volume is enabled.
CommentThe comment on the storage volume.

Examples

Example 1: Describe the storage volume my_s3_volume.

MySQL > DESCRIBE STORAGE VOLUME my_s3_volume\G
*************************** 1. row ***************************
Name: my_s3_volume
Type: S3
IsDefault: false
Location: s3://defaultbucket/test/
Params: {"aws.s3.access_key":"xxxxxxxxxx","aws.s3.secret_key":"yyyyyyyyyy","aws.s3.endpoint":"https://s3.us-west-2.amazonaws.com","aws.s3.region":"us-west-2","aws.s3.use_instance_profile":"true","aws.s3.use_aws_sdk_default_behavior":"false"}
Enabled: false
Comment:
1 row in set (0.00 sec)

Relevant SQL statements