📣
TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →
​
Sign InStart for Free
AI
Developer
Best Practices
API
​
Sign InStart for Free

CREATE DICTIONARY

Creates a dictionary.

Syntax

CREATE [ OR REPLACE ] DICTIONARY [ IF NOT EXISTS ] [ <catalog_name>. ][ <database_name>. ]<dictionary_name>
(
    <column_name> <data_type> [ , <column_name> <data_type> , ... ]
)
PRIMARY KEY <column_name> [ , <column_name> , ... ]
SOURCE(
    <source_name>(
        <source_option> = '<value>' [ <source_option> = '<value>' ... ]
    )
)
[ COMMENT '<comment>' ]

Parameters

ParameterDescription
OR REPLACEReplaces an existing dictionary with the same name.
IF NOT EXISTSSucceeds without changes if the dictionary already exists.
<dictionary_name>The dictionary name. You can qualify it with catalog and database names.
(<column_name> <data_type>, ...)Declares the dictionary schema.
PRIMARY KEYDefines one or more key columns used for dictionary lookups.
SOURCE(...)Defines the source connector name and its key-value options.
COMMENTOptional dictionary comment.

Examples

MySQL example:

CREATE DICTIONARY user_info
(
    user_id UInt64,
    user_name String,
    user_email String
)
PRIMARY KEY user_id
SOURCE(
    mysql(
        host = '127.0.0.1'
        port = '3306'
        username = 'root'
        password = 'root'
        db = 'app'
        table = 'users'
    )
)
COMMENT 'User dictionary from MySQL';

Redis example:

CREATE DICTIONARY cache
(
    key String,
    value String
)
PRIMARY KEY key
SOURCE(
    redis(
        host = '127.0.0.1'
        port = '6379'
    )
)
COMMENT 'cache dictionary from Redis';

Was this page helpful?