> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-3a82795f.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Dictionary Sources

> Dictionary source types configuration

export const ExperimentalBadge = () => {
  return <div className="experimentalBadge">
            <div className="experimentalIcon">
            <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                <path strokeWidth="1.25" d="M5.5 2H10.5" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.25" d="M9.50015 2V6.19625L13.4283 12.7425C13.4738 12.8183 13.4985 12.9049 13.4996 12.9934C13.5008 13.0818 13.4785 13.169 13.435 13.246C13.3914 13.323 13.3283 13.3871 13.2519 13.4317C13.1755 13.4764 13.0886 13.4999 13.0002 13.5H3.00015C2.91164 13.5 2.8247 13.4766 2.74822 13.432C2.67174 13.3874 2.60847 13.3233 2.56487 13.2463C2.52126 13.1693 2.49889 13.082 2.50004 12.9935C2.50119 12.905 2.52582 12.8184 2.5714 12.7425L6.50015 6.19625V2" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.25" d="M4.47656 9.56754C5.30344 9.41254 6.47656 9.47942 7.99969 10.25C10.0153 11.2707 11.4216 11.0569 12.2184 10.7282" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
            </svg>
        </div>
            Experimental feature. <u><a href="/docs/beta-and-experimental-features#experimental-features">Learn more.</a></u>
        </div>;
};

export const CloudNotSupportedBadge = () => {
  return <div className="cloudNotSupportedBadge">
            <div className="cloudNotSupportedIcon">
            <svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
                <path strokeWidth="1.5" d="M6.33366 12.6666L12.3739 12.6667C13.6593 12.6667 14.7073 11.6187 14.7073 10.3334C14.7073 9.04804 13.6593 8.00003 12.3739 8.00003C12.3739 8.00003 12.3337 7.66659 12.0003 7.33325M10.667 5.33322C8.00033 2.33325 4.45395 4.78537 4.14195 6.68203C2.55728 6.7627 1.29395 8.06203 1.29395 9.6667C1.29395 11.3234 2.66699 12.6666 4.00033 12.6666" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
                <path strokeWidth="1.5" d="M2.66699 14L12.0003 4.66663" stroke="currentColor" strokeLinecap="round" strokeLinejoin="round" />
            </svg>

        </div>
            Not supported in ClickHouse Cloud
        </div>;
};

<h2 id="dictionary-sources">
  Syntax
</h2>

<Tip>
  If you are using a dictionary with ClickHouse Cloud please use the DDL query option to create your dictionaries, and create your dictionary as user `default`.
  Also, verify the list of supported dictionary sources in the [Cloud Compatibility guide](/products/cloud/guides/cloud-compatibility).
</Tip>

A dictionary can be connected to ClickHouse from many different sources.
The source is configured in the `source` section for configuration file and using the `SOURCE` clause for DDL statement.

<Tabs>
  <Tab title="DDL">
    ```sql theme={null}
    CREATE DICTIONARY dict_name (...)
    ...
    SOURCE(SOURCE_TYPE(param1 val1 ... paramN valN)) -- Source configuration
    ...
    ```
  </Tab>

  <Tab title="Configuration file">
    ```xml theme={null}
    <clickhouse>
      <dictionary>
        ...
        <source>
          <source_type>
            <!-- Source configuration -->
          </source_type>
        </source>
        ...
      </dictionary>
      ...
    </clickhouse>
    ```
  </Tab>
</Tabs>

<br />

<h2 id="supported-dictionary-sources">
  Supported dictionary sources
</h2>

The following source types (`SOURCE_TYPE`/`source_type`) are available:

* [Local file](/reference/statements/create/dictionary/sources/local-file)
* [Executable File](/reference/statements/create/dictionary/sources/executable-file)
* [Executable Pool](/reference/statements/create/dictionary/sources/executable-pool)
* [HTTP(S)](/reference/statements/create/dictionary/sources/http)
* DBMS
  * [ODBC](/reference/statements/create/dictionary/sources/odbc)
  * [MySQL](/reference/statements/create/dictionary/sources/mysql)
  * [ClickHouse](/reference/statements/create/dictionary/sources/clickhouse)
  * [MongoDB](/reference/statements/create/dictionary/sources/mongodb)
  * [Redis](/reference/statements/create/dictionary/sources/redis)
  * [Cassandra](/reference/statements/create/dictionary/sources/cassandra)
  * [PostgreSQL](/reference/statements/create/dictionary/sources/postgresql)
  * [YTsaurus](/reference/statements/create/dictionary/sources/ytsaurus)
* [YAMLRegExpTree](/reference/statements/create/dictionary/sources/yamlregexptree)
* [Null](/reference/statements/create/dictionary/sources/null)

For source types [Local file](/reference/statements/create/dictionary/sources/local-file), [Executable file](/reference/statements/create/dictionary/sources/executable-file), [HTTP(s)](/reference/statements/create/dictionary/sources/http), [ClickHouse](/reference/statements/create/dictionary/sources/clickhouse)
optional settings are available:

<Tabs>
  <Tab title="DDL">
    ```sql highlight={2} theme={null}
    SOURCE(FILE(path './user_files/os.tsv' format 'TabSeparated'))
    SETTINGS(format_csv_allow_single_quotes = 0)
    ```
  </Tab>

  <Tab title="Configuration file">
    ```xml highlight={7} theme={null}
    <source>
      <file>
        <path>/opt/dictionaries/os.tsv</path>
        <format>TabSeparated</format>
      </file>
      <settings>
          <format_csv_allow_single_quotes>0</format_csv_allow_single_quotes>
      </settings>
    </source>
    ```
  </Tab>
</Tabs>
