メインコンテンツまでスキップ
に最終更新

STRUCT

型の説明​

STRUCT 型は複数のフィールドを単一の構造にまとめるために使用します。各フィールドには独自の名前と型を指定でき、ネストした複雑な業務データ構造の表現に適しています。

  • STRUCT<field_name:field_type [COMMENT 'comment_string'], ... >

    • field_name は名前を表し、空にできず、重複できず、大文字と小文字を区別しません。

    • field_type は型を表します。NULL を許容し、NOT NULL は指定できません。サポートされる型は次のとおりです:BOOLEAN, TINYINT, SMALLINT, INT, BIGINT, LARGEINT, FLOAT, DOUBLE, DECIMAL, DATE, DATETIME, TIMESTAMPTZ, CHAR, VARCHAR, STRING, IPV4, IPV6, ARRAY, MAP, STRUCT。

    • [COMMENT 'comment-string'] は省略可能なコメントを表します。

型の制約​

  • STRUCT 型でサポートされる最大ネスト深度は 9 です。

  • STRUCT 型間の変換は、内部型を変換できるかどうかに依存します(名前は変換に影響しません)。STRUCT 型を他の型に変換することはできません。

    • 文字列型は STRUCT 型に変換できます(解析によって行われ、解析に失敗すると NULL を返します)。
  • AGGREGATE テーブルモデルでは、STRUCT 型は REPLACE と REPLACE_IF_NOT_NULL のみをサポートします。どのテーブルモデルでも、KEY 列、パーティション列、バケット列として使用できません。

  • STRUCT 型の列は、IN や NOT IN を含む比較または算術演算をサポートしません。ORDER BY および GROUP BY 操作をサポートせず、JOIN KEY として使用できず、DELETE 文でも使用できません。

  • 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"
);

-- Add a subcolumn at the end
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 のようなネストしたアクセスにも対応しています。

    -- Table with a STRUCT column: s STRUCT<a: INT, b: DOUBLE>
    SELECT s.a, s.b FROM struct_table;

    -- Nested STRUCT column: s STRUCT<s: STRUCT<s: STRUCT<s: INT>>>
    SELECT s.s.s.s FROM nested_struct_table;

例​

  • ネストした複合型

    -- Create 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
    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))
    ));

    -- Query (use the dot operator for nested struct field access)
    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
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"
);

-- Modify the type of the 'name' subcolumn
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(20), age: INT>;

-- Check column types
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
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"
);

-- Add a subcolumn at the end
ALTER TABLE struct_table MODIFY COLUMN struct_varchar STRUCT<name: VARCHAR(10), age: INT, id: INT>;

-- Check column types
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 |
+----------------+-----------------------------------------+------+-------+---------+-------+