Skip to main content
Version: Latest-4.1

ALTER STORAGE VOLUME

ALTER STORAGE VOLUME alters the credential properties, comment, or status (enabled) of a storage volume. For more about the properties of a storage volume, see CREATE STORAGE VOLUME. This feature is supported from v3.1.

CAUTION

  • Only users with the ALTER privilege on a specific storage volume can perform this operation.
  • The TYPE and LOCATIONS of an existing storage volume, and the properties aws.s3.enable_partitioned_prefix and aws.s3.num_partitioned_prefix, cannot be altered. StarRocks does not block changes to other properties such as the endpoint or region, and the new values apply to all existing databases and tables that use the storage volume. Alter these properties only to access the same storage, for example, to rotate credentials. If the new values point to different storage, the data of the existing databases and tables becomes inaccessible.
  • When enabled is false, the corresponding storage volume cannot be referenced.
  • In shared-data mode, StarRocks performs a storage accessibility check during ALTER STORAGE VOLUME only when the enable_storage_volume_access_check configuration is enabled (enabled by default). If this check is enabled and the updated credentials or endpoint cannot access remote storage, the statement fails. You can turn off this check by disabling enable_storage_volume_access_check.

Syntax​

ALTER STORAGE VOLUME [ IF EXISTS ] <storage_volume_name>
{ COMMENT = '<comment_string>'
| SET ("key" = "value"[,...]) }

Parameters​

ParameterDescription
storage_volume_nameThe name of the storage volume to alter.
COMMENTThe comment on the storage volume.

For detailed information on the properties that can be altered or added, see CREATE STORAGE VOLUME - PROPERTIES.

Examples​

Example 1: Disable the storage volume my_s3_volume.

MySQL > ALTER STORAGE VOLUME my_s3_volume
-> SET ("enabled" = "false");
Query OK, 0 rows affected (0.01 sec)

Example 2: Alter the credential information of the storage volume my_s3_volume.

MySQL > ALTER STORAGE VOLUME my_s3_volume
-> SET (
-> "aws.s3.use_instance_profile" = "true"
-> );
Query OK, 0 rows affected (0.00 sec)

Relevant SQL statements​