Local File dictionary source

Configure a local file as a dictionary source in ClickHouse.

The local file source loads dictionary data from a file on the local filesystem. This is useful for small, static lookup tables that can be stored as flat files in formats such as TSV, CSV, or any other supported format.

Example of settings:

DDL

SOURCE(FILE(path './user_files/os.tsv' format 'TabSeparated'))

Configuration file

<source>
  <file>
    <path>/opt/dictionaries/os.tsv</path>
    <format>TabSeparated</format>
  </file>
</source>

Setting fields:

Setting	Description
path	The absolute path to the file.
format	The file format. All the formats described in Formats are supported.

When a dictionary with source FILE is created via DDL command (CREATE DICTIONARY ...), the source file needs to be located in the user_files directory to prevent DB users from accessing arbitrary files on the ClickHouse node.

See Also

• Dictionary function