Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

딕셔너리 작업용 함수

View as MarkdownEdit this pageReport an issueSet up docs MCP

딕셔너리 연결 및 구성에 관한 정보는 딕셔너리를 참조하십시오.

예시 딕셔너리

이 섹션의 예시에서는 다음 딕셔너리를 사용합니다. 아래에 설명된 함수의 예시를 실행하려면 ClickHouse에서 이 딕셔너리를 생성하십시오.

dictGet\<T\> 및 dictGet\<T\>OrDefault 함수용 예시 딕셔너리
-- 필요한 모든 데이터 타입이 포함된 테이블 생성
CREATE TABLE all_types_test (
    `id` UInt32,
    
    -- String 타입
    `String_value` String,
    
    -- 부호 없는 정수 타입
    `UInt8_value` UInt8,
    `UInt16_value` UInt16,
    `UInt32_value` UInt32,
    `UInt64_value` UInt64,
    
    -- 부호 있는 정수 타입
    `Int8_value` Int8,
    `Int16_value` Int16,
    `Int32_value` Int32,
    `Int64_value` Int64,
    
    -- 부동 소수점 타입
    `Float32_value` Float32,
    `Float64_value` Float64,
    
    -- 날짜/시간 타입
    `Date_value` Date,
    `DateTime_value` DateTime,
    
    -- 네트워크 타입
    `IPv4_value` IPv4,
    `IPv6_value` IPv6,
    
    -- UUID 타입
    `UUID_value` UUID
) ENGINE = MergeTree() 
ORDER BY id;
-- 테스트 데이터 삽입
INSERT INTO all_types_test VALUES
(
    1,                              -- id
    'ClickHouse',                   -- String
    100,                            -- UInt8
    5000,                           -- UInt16
    1000000,                        -- UInt32
    9223372036854775807,            -- UInt64
    -100,                           -- Int8
    -5000,                          -- Int16
    -1000000,                       -- Int32
    -9223372036854775808,           -- Int64
    123.45,                         -- Float32
    987654.123456,                  -- Float64
    '2024-01-15',                   -- Date
    '2024-01-15 10:30:00',          -- DateTime
    '192.168.1.1',                  -- IPv4
    '2001:db8::1',                  -- IPv6
    '550e8400-e29b-41d4-a716-446655440000' -- UUID
)
-- 딕셔너리 생성
CREATE DICTIONARY all_types_dict
(
    id UInt32,
    String_value String,
    UInt8_value UInt8,
    UInt16_value UInt16,
    UInt32_value UInt32,
    UInt64_value UInt64,
    Int8_value Int8,
    Int16_value Int16,
    Int32_value Int32,
    Int64_value Int64,
    Float32_value Float32,
    Float64_value Float64,
    Date_value Date,
    DateTime_value DateTime,
    IPv4_value IPv4,
    IPv6_value IPv6,
    UUID_value UUID
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'all_types_test' DB 'default'))
LAYOUT(HASHED())
LIFETIME(MIN 300 MAX 600);
dictGetAll용 예시 딕셔너리

regexp 트리 딕셔너리에 사용할 데이터를 저장할 테이블을 생성합니다:

CREATE TABLE regexp_os(
    id UInt64,
    parent_id UInt64,
    regexp String,
    keys Array(String),
    values Array(String)
)
ENGINE = Memory;

테이블에 데이터를 삽입합니다:

INSERT INTO regexp_os 
SELECT *
FROM s3(
    'https://datasets-documentation.s3.eu-west-3.amazonaws.com/' ||
    'user_agent_regex/regexp_os.csv'
);

regexp 트리 딕셔너리를 생성합니다:

CREATE DICTIONARY regexp_tree
(
    regexp String,
    os_replacement String DEFAULT 'Other',
    os_v1_replacement String DEFAULT '0',
    os_v2_replacement String DEFAULT '0',
    os_v3_replacement String DEFAULT '0',
    os_v4_replacement String DEFAULT '0'
)
PRIMARY KEY regexp
SOURCE(CLICKHOUSE(TABLE 'regexp_os'))
LIFETIME(MIN 0 MAX 0)
LAYOUT(REGEXP_TREE);
예시: 범위 키 딕셔너리

입력 테이블을 생성합니다:

CREATE TABLE range_key_dictionary_source_table
(
    key UInt64,
    start_date Date,
    end_date Date,
    value String,
    value_nullable Nullable(String)
)
ENGINE = TinyLog();

입력 테이블에 데이터를 삽입합니다:

INSERT INTO range_key_dictionary_source_table VALUES(1, toDate('2019-05-20'), toDate('2019-05-20'), 'First', 'First');
INSERT INTO range_key_dictionary_source_table VALUES(2, toDate('2019-05-20'), toDate('2019-05-20'), 'Second', NULL);
INSERT INTO range_key_dictionary_source_table VALUES(3, toDate('2019-05-20'), toDate('2019-05-20'), 'Third', 'Third');

딕셔너리를 생성합니다:

CREATE DICTIONARY range_key_dictionary
(
    key UInt64,
    start_date Date,
    end_date Date,
    value String,
    value_nullable Nullable(String)
)
PRIMARY KEY key
SOURCE(CLICKHOUSE(HOST 'localhost' PORT tcpPort() TABLE 'range_key_dictionary_source_table'))
LIFETIME(MIN 1 MAX 1000)
LAYOUT(RANGE_HASHED())
RANGE(MIN start_date MAX end_date);
예시: 복합 키 딕셔너리

소스 테이블을 생성합니다:

CREATE TABLE dict_mult_source
(
id UInt32,
c1 UInt32,
c2 String
) ENGINE = Memory;

소스 테이블에 데이터를 삽입합니다:

INSERT INTO dict_mult_source VALUES
(1, 1, '1'),
(2, 2, '2'),
(3, 3, '3');

딕셔너리를 생성합니다:

CREATE DICTIONARY ext_dict_mult
(
    id UInt32,
    c1 UInt32,
    c2 String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'dict_mult_source' DB 'default'))
LAYOUT(FLAT())
LIFETIME(MIN 0 MAX 0);
예시: 계층형 딕셔너리

소스 테이블을 생성합니다:

CREATE TABLE hierarchy_source
(
  id UInt64,
  parent_id UInt64,
  name String
) ENGINE = Memory;

