STRUCT
类型描述
STRUCT 类型用于将多个字段组合成一个结构体,每个字段可以有自己的名字和类型,适合表示嵌套或复杂的业务数据结构。
STRUCT<field_name:field_type [COMMENT 'comment_string'], ... >field_name表征名字,不可为空,不可重复,名字不区分大小写。field_type表征类型,类型是Nullable的,不可指定NOT NULL,支持的类型有:BOOLEAN, TINYINT, SMALLINT, INT, BIGINT, LARGEINT, FLOAT, DOUBLE, DECIMAL, DATE, DATETIME, TIMESTAMPTZ, CHAR, VARCHAR, STRING, IPTV4, IPV6, ARRAY, MAP, STRUCT。[COMMENT 'comment-string']表征注释,可选的。
类型约束
STRUCT类型支持的最大嵌套深度为 9。STRUCT类型之间的转换取决于内部的类型之间是否能转换(名字不影响转换),STRUCT类型不能转成其他类型。- 字符串类型可以转换成
STRUCT类型(通过解析的形式,解析失败返回 NULL)。
- 字符串类型可以转换成
STRUCT类型在AGGREGATE表模型中只支持REPLACE和REPLACE_IF_NOT_NULL,在任何表模型中都无法作为KEY列,无法作为分区分桶列。STRUCT类型的列不支持比较或者算数运算,不支持ORDER BY和GROUP BY操作,不支持作为JOIN KEY,不支持在DELETE语句中使用。STRUCT类型的列不支持建立任何索引。
类型构造
- 使用
STRUCT()可以构造一个的STRUCT类型的值,STRUCT内部的名字从col1开始。SELECT STRUCT(1, 'a', "abc");
+--------------------------------------+
| STRUCT(1, 'a', "abc") |
+--------------------------------------+
| {"col1":1, "col2":"a", "col3":"abc"} |
+--------------------------------------+ - 使用
NAMED_STRUCT()构造一个既定的STRUCT类型的值。SELECT NAMED_STRUCT("name", "Jack", "id", 1728923);
+---------------------------------------------+
| NAMED_STRUCT("name", "Jack", "id", 1728923) |
+---------------------------------------------+
| {"name":"Jack", "id":1728923} |
+---------------------------------------------+
修改类型
-
STRUCT的子列类型为VARCHAR时,才允许进行修改。- 只允许将
VARCHAR的参数从小改到大。反之不行。
CREATE TABLE struct_table (
`k` INT NOT NULL,
`struct_varchar` STRUCT<name: VARCHAR(10), age: INT>
) ENGINE=OLAP
DUPLICATE KEY(`k`)
DISTRIBUTED BY HASH(`k`) BUCKETS 1
PROPERTIES (
"replication_num" = "1"
);
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(20), age: INT>; - 只允许将
-
STRUCT类型内部的子列不支持删除,可以在末尾增加子列。
CREATE TABLE struct_table (
`k` INT NOT NULL,
`struct_varchar` STRUCT<name: VARCHAR(10), age: INT>
) ENGINE=OLAP
DUPLICATE KEY(`k`)
DISTRIBUTED BY HASH(`k`) BUCKETS 1
PROPERTIES (
"replication_num" = "1"
);
-- 在末尾增加一个子列
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(10), age: INT, id: INT>;
元素访问
可以通过以下等价方式访问 STRUCT 内部的某一个子列:
-
ELEMENT_AT(struct, k/field_name)函数。 -
下标运算符
struct[k]/struct['field_name']。 -
点运算符
struct_col.field_name(仅适用于STRUCT列)。
其中 k 表征位置(常量,从 1 开始),field_name 是子列的名字(字符串常量)。字段名按大小写不敏感匹配。访问不存在的字段名或越界的位置会报错。
警告
因业界其他数据库和查询引擎均无此函数,STRUCT_ELEMENT 自 4.1.3 版本起已移除,请改用 ELEMENT_AT 或下标 / 点运算符。
-
使用
ELEMENT_AT或下标运算符按位置或字段名访问。SELECT ELEMENT_AT(NAMED_STRUCT("name", "Jack", "id", 1728923), 1);
+------------------------------------------------------------+
| ELEMENT_AT(NAMED_STRUCT('name', 'Jack', 'id', 1728923), 1) |
+------------------------------------------------------------+
| Jack |
+------------------------------------------------------------+
SELECT NAMED_STRUCT("name", "Jack", "id", 1728923)['id'];
+--------------------------------------------------+
| NAMED_STRUCT('name', 'Jack', 'id', 1728923)['id'] |
+--------------------------------------------------+
| 1728923 |
+--------------------------------------------------+ -
对于
STRUCT列,使用点运算符按名字访问子列,并支持嵌套访问,如s.a.b。-- 表中有一个 STRUCT 列:s STRUCT<a: INT, b: DOUBLE>
SELECT s.a, s.b FROM struct_table;
-- 嵌套 STRUCT 列:s STRUCT<s: STRUCT<s: STRUCT<s: INT>>>
SELECT s.s.s.s FROM nested_struct_table;
示例
-
嵌套复杂类型
-- 建表
CREATE TABLE IF NOT EXISTS struct_table (
id INT,
struct_complex STRUCT<
basic_info: STRUCT<name: STRING, age: INT>,
contact: STRUCT<email: STRING, phone: STRING>,
preferences: STRUCT<tags: ARRAY<STRING>, settings: MAP<STRING, INT>>,
metadata: STRUCT<
created_at: DATETIME,
updated_at: DATETIME,
stats: STRUCT<views: INT, clicks: INT>
>
>
) ENGINE=OLAP
DUPLICATE KEY(id)
DISTRIBUTED BY HASH(id) BUCKETS 1
PROPERTIES (
"replication_allocation" = "tag.location.default: 1"
);
-- 插入
INSERT INTO struct_table VALUES (1, STRUCT(
STRUCT('John', 25),
STRUCT('john@example.com', '1234567890'),
STRUCT(['tag1', 'tag2'], MAP('setting1', 1, 'setting2', 2)),
STRUCT('2021-01-01 00:00:00', '2021-01-02 00:00:00', STRUCT(100, 50))
));
-- 查询(嵌套 struct 字段访问使用点运算符)
SELECT struct_complex.basic_info.name FROM struct_table order by id;
+--------------------------------+
| struct_complex.basic_info.name |
+--------------------------------+
| John |
+--------------------------------+
SELECT struct_complex.metadata.stats.views FROM struct_table order by id;
+-------------------------------------+
| struct_complex.metadata.stats.views |
+-------------------------------------+
| 100 |
+-------------------------------------+ -
修改类型
-- 建表
CREATE TABLE struct_table (
`k` INT NOT NULL,
`struct_varchar` STRUCT<name: VARCHAR(10), age: INT>
) ENGINE=OLAP
DUPLICATE KEY(`k`)
DISTRIBUTED BY HASH(`k`) BUCKETS 1
PROPERTIES (
"replication_num" = "1"
);
-- 修改 name 这一列的类型
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(20), age: INT>;
-- 查看列类型
DESC struct_table;
+----------------+----------------------------------+------+-------+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+----------------+----------------------------------+------+-------+---------+-------+
| k | int | No | true | NULL | |
| struct_varchar | struct<name:varchar(20),age:int> | Yes | false | NULL | NONE |
+----------------+----------------------------------+------+-------+---------+-------+
-- 建表
CREATE TABLE struct_table (
`k` INT NOT NULL,
`struct_varchar` STRUCT<name: VARCHAR(10), age: INT>
) ENGINE=OLAP
DUPLICATE KEY(`k`)
DISTRIBUTED BY HASH(`k`) BUCKETS 1
PROPERTIES (
"replication_num" = "1"
);
-- 在末尾增加一个子列
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(10), age: INT, id: INT>;
-- 查看列类型
DESC struct_table;
+----------------+-----------------------------------------+------+-------+---------+-------+
| Field | Type | Null | Key | Default | Extra |
+----------------+-----------------------------------------+------+-------+---------+-------+
| k | int | No | true | NULL | |
| struct_varchar | struct<name:varchar(10),age:int,id:int> | Yes | false | NULL | NONE |
+----------------+-----------------------------------------+------+-------+---------+-------+