跳至主要内容

gcs 表函数

提供了一个类似表的接口,用于从Google Cloud StorageSELECTINSERT数据。需要Storage Object User IAM 角色

这是s3 表函数的别名。

如果您的集群中有多个副本,则可以使用s3Cluster 函数(它适用于 GCS)来并行化插入操作。

语法

gcs(url [, NOSIGN | hmac_key, hmac_secret] [,format] [,structure] [,compression_method])
gcs(named_collection[, option=value [,..]])
GCS

GCS 表函数通过使用 GCS XML API 和 HMAC 密钥与 Google Cloud Storage 集成。有关端点和 HMAC 的更多详细信息,请参阅Google 互操作性文档

参数

  • url — 文件的存储桶路径。在只读模式下支持以下通配符:***?{abc,def}{N..M},其中 NM — 数字,'abc''def' — 字符串。
    GCS

    由于 Google XML API 的端点与 JSON API 不同,因此 GCS 路径采用这种格式

    https://storage.googleapis.com/<bucket>/<folder>/<filename(s)>

    而不是https://storage.cloud.google.com

  • NOSIGN — 如果此关键字代替凭据提供,则所有请求都不会签名。
  • hmac_keyhmac_secret — 指定要与给定端点一起使用的凭据的密钥。可选。
  • format — 文件的格式
  • structure — 表的结构。格式 'column1_name column1_type, column2_name column2_type, ...'
  • compression_method — 参数可选。支持的值:nonegzip/gzbrotli/brxz/LZMAzstd/zst。默认情况下,它将根据文件扩展名自动检测压缩方法。

也可以使用命名集合传递参数。在这种情况下,urlformatstructurecompression_method 的工作方式相同,并且支持一些额外的参数

  • access_key_idhmac_key,可选。
  • secret_access_keyhmac_secret,可选。
  • filename — 如果指定,则附加到 url。
  • use_environment_credentials — 默认启用,允许使用环境变量 AWS_CONTAINER_CREDENTIALS_RELATIVE_URIAWS_CONTAINER_CREDENTIALS_FULL_URIAWS_CONTAINER_AUTHORIZATION_TOKENAWS_EC2_METADATA_DISABLED 传递额外参数。
  • no_sign_request — 默认禁用。
  • expiration_window_seconds — 默认值为 120。

返回值

一个具有指定结构的表,用于在指定文件中读取或写入数据。

示例

从 GCS 文件 https://storage.googleapis.com/my-test-bucket-768/data.csv 中的表中选择前两行

SELECT *
FROM gcs('https://storage.googleapis.com/my-test-bucket-768/data.csv', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32')
LIMIT 2;
┌─column1─┬─column2─┬─column3─┐
│ 1 │ 2 │ 3 │
│ 3 │ 2 │ 1 │
└─────────┴─────────┴─────────┘

类似的,但来自使用 gzip 压缩方法的文件

SELECT *
FROM gcs('https://storage.googleapis.com/my-test-bucket-768/data.csv.gz', 'CSV', 'column1 UInt32, column2 UInt32, column3 UInt32', 'gzip')
LIMIT 2;
┌─column1─┬─column2─┬─column3─┐
│ 1 │ 2 │ 3 │
│ 3 │ 2 │ 1 │
└─────────┴─────────┴─────────┘

用法

假设我们在 GCS 上有几个具有以下 URI 的文件

计算以数字 1 到 3 结尾的文件中的行数

SELECT count(*)
FROM gcs('https://storage.googleapis.com/my-test-bucket-768/{some,another}_prefix/some_file_{1..3}.csv', 'CSV', 'name String, value UInt32')
┌─count()─┐
│ 18 │
└─────────┘

计算这两个目录中所有文件的总行数

SELECT count(*)
FROM gcs('https://storage.googleapis.com/my-test-bucket-768/{some,another}_prefix/*', 'CSV', 'name String, value UInt32')
┌─count()─┐
│ 24 │
└─────────┘
危险

如果您的文件列表包含带有前导零的数字范围,请为每个数字单独使用带括号的结构或使用 ?

计算名为 file-000.csvfile-001.csv、...、file-999.csv 的文件的总行数

SELECT count(*)
FROM gcs('https://storage.googleapis.com/my-test-bucket-768/big_prefix/file-{000..999}.csv', 'CSV', 'name String, value UInt32');
┌─count()─┐
│ 12 │
└─────────┘

将数据插入文件 test-data.csv.gz

INSERT INTO FUNCTION gcs('https://storage.googleapis.com/my-test-bucket-768/test-data.csv.gz', 'CSV', 'name String, value UInt32', 'gzip')
VALUES ('test-data', 1), ('test-data-2', 2);

从现有表中将数据插入文件 test-data.csv.gz

INSERT INTO FUNCTION gcs('https://storage.googleapis.com/my-test-bucket-768/test-data.csv.gz', 'CSV', 'name String, value UInt32', 'gzip')
SELECT name, value FROM existing_table;

Glob ** 可用于递归目录遍历。考虑以下示例,它将递归地获取 my-test-bucket-768 目录中的所有文件

SELECT * FROM gcs('https://storage.googleapis.com/my-test-bucket-768/**', 'CSV', 'name String, value UInt32', 'gzip');

以下从 my-test-bucket 目录内任何文件夹中的所有 test-data.csv.gz 文件获取数据,递归进行

SELECT * FROM gcs('https://storage.googleapis.com/my-test-bucket-768/**/test-data.csv.gz', 'CSV', 'name String, value UInt32', 'gzip');

对于生产用例,建议使用命名集合。这是一个示例


CREATE NAMED COLLECTION creds AS
access_key_id = '***',
secret_access_key = '***';
SELECT count(*)
FROM gcs(creds, url='https://s3-object-url.csv')

分区写入

如果在将数据插入 GCS 表时指定了 PARTITION BY 表达式,则会为每个分区值创建一个单独的文件。将数据拆分为单独的文件有助于提高读取操作的效率。

示例

  1. 在密钥中使用分区 ID 会创建单独的文件
INSERT INTO TABLE FUNCTION
gcs('http://bucket.amazonaws.com/my_bucket/file_{_partition_id}.csv', 'CSV', 'a String, b UInt32, c UInt32')
PARTITION BY a VALUES ('x', 2, 3), ('x', 4, 5), ('y', 11, 12), ('y', 13, 14), ('z', 21, 22), ('z', 23, 24);

结果,数据将写入三个文件:file_x.csvfile_y.csvfile_z.csv

  1. 在存储桶名称中使用分区 ID 会在不同的存储桶中创建文件
INSERT INTO TABLE FUNCTION
gcs('http://bucket.amazonaws.com/my_bucket_{_partition_id}/file.csv', 'CSV', 'a UInt32, b UInt32, c UInt32')
PARTITION BY a VALUES (1, 2, 3), (1, 4, 5), (10, 11, 12), (10, 13, 14), (20, 21, 22), (20, 23, 24);

结果,数据将写入不同存储桶中的三个文件:my_bucket_1/file.csvmy_bucket_10/file.csvmy_bucket_20/file.csv

另请参阅