소스 테이블에 데이터를 삽입합니다:

INSERT INTO hierarchy_source VALUES
(0, 0, 'Root'),
(1, 0, 'Level 1 - Node 1'),
(2, 1, 'Level 2 - Node 2'),
(3, 1, 'Level 2 - Node 3'),
(4, 2, 'Level 3 - Node 4'),
(5, 2, 'Level 3 - Node 5'),
(6, 3, 'Level 3 - Node 6');

-- 0 (루트)
-- └── 1 (수준 1 - 노드 1)
--     ├── 2 (수준 2 - 노드 2)
--     │   ├── 4 (수준 3 - 노드 4)
--     │   └── 5 (수준 3 - 노드 5)
--     └── 3 (수준 2 - 노드 3)
--         └── 6 (수준 3 - 노드 6)

딕셔너리를 생성합니다:

CREATE DICTIONARY hierarchical_dictionary
(
    id UInt64,
    parent_id UInt64 HIERARCHICAL,
    name String
)
PRIMARY KEY id
SOURCE(CLICKHOUSE(HOST 'localhost' PORT 9000 USER 'default' TABLE 'hierarchy_source' DB 'default'))
LAYOUT(HASHED())
LIFETIME(MIN 300 MAX 600);

딕셔너리 함수에 키 전달하기

dictGet, dictGetOrDefault, dictGetOrNull, dictHas와 같은 함수의 키 인수(id_expr)는 딕셔너리 키 유형에 따라 달라집니다:

  • 단순 키(UInt64)를 사용하는 딕셔너리에서는 키 값을 직접 전달합니다:
SELECT dictGet('simple_key_dictionary', 'attr_name', toUInt64(1));
  • 둘 이상의 속성으로 이루어진 복합 키를 사용하는 딕셔너리에서는 키 값을 튜플로 전달합니다:
SELECT dictGet('complex_key_dictionary', 'attr_name', ('value_for_field1', 42));
  • 복합 키가 단일 속성으로 구성된 경우, 키 값을 tuple로 감싸지 않고 직접 전달할 수 있습니다. 다음 두 가지는 모두 유효하며 동일합니다:
SELECT dictGet('complex_key_dictionary', 'attr_name', 'key');
SELECT dictGet('complex_key_dictionary', 'attr_name', tuple('key'));

이는 키가 단일 속성인 ip_trie 딕셔너리에도 동일하게 적용됩니다. 조회할 IP 주소를 직접 전달할 수 있습니다:

SELECT dictGet('ip_trie_dictionary', 'attr_name', toIPv4('202.79.32.10'));

dictGet

v18.16.0에 도입됨

딕셔너리에서 값을 가져옵니다.

구문

dictGet('dict_name', attr_names, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_names — 딕셔너리 컬럼 이름 또는 컬럼 이름의 튜플입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 단순 키를 사용하는 딕셔너리의 경우 UInt64 값을 반환하는 표현식입니다. 복합 키를 사용하는 딕셔너리의 경우 키 값의 튜플을 반환하는 표현식입니다. 복합 키가 단일 속성으로만 구성된 경우 tuple로 감싸지 않고 해당 값을 직접 전달할 수 있습니다. UInt64 또는 Tuple(T)

반환 값

키를 찾으면 id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 키를 찾지 못하면 딕셔너리 구성에서 해당 속성에 대해 지정한 <null_value> 요소의 내용을 반환합니다.

예시

단일 속성 조회

CREATE TABLE ext_dict_test_source (id UInt32, c1 UInt32, c2 String) ENGINE = Memory;
INSERT INTO ext_dict_test_source VALUES (1, 1, '1'), (2, 2, '2'), (3, 3, '3');
CREATE DICTIONARY ext_dict_test (id UInt32, c1 UInt32, c2 String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'ext_dict_test_source' DB currentDatabase())) LAYOUT(FLAT()) LIFETIME(MIN 0 MAX 0);
SELECT dictGet('ext_dict_test', 'c1', toUInt64(1)) AS val
1

여러 속성

CREATE TABLE dict_mult_source (id UInt32, c1 UInt32, c2 String) ENGINE = Memory;
INSERT INTO dict_mult_source VALUES (1, 1, '1'), (2, 2, '2'), (3, 3, '3');
CREATE DICTIONARY ext_dict_mult (id UInt32, c1 UInt32, c2 String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'dict_mult_source' DB currentDatabase())) LAYOUT(FLAT()) LIFETIME(MIN 0 MAX 0);
SELECT
    dictGet('ext_dict_mult', ('c1','c2'), number + 1) AS val,
    toTypeName(val) AS type
FROM system.numbers
LIMIT 3;
┌─val─────┬─type───────────┐
│ (1,'1') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
│ (2,'2') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
│ (3,'3') │ Tuple(        ↴│
│         │↳    c1 UInt32,↴│
│         │↳    c2 String) │
└─────────┴────────────────┘

dictGetAll

v23.5.0에서 도입됨

정규 표현식 트리 딕셔너리에서 각 키와 일치한 모든 노드의 속성 값을 가져옵니다.

이 함수는 T 대신 Array(T) 유형의 값을 반환한다는 점만 제외하면 dictGet과 유사하게 동작합니다.

구문

dictGetAll(dict_name, attr_names, id_expr[, limit])

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_names — 딕셔너리 컬럼의 이름 또는 컬럼 이름 튜플입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라집니다). Expression 또는 Tuple(T)
  • limit — 선택 사항입니다. 반환되는 각 값 배열의 최대 길이입니다. 값을 잘라낼 때는 상위 노드보다 하위 노드가 우선하며, 그 외의 경우에는 regexp 트리 딕셔너리에 정의된 목록 순서를 따릅니다. 지정하지 않으면 배열 길이에 제한이 없습니다. UInt*

반환 값

attr_names에 지정된 각 속성에 대해 id_expr에 해당하는 딕셔너리 속성 값 배열을 반환합니다. 딕셔너리에 id_expr에 해당하는 키가 없으면 빈 배열을 반환합니다.

Array(T)

예시

사용 예시

CREATE TABLE regexp_os (id UInt64, parent_id UInt64, regexp String, keys Array(String), values Array(String)) ENGINE = Memory;
INSERT INTO regexp_os VALUES
    (1, 0, 'Linux',      ['os_replacement'], ['Linux']),
    (2, 1, 'Android',    ['os_replacement'], ['Android']),
    (3, 2, 'Android 1',  ['os_replacement'], ['Android']),
    (4, 3, 'Android 12', ['os_replacement'], ['Android']);
