跳到主要内容
版本：Stable-3.1

CREATE STORAGE VOLUME

功能​

为远程存储系统创建存储卷。该功能自 v3.1 起支持。

存储卷由远程存储系统的属性和认证信息组成。您可以在 StarRocks 存算分离集群中创建数据库和云原生表时引用存储卷。

注意

仅拥有 SYSTEM 级 CREATE STORAGE VOLUME 权限的用户可以执行该操作。

语法​

CREATE STORAGE VOLUME [IF NOT EXISTS] <storage_volume_name>
TYPE = { S3 | HDFS | AZBLOB }
LOCATIONS = ('<remote_storage_path>')
[ COMMENT '<comment_string>' ]
PROPERTIES
("key" = "value",...)

参数说明​

参数说明
storage_volume_name存储卷的名称。请注意，您无法创建名为 builtin_storage_volume 的存储卷，因为该名称被用于创建内置存储卷。
TYPE远程存储系统的类型。有效值：S3 、AZBLOB 和 HDFS。S3 代表AWS S3 或与 S3 协议兼容的存储系统。AZBLOB 代表 Azure Blob Storage（自 v3.1.1 起支持）。HDFS 代表 HDFS 集群。
LOCATIONS远程存储系统的位置。格式如下：
  • AWS S3 或与 S3 协议兼容的存储系统：s3://<s3_path>。<s3_path> 必须为绝对路径，如 s3://testbucket/subpath。
  • Azure Blob Storage: azblob://<azblob_path>。<azblob_path> 必须为绝对路径，如 azblob://testcontainer/subpath。
  • HDFS：hdfs://<ip>:<port>/<hdfs_path>。<hdfs_path> 必须为绝对路径，如 hdfs://127.0.0.1:9000/user/xxx/starrocks。
COMMENT存储卷的注释。
PROPERTIES"key" = "value" 形式的参数对，用以指定访问远程存储系统的属性和认证信息。有关详细信息，请参阅 PROPERTIES。

