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,LOCATIONS, and other path-related properties of an existing storage volume cannot be altered. You can only alter its credential-related properties. If you changed the path-related configuration items, the databases and tables you created before the change become read-only, and you cannot load data into them.- When
enabledisfalse, the corresponding storage volume cannot be referenced.- In shared-data mode, StarRocks performs a storage accessibility check during
ALTER STORAGE VOLUMEonly when theenable_storage_volume_access_checkconfiguration 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 disablingenable_storage_volume_access_check.
Syntaxβ
ALTER STORAGE VOLUME [ IF EXISTS ] <storage_volume_name>
{ COMMENT = '<comment_string>'
| SET ("key" = "value"[,...]) }
Parametersβ
| Parameter | Description |
|---|---|
| storage_volume_name | The name of the storage volume to alter. |
| COMMENT | The 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)