CREATE DICTIONARY regexp_tree (regexp String, os_replacement String DEFAULT 'Other') PRIMARY KEY regexp SOURCE(CLICKHOUSE(TABLE 'regexp_os' DB currentDatabase())) LIFETIME(MIN 0 MAX 0) LAYOUT(REGEXP_TREE);
SELECT
    'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36' AS user_agent,

    -- This will match ALL applicable patterns
    dictGetAll('regexp_tree', 'os_replacement', 'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36') AS all_matches,

    -- This returns only the first match
    dictGet('regexp_tree', 'os_replacement', 'Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36') AS first_match;
┌─user_agent─────────────────────────────────────────────────────┬─all_matches─────────────────────────────┬─first_match─┐
│ Mozilla/5.0 (Linux; Android 12; SM-G998B) Mobile Safari/537.36 │ ['Android','Android','Android','Linux'] │ Android     │
└────────────────────────────────────────────────────────────────┴─────────────────────────────────────────┴─────────────┘

dictGetChildren

도입됨: v21.4.0

직계 하위 항목을 인덱스 배열로 반환합니다. dictGetHierarchy의 역변환입니다.

구문

dictGetChildren(dict_name, key)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • key — 확인할 키입니다. const String

반환 값

해당 키의 직계 하위 항목을 반환합니다. Array(UInt64)

예시

딕셔너리의 직계 하위 항목 가져오기

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetChildren('hierarchical_dictionary', 2);
┌─dictGetChildren('hierarchical_dictionary', 2)─┐
│ [4,5]                                         │
└───────────────────────────────────────────────┘

dictGetDate

도입됨: v1.1.0

딕셔너리 구성과 무관하게 딕셔너리 속성 값을 Date 데이터 타입으로 변환합니다.

구문

dictGetDate(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 대해 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Date_value Date) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2020-01-01');
CREATE DICTIONARY all_types_dict (id UInt32, Date_value Date) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetDate('all_types_dict', 'Date_value', 1)
┌─dictGetDate('all_types_dict', 'Date_value', 1)─┐
│                                     2020-01-01 │
└────────────────────────────────────────────────┘

dictGetDateOrDefault

도입됨: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Date 데이터 타입으로 변환합니다. 키를 찾을 수 없는 경우에는 지정한 기본값을 반환합니다.

구문

dictGetDateOrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입의 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Date_value Date) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2024-01-15');
CREATE DICTIONARY all_types_dict (id UInt32, Date_value Date) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetDate('all_types_dict', 'Date_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetDateOrDefault('all_types_dict', 'Date_value', 999, toDate('1970-01-01'));
┌─dictGetDate('all_types_dict', 'Date_value', 1)─┐
│                                     2024-01-15 │
└────────────────────────────────────────────────┘
┌─dictGetDateOrDefault('all_types_dict', 'Date_value', 999, toDate('1970-01-01'))─┐
│                                                                      1970-01-01 │
└─────────────────────────────────────────────────────────────────────────────────┘

dictGetDateTime

도입됨: v1.1.0

딕셔너리 구성과 무관하게 딕셔너리 속성 값을 DateTime 데이터 타입으로 변환합니다.

구문

dictGetDateTime(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 이는 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당 값이 없으면 딕셔너리 구성에서 그 속성에 대해 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, DateTime_value DateTime) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2024-01-15 10:30:00');
CREATE DICTIONARY all_types_dict (id UInt32, DateTime_value DateTime) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetDateTime('all_types_dict', 'DateTime_value', 1)
┌─dictGetDateTime('all_types_dict', 'DateTime_value', 1)─┐
│                                    2024-01-15 10:30:00 │
└────────────────────────────────────────────────────────┘

dictGetDateTimeOrDefault

도입됨: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 DateTime 데이터 타입으로 변환하거나, 키를 찾지 못한 경우 지정된 기본값을 반환합니다.

구문

dictGetDateTimeOrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입의 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 해당 값이 없으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, DateTime_value DateTime) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2024-01-15 10:30:00');
CREATE DICTIONARY all_types_dict (id UInt32, DateTime_value DateTime) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetDateTime('all_types_dict', 'DateTime_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetDateTimeOrDefault('all_types_dict', 'DateTime_value', 999, toDateTime('1970-01-01 00:00:00'));
┌─dictGetDateTime('all_types_dict', 'DateTime_value', 1)─┐
│                                    2024-01-15 10:30:00 │
└────────────────────────────────────────────────────────┘
┌─dictGetDateTimeOrDefault('all_types_dict', 'DateTime_value', 999, toDateTime('1970-01-01 00:00:00'))─┐
│                                                                                  1970-01-01 00:00:00 │
└──────────────────────────────────────────────────────────────────────────────────────────────────────┘

dictGetDescendants

도입됨: v21.4.0

dictGetChildren 함수를 재귀적으로 level번 적용한 경우와 같이, 모든 하위 항목을 반환합니다.

구문

dictGetDescendants(dict_name, key, level)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • key — 확인할 키입니다. const String
  • level — 계층 수준입니다. level = 0이면 최하위까지 모든 하위 항목을 반환합니다. UInt8

반환 값

해당 키의 하위 항목을 반환합니다. Array(UInt64)

예시

딕셔너리의 직계 하위 항목 가져오기

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- consider the following hierarchical dictionary:
-- 0 (Root)
-- └── 1 (Level 1 - Node 1)
--     ├── 2 (Level 2 - Node 2)
--     │   ├── 4 (Level 3 - Node 4)
--     │   └── 5 (Level 3 - Node 5)
--     └── 3 (Level 2 - Node 3)
--         └── 6 (Level 3 - Node 6)

SELECT dictGetDescendants('hierarchical_dictionary', 0, 2)
┌─dictGetDescendants('hierarchical_dictionary', 0, 2)─┐
│ [3,2]                                               │
└─────────────────────────────────────────────────────┘

dictGetFloat32

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Float32 데이터 타입으로 변환합니다.

구문

dictGetFloat32(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며(딕셔너리 구성에 따라 다름), Expression 또는 Tuple(T)입니다.

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Float32_value Float32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -123.123);
CREATE DICTIONARY all_types_dict (id UInt32, Float32_value Float32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetFloat32('all_types_dict', 'Float32_value', 1)
┌─dictGetFloat32('all_types_dict', 'Float32_value', 1)─┐
│                                             -123.123 │
└──────────────────────────────────────────────────────┘

dictGetFloat32OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Float32 데이터 타입으로 변환하며, 키를 찾지 못한 경우에는 지정된 기본값을 반환합니다.

구문

dictGetFloat32OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 때 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Float32_value Float32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 123.45);
CREATE DICTIONARY all_types_dict (id UInt32, Float32_value Float32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetFloat32('all_types_dict', 'Float32_value', 1);

-- for key which does not exist, returns the provided default value (-1.0)
SELECT dictGetFloat32OrDefault('all_types_dict', 'Float32_value', 999, -1.0);
┌─dictGetFloat32('all_types_dict', 'Float32_value', 1)─┐
│                                               123.45 │
└──────────────────────────────────────────────────────┘
┌─dictGetFloat32OrDefault('all_types_dict', 'Float32_value', 999, -1.)─┐
│                                                                   -1 │
└──────────────────────────────────────────────────────────────────────┘

dictGetFloat64

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Float64 데이터 타입으로 변환합니다.

구문

dictGetFloat64(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 대해 지정된 <null_value> 요소의 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Float64_value Float64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -123.123);
CREATE DICTIONARY all_types_dict (id UInt32, Float64_value Float64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetFloat64('all_types_dict', 'Float64_value', 1)
┌─dictGetFloat64('all_types_dict', 'Float64_value', 1)─┐
│                                             -123.123 │
└──────────────────────────────────────────────────────┘

dictGetFloat64OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Float64 데이터 타입으로 변환하며, 키를 찾을 수 없으면 지정된 기본값을 반환합니다.

구문

dictGetFloat64OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라집니다). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Float64_value Float64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 987654.123456);
CREATE DICTIONARY all_types_dict (id UInt32, Float64_value Float64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetFloat64('all_types_dict', 'Float64_value', 1);

-- for key which does not exist, returns the provided default value (nan)
SELECT dictGetFloat64OrDefault('all_types_dict', 'Float64_value', 999, nan);
┌─dictGetFloat64('all_types_dict', 'Float64_value', 1)─┐
│                                        987654.123456 │
└──────────────────────────────────────────────────────┘
┌─dictGetFloat64OrDefault('all_types_dict', 'Float64_value', 999, nan)─┐
│                                                                  nan │
└──────────────────────────────────────────────────────────────────────┘

dictGetHierarchy

도입 버전: v1.1.0

계층형 딕셔너리(hierarchical dictionary)에서 지정한 키의 모든 부모를 포함하는 배열을 생성합니다.

구문

dictGetHierarchy(dict_name, key)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • key — 키 값입니다. const String

반환 값

해당 키의 상위 항목을 반환합니다. Array(UInt64)

예시

키의 계층 구조 가져오기

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetHierarchy('hierarchical_dictionary', 5)
┌─dictGetHierarchy('hierarchical_dictionary', 5)─┐
│ [5,2,1]                                        │
└────────────────────────────────────────────────┘

dictGetIPv4

도입 버전: v1.1.0

딕셔너리 구성과 무관하게 딕셔너리 속성 값을 IPv4 데이터 타입으로 변환합니다.

구문

dictGetIPv4(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 대해 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, IPv4_value IPv4) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '192.168.0.1');
CREATE DICTIONARY all_types_dict (id UInt32, IPv4_value IPv4) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetIPv4('all_types_dict', 'IPv4_value', 1)
┌─dictGetIPv4('all_types_dict', 'IPv4_value', 1)─┐
│ 192.168.0.1                                    │
└────────────────────────────────────────────────┘

dictGetIPv4OrDefault

도입 버전: v23.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 IPv4 데이터 타입으로 변환하며, 키를 찾을 수 없으면 지정된 기본값을 반환합니다.

구문

dictGetIPv4OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라집니다). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, IPv4_value IPv4) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '192.168.0.1');
CREATE DICTIONARY all_types_dict (id UInt32, IPv4_value IPv4) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetIPv4('all_types_dict', 'IPv4_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetIPv4OrDefault('all_types_dict', 'IPv4_value', 999, toIPv4('0.0.0.0'));
┌─dictGetIPv4('all_types_dict', 'IPv4_value', 1)─┐
│ 192.168.0.1                                    │
└────────────────────────────────────────────────┘
┌─dictGetIPv4OrDefault('all_types_dict', 'IPv4_value', 999, toIPv4('0.0.0.0'))─┐
│ 0.0.0.0                                                                      │
└──────────────────────────────────────────────────────────────────────────────┘

dictGetIPv6

도입 버전: v23.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 IPv6 데이터 타입으로 변환합니다.

구문

dictGetIPv6(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 그렇지 않으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, IPv6_value IPv6) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2001:db8:85a3::8a2e:370:7334');
CREATE DICTIONARY all_types_dict (id UInt32, IPv6_value IPv6) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetIPv6('all_types_dict', 'IPv6_value', 1)
┌─dictGetIPv6('all_types_dict', 'IPv6_value', 1)─┐
│ 2001:db8:85a3::8a2e:370:7334                   │
└────────────────────────────────────────────────┘

dictGetIPv6OrDefault

도입 버전: v23.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 IPv6 데이터 타입으로 변환하며, 키를 찾지 못하면 제공된 기본값을 반환합니다.

구문

dictGetIPv6OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 해당 값이 없으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, IPv6_value IPv6) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '2001:db8:85a3::8a2e:370:7334');
CREATE DICTIONARY all_types_dict (id UInt32, IPv6_value IPv6) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetIPv6('all_types_dict', 'IPv6_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetIPv6OrDefault('all_types_dict', 'IPv6_value', 999, '::1'::IPv6);
┌─dictGetIPv6('all_types_dict', 'IPv6_value', 1)─┐
│ 2001:db8:85a3::8a2e:370:7334                   │
└────────────────────────────────────────────────┘
┌─dictGetIPv6OrDefault('all_types_dict', 'IPv6_value', 999, CAST('::1', 'IPv6'))─┐
│ ::1                                                                            │
└────────────────────────────────────────────────────────────────────────────────┘

dictGetInt16

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int16 데이터 타입으로 변환합니다.

구문

dictGetInt16(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 그렇지 않으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int16_value Int16) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -5000);
CREATE DICTIONARY all_types_dict (id UInt32, Int16_value Int16) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetInt16('all_types_dict', 'Int16_value', 1)
┌─dictGetInt16('all_types_dict', 'Int16_value', 1)─┐
│                                            -5000 │
└──────────────────────────────────────────────────┘