PROPERTIES​

  • 如果您使用 AWS S3：

    • 如果您使用 AWS SDK 默认的认证凭证，请设置以下属性：

      "enabled" = "{ true | false }",
      "aws.s3.region" = "<region>",
      "aws.s3.endpoint" = "<endpoint_url>",
      "aws.s3.use_aws_sdk_default_behavior" = "true"

    • 如果您使用 IAM user-based 认证，请设置以下属性：

      "enabled" = "{ true | false }",
      "aws.s3.region" = "<region>",
      "aws.s3.endpoint" = "<endpoint_url>",
      "aws.s3.use_aws_sdk_default_behavior" = "false",
      "aws.s3.use_instance_profile" = "false",
      "aws.s3.access_key" = "<access_key>",
      "aws.s3.secret_key" = "<secrete_key>"

    • 如果您使用 Instance Profile 认证，请设置以下属性：

      "enabled" = "{ true | false }",
      "aws.s3.region" = "<region>",
      "aws.s3.endpoint" = "<endpoint_url>",
      "aws.s3.use_aws_sdk_default_behavior" = "false",
      "aws.s3.use_instance_profile" = "true"

    • 如果您使用 Assumed Role 认证，请设置以下属性：

      "enabled" = "{ true | false }",
      "aws.s3.region" = "<region>",
      "aws.s3.endpoint" = "<endpoint_url>",
      "aws.s3.use_aws_sdk_default_behavior" = "false",
      "aws.s3.use_instance_profile" = "true",
      "aws.s3.iam_role_arn" = "<role_arn>"

    • 如果您使用外部 AWS 账户通过 Assumed Role 认证，请设置以下属性：

      "enabled" = "{ true | false }",
      "aws.s3.region" = "<region>",
      "aws.s3.endpoint" = "<endpoint_url>",
      "aws.s3.use_aws_sdk_default_behavior" = "false",
      "aws.s3.use_instance_profile" = "true",
      "aws.s3.iam_role_arn" = "<role_arn>",
      "aws.s3.external_id" = "<external_id>"

  • 如果您使用 GCP Cloud Storage，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：us-east-1
    "aws.s3.region" = "<region>",

    -- 例如：https://storage.googleapis.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用阿里云 OSS，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：cn-zhangjiakou
    "aws.s3.region" = "<region>",

    -- 例如：https://oss-cn-zhangjiakou-internal.aliyuncs.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用华为云 OBS，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：cn-north-4
    "aws.s3.region" = "<region>",

    -- 例如：https://obs.cn-north-4.myhuaweicloud.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用腾讯云 COS，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：ap-beijing
    "aws.s3.region" = "<region>",

    -- 例如：https://cos.ap-beijing.myqcloud.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用火山引擎 TOS，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：cn-beijing
    "aws.s3.region" = "<region>",

    -- 例如：https://tos-s3-cn-beijing.ivolces.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用金山云，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：BEIJING
    "aws.s3.region" = "<region>",

    -- 注意请使用三级域名, 金山云不支持二级域名
    -- 例如：jeff-test.ks3-cn-beijing.ksyuncs.com
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用 MinIO，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：us-east-1
    "aws.s3.region" = "<region>",

    -- 例如：http://172.26.xx.xxx:39000
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"

  • 如果您使用 Ceph S3，请设置以下属性：

    "enabled" = "{ true | false }",

    -- 例如：http://172.26.xx.xxx:7480
    "aws.s3.endpoint" = "<endpoint_url>",

    "aws.s3.access_key" = "<access_key>",
    "aws.s3.secret_key" = "<secrete_key>"
    属性描述
    enabled是否启用当前存储卷。默认值：false。已禁用的存储卷无法被引用。
    aws.s3.region需访问的 S3 存储空间的地区，如 us-west-2。
    aws.s3.endpoint访问 S3 存储空间的连接地址，如 https://s3.us-west-2.amazonaws.com。
    aws.s3.use_aws_sdk_default_behavior是否使用 AWS SDK 默认的认证凭证。有效值：true 和 false (默认)。
    aws.s3.use_instance_profile是否使用 Instance Profile 或 Assumed Role 作为安全凭证访问 S3。有效值：true 和 false (默认)。
    • 如果您使用 IAM 用户凭证（Access Key 和 Secret Key）访问 S3，则需要将此项设为 false，并指定 aws.s3.access_key 和 aws.s3.secret_key。
    • 如果您使用 Instance Profile 访问 S3，则需要将此项设为 true。
    • 如果您使用 Assumed Role 访问 S3，则需要将此项设为 true，并指定 aws.s3.iam_role_arn。
    • 如果您使用外部 AWS 账户通过 Assumed Role 认证访问 S3，则需要将此项设为 true，并额外指定 aws.s3.iam_role_arn 和 aws.s3.external_id。
    aws.s3.access_key访问 S3 存储空间的 Access Key。
    aws.s3.secret_key访问 S3 存储空间的 Secret Key。
    aws.s3.iam_role_arn有访问 S3 存储空间权限 IAM Role 的 ARN。
    aws.s3.external_id用于跨 AWS 账户访问 S3 存储空间的外部 ID。

  • 如果您使用 Azure Blob Storage（自 v3.1.1 起支持）：

    • 如果您使用共享密钥（Shared Key）认证，请设置以下 PROPERTIES：

      "enabled" = "{ true | false }",
      "azure.blob.endpoint" = "<endpoint_url>",
      "azure.blob.shared_key" = "<shared_key>"

    • 如果您使用共享访问签名（SAS）认证，请设置以下 PROPERTIES：

      "enabled" = "{ true | false }",
      "azure.blob.endpoint" = "<endpoint_url>",
      "azure.blob.sas_token" = "<sas_token>"

    注意

    创建 Azure Blob Storage Account 时必须禁用分层命名空间。

    属性描述
    enabled是否启用当前存储卷。默认值：false。已禁用的存储卷无法被引用。
    azure.blob.endpointAzure Blob Storage 的链接地址，如 https://test.blob.core.windows.net。
    azure.blob.shared_key访问 Azure Blob Storage 的共享密钥（Shared Key）。
    azure.blob.sas_token访问 Azure Blob Storage 的共享访问签名（SAS）。

  • 如果您使用 HDFS 存储，请设置以下属性：

    "enabled" = "{ true | false }"

    注意

    Storage Volume 当前不支持通过认证接入 HDFS。

示例​

示例一：为 AWS S3 存储空间 defaultbucket 创建存储卷 my_s3_volume，使用 IAM user-based 认证，并启用该存储卷。

CREATE STORAGE VOLUME my_s3_volume
TYPE = S3
LOCATIONS = ("s3://defaultbucket/test/")
PROPERTIES
(
    "aws.s3.region" = "us-west-2",
    "aws.s3.endpoint" = "https://s3.us-west-2.amazonaws.com",
    "aws.s3.use_aws_sdk_default_behavior" = "false",
    "aws.s3.use_instance_profile" = "false",
    "aws.s3.access_key" = "xxxxxxxxxx",
    "aws.s3.secret_key" = "yyyyyyyyyy"
);

示例二：为 HDFS 创建存储卷 my_hdfs_volume，并启用该存储卷。

CREATE STORAGE VOLUME my_hdfs_volume
TYPE = HDFS
LOCATIONS = ("hdfs://127.0.0.1:9000/sr/test/")
PROPERTIES
(
    "enabled" = "true"
);

相关 SQL​