dictGetInt16OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int16 데이터 타입으로 변환하며, 키를 찾지 못한 경우에는 지정된 기본값을 반환합니다.

구문

dictGetInt16OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라집니다). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int16_value Int16) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -5000);
CREATE DICTIONARY all_types_dict (id UInt32, Int16_value Int16) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetInt16('all_types_dict', 'Int16_value', 1);

-- for key which does not exist, returns the provided default value (-1)
SELECT dictGetInt16OrDefault('all_types_dict', 'Int16_value', 999, -1);
┌─dictGetInt16('all_types_dict', 'Int16_value', 1)─┐
│                                            -5000 │
└──────────────────────────────────────────────────┘
┌─dictGetInt16OrDefault('all_types_dict', 'Int16_value', 999, -1)─┐
│                                                              -1 │
└─────────────────────────────────────────────────────────────────┘

dictGetInt32

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int32 데이터 타입으로 변환합니다.

구문

dictGetInt32(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당 값이 없으면 딕셔너리 구성에서 그 속성에 대해 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int32_value Int32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -1000000);
CREATE DICTIONARY all_types_dict (id UInt32, Int32_value Int32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetInt32('all_types_dict', 'Int32_value', 1)
┌─dictGetInt32('all_types_dict', 'Int32_value', 1)─┐
│                                         -1000000 │
└──────────────────────────────────────────────────┘

dictGetInt32OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int32 데이터 타입으로 변환하며, 키를 찾지 못하면 지정된 기본값을 반환합니다.

구문

dictGetInt32OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 때 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int32_value Int32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -1000000);
CREATE DICTIONARY all_types_dict (id UInt32, Int32_value Int32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetInt32('all_types_dict', 'Int32_value', 1);

-- for key which does not exist, returns the provided default value (-1)
SELECT dictGetInt32OrDefault('all_types_dict', 'Int32_value', 999, -1);
┌─dictGetInt32('all_types_dict', 'Int32_value', 1)─┐
│                                         -1000000 │
└──────────────────────────────────────────────────┘
┌─dictGetInt32OrDefault('all_types_dict', 'Int32_value', 999, -1)─┐
│                                                              -1 │
└─────────────────────────────────────────────────────────────────┘

dictGetInt64

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int64 데이터 타입으로 변환합니다.

구문

dictGetInt64(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당 값이 없으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int64_value Int64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -9223372036854775807);
CREATE DICTIONARY all_types_dict (id UInt32, Int64_value Int64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetInt64('all_types_dict', 'Int64_value', 1)
┌─dictGetInt64('all_types_dict', 'Int64_value', 1)─┐
│                             -9223372036854775807 │
└──────────────────────────────────────────────────┘

dictGetInt64OrDefault

도입된 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int64 데이터 타입으로 변환하며, 키를 찾지 못하면 제공된 기본값을 반환합니다.

구문

dictGetInt64OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리의 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int64_value Int64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -9223372036854775808);
CREATE DICTIONARY all_types_dict (id UInt32, Int64_value Int64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetInt64('all_types_dict', 'Int64_value', 1);

-- for key which does not exist, returns the provided default value (-1)
SELECT dictGetInt64OrDefault('all_types_dict', 'Int64_value', 999, -1);
┌─dictGetInt64('all_types_dict', 'Int64_value', 1)─┐
│                             -9223372036854775808 │
└──────────────────────────────────────────────────┘
┌─dictGetInt64OrDefault('all_types_dict', 'Int64_value', 999, -1)─┐
│                                                              -1 │
└─────────────────────────────────────────────────────────────────┘

dictGetInt8

도입된 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int8 데이터 타입으로 변환합니다.

구문

dictGetInt8(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int8_value Int8) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -100);
CREATE DICTIONARY all_types_dict (id UInt32, Int8_value Int8) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetInt8('all_types_dict', 'Int8_value', 1)
┌─dictGetInt8('all_types_dict', 'Int8_value', 1)─┐
│                                           -100 │
└────────────────────────────────────────────────┘

dictGetInt8OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 Int8 데이터 타입으로 변환하며, 키를 찾지 못한 경우에는 지정한 기본값을 반환합니다.

구문

dictGetInt8OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 때 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, Int8_value Int8) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, -100);
CREATE DICTIONARY all_types_dict (id UInt32, Int8_value Int8) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetInt8('all_types_dict', 'Int8_value', 1);

-- for key which does not exist, returns the provided default value (-1)
SELECT dictGetInt8OrDefault('all_types_dict', 'Int8_value', 999, -1);
┌─dictGetInt8('all_types_dict', 'Int8_value', 1)─┐
│                                           -100 │
└────────────────────────────────────────────────┘
┌─dictGetInt8OrDefault('all_types_dict', 'Int8_value', 999, -1)─┐
│                                                            -1 │
└───────────────────────────────────────────────────────────────┘

dictGetKeys

도입 버전: v25.12.0

속성 값이 지정된 값과 일치하는 딕셔너리 키를 반환합니다. 이는 단일 속성에 대한 dictGet 함수의 역연산입니다.

dictGetKeys에서 사용하는 쿼리별 역방향 조회 캐시의 크기를 제한하려면 max_reverse_dictionary_lookup_cache_size_bytes 설정을 사용합니다. 이 캐시는 동일한 쿼리 내에서 딕셔너리를 다시 스캔하지 않도록 각 속성 값에 대한 직렬화된 키 튜플을 저장합니다. 이 캐시는 쿼리 간에 유지되지 않습니다. 한도에 도달하면 항목이 LRU 방식으로 제거됩니다. 입력의 카디널리티가 낮고 작업 집합이 캐시에 들어갈 수 있는 대규모 딕셔너리에서 가장 효과적입니다. 캐싱을 비활성화하려면 0으로 설정합니다.

구문

dictGetKeys('dict_name', 'attr_name', value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 일치 여부를 확인할 속성입니다. String
  • value_expr — 속성과 비교할 값입니다. Expression

반환 값

단일 키 딕셔너리의 경우 속성이 value_expr와 같은 키의 배열입니다. 다중 키 딕셔너리의 경우 속성이 value_expr와 같은 키 튜플의 배열입니다. 딕셔너리에 value_expr에 해당하는 속성이 없으면 빈 배열이 반환됩니다. ClickHouse는 속성 값을 파싱할 수 없거나 해당 값을 속성 데이터 타입으로 변환할 수 없으면 예외를 발생시킵니다.

예시

사용 예시

CREATE TABLE task_priority_source (task_id UInt64, priority_level String) ENGINE = Memory;
INSERT INTO task_priority_source VALUES (1, 'low'), (2, 'high'), (3, 'medium'), (4, 'high');
CREATE DICTIONARY task_id_to_priority_dictionary (task_id UInt64, priority_level String) PRIMARY KEY task_id SOURCE(CLICKHOUSE(TABLE 'task_priority_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 0 MAX 0);
SELECT arraySort(dictGetKeys('task_id_to_priority_dictionary', 'priority_level', 'high')) AS ids;
┌─ids───┐
│ [2,4] │
└───────┘

dictGetOrDefault

도입 버전: v18.16.0

딕셔너리에서 값을 조회하며, 키를 찾지 못하면 기본값을 반환합니다.

구문

dictGetOrDefault('dict_name', attr_names, id_expr, default_value)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_names — 딕셔너리의 컬럼 이름 또는 컬럼 이름의 튜플입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 단순 키를 사용하는 딕셔너리에서는 UInt64 값을 반환하는 표현식입니다. 복합 키를 사용하는 딕셔너리에서는 키 값의 튜플을 반환하는 표현식입니다. 복합 키가 단일 속성으로만 구성된 경우 tuple로 감싸지 않고 해당 값을 직접 전달할 수 있습니다. UInt64 또는 Tuple(T)
  • default_value — 키를 찾지 못했을 때 반환할 기본값입니다. 타입은 속성의 데이터 타입과 일치해야 합니다.

반환 값

키를 찾으면 id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 키를 찾지 못하면 제공된 default_value를 반환합니다.

예시

기본값을 사용해 값 가져오기

CREATE TABLE dict_mult_source (id UInt32, c1 UInt32, c2 String) ENGINE = Memory;
INSERT INTO dict_mult_source VALUES (1, 1, '1'), (2, 2, '2'), (3, 3, '3');
CREATE DICTIONARY ext_dict_mult (id UInt32, c1 UInt32, c2 String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'dict_mult_source' DB currentDatabase())) LAYOUT(FLAT()) LIFETIME(MIN 0 MAX 0);
SELECT dictGetOrDefault('ext_dict_mult', 'c1', toUInt64(999), 0) AS val
0

dictGetOrNull

도입 버전: v21.4.0

딕셔너리에서 값을 조회하며, 키를 찾지 못하면 NULL을 반환합니다.

구문

dictGetOrNull('dict_name', 'attr_name', id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. 문자열 리터럴입니다. - attr_name — 조회할 컬럼 이름입니다. 문자열 리터럴입니다. - id_expr — 키 값입니다. 딕셔너리 키 타입 값을 반환하는 표현식입니다.

반환 값

키를 찾으면 id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 키를 찾지 못하면 NULL을 반환합니다.

예시

범위 키 딕셔너리를 사용하는 예시

CREATE TABLE range_key_dictionary_source_table (key UInt64, start_date Date, end_date Date, value String, value_nullable Nullable(String)) ENGINE = TinyLog();
INSERT INTO range_key_dictionary_source_table VALUES(1, toDate('2019-05-20'), toDate('2019-05-20'), 'First', 'First');
INSERT INTO range_key_dictionary_source_table VALUES(2, toDate('2019-05-20'), toDate('2019-05-20'), 'Second', NULL);
INSERT INTO range_key_dictionary_source_table VALUES(3, toDate('2019-05-20'), toDate('2019-05-20'), 'Third', 'Third');
CREATE DICTIONARY range_key_dictionary (key UInt64, start_date Date, end_date Date, value String, value_nullable Nullable(String)) PRIMARY KEY key SOURCE(CLICKHOUSE(TABLE 'range_key_dictionary_source_table' DB currentDatabase())) LIFETIME(MIN 1 MAX 1000) LAYOUT(RANGE_HASHED()) RANGE(MIN start_date MAX end_date);
SELECT
    (number, toDate('2019-05-20')),
    dictGetOrNull('range_key_dictionary', 'value', number, toDate('2019-05-20')),
FROM system.numbers LIMIT 5 FORMAT TabSeparated;
(0,'2019-05-20')	\N
(1,'2019-05-20')	First
(2,'2019-05-20')	Second
(3,'2019-05-20')	Third
(4,'2019-05-20')	\N

dictGetRoot

도입 버전: v26.7.0

계층형 딕셔너리에서 키의 최상위 조상(루트)을 반환합니다.

이는 dictGetHierarchy가 반환하는 배열의 마지막 요소를 가져오는 간편한 표현입니다. 즉, dictGetHierarchy(dict_name, key)[-1]입니다.

키 자체가 계층 구조의 최상위 노드이면 해당 키를 반환합니다. 키가 딕셔너리에 없으면 0을 반환합니다.

구문

dictGetRoot(dict_name, key)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • key — 키 값입니다. UInt64

반환 값

키의 최상위 조상(루트)을 반환합니다. UInt64

예시

키의 루트 가져오기

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetRoot('hierarchical_dictionary', 5)
┌─dictGetRoot('hierarchical_dictionary', 5)─┐
│                                         1 │
└───────────────────────────────────────────┘

dictGetString

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 String 데이터 타입으로 변환합니다.

구문

dictGetString(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당 값이 없으면 딕셔너리 구성에서 그 속성에 대해 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, String_value String) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 'test string');
CREATE DICTIONARY all_types_dict (id UInt32, String_value String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetString('all_types_dict', 'String_value', 1)
┌─dictGetString('all_types_dict', 'String_value', 1)─┐
│ test string                                        │
└────────────────────────────────────────────────────┘

dictGetStringOrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 String 데이터 타입으로 변환합니다. 키를 찾을 수 없으면 지정된 기본값을 반환합니다.

구문

dictGetStringOrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 때 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, String_value String) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 'test string');
CREATE DICTIONARY all_types_dict (id UInt32, String_value String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetString('all_types_dict', 'String_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetStringOrDefault('all_types_dict', 'String_value', 999, 'default');
┌─dictGetString('all_types_dict', 'String_value', 1)─┐
│ test string                                        │
└────────────────────────────────────────────────────┘
┌─dictGetStringOrDefault('all_types_dict', 'String_value', 999, 'default')─┐
│ default                                                                  │
└──────────────────────────────────────────────────────────────────────────┘

dictGetUInt16

v1.1.0에 도입됨

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt16 데이터 타입으로 변환합니다.

구문

dictGetUInt16(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입의 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당하는 값이 없으면 딕셔너리 구성에서 해당 속성에 대해 지정한 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt16_value UInt16) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 5000);
CREATE DICTIONARY all_types_dict (id UInt32, UInt16_value UInt16) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetUInt16('all_types_dict', 'UInt16_value', 1)
┌─dictGetUInt16('all_types_dict', 'UInt16_value', 1)─┐
│                                               5000 │
└────────────────────────────────────────────────────┘

dictGetUInt16OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt16 데이터 타입으로 변환하며, 키를 찾을 수 없으면 지정한 기본값을 반환합니다.

구문

dictGetUInt16OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당 값이 없으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt16_value UInt16) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 5000);
CREATE DICTIONARY all_types_dict (id UInt32, UInt16_value UInt16) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetUInt16('all_types_dict', 'UInt16_value', 1);

-- for key which does not exist, returns the provided default value (0)
SELECT dictGetUInt16OrDefault('all_types_dict', 'UInt16_value', 999, 0);
┌─dictGetUInt16('all_types_dict', 'UInt16_value', 1)─┐
│                                               5000 │
└────────────────────────────────────────────────────┘
┌─dictGetUInt16OrDefault('all_types_dict', 'UInt16_value', 999, 0)─┐
│                                                                0 │
└──────────────────────────────────────────────────────────────────┘

dictGetUInt32

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt32 데이터 타입으로 변환합니다.

구문

dictGetUInt32(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당하는 값이 없으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt32_value UInt32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 1000000);
CREATE DICTIONARY all_types_dict (id UInt32, UInt32_value UInt32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetUInt32('all_types_dict', 'UInt32_value', 1)
┌─dictGetUInt32('all_types_dict', 'UInt32_value', 1)─┐
│                                            1000000 │
└────────────────────────────────────────────────────┘

dictGetUInt32OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt32 데이터 타입으로 변환하며, 키를 찾지 못한 경우에는 지정한 기본값을 반환합니다.

구문

dictGetUInt32OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리의 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하며, 해당 값이 없으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt32_value UInt32) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 1000000);
CREATE DICTIONARY all_types_dict (id UInt32, UInt32_value UInt32) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetUInt32('all_types_dict', 'UInt32_value', 1);

-- for key which does not exist, returns the provided default value (0)
SELECT dictGetUInt32OrDefault('all_types_dict', 'UInt32_value', 999, 0);
┌─dictGetUInt32('all_types_dict', 'UInt32_value', 1)─┐
│                                            1000000 │
└────────────────────────────────────────────────────┘
┌─dictGetUInt32OrDefault('all_types_dict', 'UInt32_value', 999, 0)─┐
│                                                                0 │
└──────────────────────────────────────────────────────────────────┘

dictGetUInt64

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt64 데이터 타입으로 변환합니다.

구문

dictGetUInt64(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라집니다). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성의 값을 반환합니다. 그렇지 않으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt64_value UInt64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 9223372036854775807);
CREATE DICTIONARY all_types_dict (id UInt32, UInt64_value UInt64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetUInt64('all_types_dict', 'UInt64_value', 1)
┌─dictGetUInt64('all_types_dict', 'UInt64_value', 1)─┐
│                                9223372036854775807 │
└────────────────────────────────────────────────────┘

dictGetUInt64OrDefault

도입 버전: v1.1.0

딕셔너리 구성에 관계없이 딕셔너리 속성 값을 UInt64 데이터 타입으로 변환하며, 키를 찾지 못한 경우 제공된 기본값을 반환합니다.

구문

dictGetUInt64OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt64_value UInt64) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 9223372036854775807);
CREATE DICTIONARY all_types_dict (id UInt32, UInt64_value UInt64) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetUInt64('all_types_dict', 'UInt64_value', 1);

-- for key which does not exist, returns the provideddefault value (0)
SELECT dictGetUInt64OrDefault('all_types_dict', 'UInt64_value', 999, 0);
┌─dictGetUInt64('all_types_dict', 'UInt64_value', 1)─┐
│                                9223372036854775807 │
└────────────────────────────────────────────────────┘
┌─dictGetUInt64OrDefault('all_types_dict', 'UInt64_value', 999, 0)─┐
│                                                                0 │
└──────────────────────────────────────────────────────────────────┘

dictGetUInt8

도입 버전: v1.1.0

딕셔너리 구성과 상관없이 딕셔너리 속성 값을 UInt8 데이터 타입으로 변환합니다.

구문

dictGetUInt8(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리의 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식이며, 딕셔너리 구성에 따라 달라집니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당하는 값이 없으면 딕셔너리 구성에서 해당 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt8_value UInt8) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 100);
CREATE DICTIONARY all_types_dict (id UInt32, UInt8_value UInt8) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetUInt8('all_types_dict', 'UInt8_value', 1)
┌─dictGetUInt8('all_types_dict', 'UInt8_value', 1)─┐
│                                              100 │
└──────────────────────────────────────────────────┘

dictGetUInt8OrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UInt8 데이터 타입으로 변환하며, 키를 찾지 못하면 지정된 기본값을 반환합니다.

구문

dictGetUInt8OrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 다름). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UInt8_value UInt8) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, 100);
CREATE DICTIONARY all_types_dict (id UInt32, UInt8_value UInt8) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetUInt8('all_types_dict', 'UInt8_value', 1);

-- for key which does not exist, returns the provided default value (0)
SELECT dictGetUInt8OrDefault('all_types_dict', 'UInt8_value', 999, 0);
┌─dictGetUInt8('all_types_dict', 'UInt8_value', 1)─┐
│                                              100 │
└──────────────────────────────────────────────────┘
┌─dictGetUInt8OrDefault('all_types_dict', 'UInt8_value', 999, 0)─┐
│                                                              0 │
└────────────────────────────────────────────────────────────────┘

dictGetUUID

도입 버전: v1.1.0

딕셔너리 속성 값을 딕셔너리 구성과 관계없이 UUID 데이터 타입으로 변환합니다.

구문

dictGetUUID(dict_name, attr_name, id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼의 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환합니다. 해당하는 값이 없으면 딕셔너리 구성에서 그 속성에 지정된 <null_value> 요소의 내용을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UUID_value UUID) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '123e4567-e89b-12d3-a456-426614174000');
CREATE DICTIONARY all_types_dict (id UInt32, UUID_value UUID) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
SELECT dictGetUUID('all_types_dict', 'UUID_value', 1)
┌─dictGetUUID('all_types_dict', 'UUID_value', 1)─┐
│ 123e4567-e89b-12d3-a456-426614174000           │
└────────────────────────────────────────────────┘

dictGetUUIDOrDefault

도입 버전: v1.1.0

딕셔너리 구성과 관계없이 딕셔너리 속성 값을 UUID 데이터 타입으로 변환하며, 키를 찾을 수 없으면 지정된 기본값을 반환합니다.

구문

dictGetUUIDOrDefault(dict_name, attr_name, id_expr, default_value_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • attr_name — 딕셔너리 컬럼 이름입니다. String 또는 Tuple(String)
  • id_expr — 키 값입니다. 딕셔너리 키 타입 값 또는 튜플 값을 반환하는 표현식입니다(딕셔너리 구성에 따라 달라짐). Expression 또는 Tuple(T)
  • default_value_expr — 딕셔너리에 id_expr 키를 가진 행이 없을 경우 반환되는 값입니다. Expression 또는 Tuple(T)

반환 값

id_expr에 해당하는 딕셔너리 속성 값을 반환하고, 그렇지 않으면 default_value_expr 매개변수로 전달된 값을 반환합니다.

예시

사용 예시

CREATE TABLE all_types_test (id UInt32, UUID_value UUID) ENGINE = MergeTree() ORDER BY id;
INSERT INTO all_types_test VALUES (1, '550e8400-e29b-41d4-a716-446655440000');
CREATE DICTIONARY all_types_dict (id UInt32, UUID_value UUID) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'all_types_test' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- for key which exists
SELECT dictGetUUID('all_types_dict', 'UUID_value', 1);

-- for key which does not exist, returns the provided default value
SELECT dictGetUUIDOrDefault('all_types_dict', 'UUID_value', 999, '00000000-0000-0000-0000-000000000000'::UUID);
┌─dictGetUUID('all_types_dict', 'UUID_value', 1)─┐
│ 550e8400-e29b-41d4-a716-446655440000           │
└────────────────────────────────────────────────┘
┌─dictGetUUIDOrDefault('all_types_dict', 'UUID_value', 999, CAST('00000000-0000-0000-0000-000000000000', 'UUID'))─┐
│ 00000000-0000-0000-0000-000000000000                                                                            │
└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

dictHas

도입 버전: v1.1.0

딕셔너리에 키가 있는지 확인합니다.

구문

dictHas('dict_name', id_expr)

인수

반환 값

키가 존재하면 1을 반환하고, 그렇지 않으면 0을 반환합니다. UInt8

예시

딕셔너리에 키가 존재하는지 확인

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- consider the following hierarchical dictionary:
-- 0 (Root)
-- └── 1 (Level 1 - Node 1)
--     ├── 2 (Level 2 - Node 2)
--     │   ├── 4 (Level 3 - Node 4)
--     │   └── 5 (Level 3 - Node 5)
--     └── 3 (Level 2 - Node 3)
--         └── 6 (Level 3 - Node 6)

SELECT dictHas('hierarchical_dictionary', 2);
SELECT dictHas('hierarchical_dictionary', 7);
┌─dictHas('hierarchical_dictionary', 2)─┐
│                                     1 │
└───────────────────────────────────────┘
┌─dictHas('hierarchical_dictionary', 7)─┐
│                                     0 │
└───────────────────────────────────────┘

dictIsIn

도입 버전: v1.1.0

딕셔너리에서 계층 체인 전체를 따라 키의 상위 항목을 확인합니다.

구문

dictIsIn(dict_name, child_id_expr, ancestor_id_expr)

인수

  • dict_name — 딕셔너리 이름입니다. String
  • child_id_expr — 확인할 키입니다. String
  • ancestor_id_expr — child_id_expr 키의 상위 조상으로 간주되는 키입니다. const String

반환 값

child_id_expr가 ancestor_id_expr의 자식이 아니면 0을 반환하고, child_id_expr가 ancestor_id_expr의 자식이거나 child_id_expr가 ancestor_id_expr와 같으면 1을 반환합니다. UInt8

예시

계층 관계 확인

CREATE TABLE hierarchy_source (id UInt64, parent_id UInt64, name String) ENGINE = Memory;
INSERT INTO hierarchy_source VALUES (0, 0, 'Root'), (1, 0, 'Level 1 - Node 1'), (2, 1, 'Level 2 - Node 2'), (3, 1, 'Level 2 - Node 3'), (4, 2, 'Level 3 - Node 4'), (5, 2, 'Level 3 - Node 5'), (6, 3, 'Level 3 - Node 6');
CREATE DICTIONARY hierarchical_dictionary (id UInt64, parent_id UInt64 HIERARCHICAL, name String) PRIMARY KEY id SOURCE(CLICKHOUSE(TABLE 'hierarchy_source' DB currentDatabase())) LAYOUT(HASHED()) LIFETIME(MIN 300 MAX 600);
-- valid hierarchy
SELECT dictIsIn('hierarchical_dictionary', 6, 3);

-- invalid hierarchy
SELECT dictIsIn('hierarchical_dictionary', 3, 5);
┌─dictIsIn('hierarchical_dictionary', 6, 3)─┐
│                                         1 │
└───────────────────────────────────────────┘
┌─dictIsIn('hierarchical_dictionary', 3, 5)─┐
│                                         0 │
└───────────────────────────────────────────┘
Navigation