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

# Источник словаря ODBC

> Настройте ODBC-соединение как источник словаря в ClickHouse.

Этот метод позволяет подключиться к любой базе данных с ODBC-драйвером.

Пример настроек:

<Tabs>
  <Tab title="DDL">
    ```sql theme={null}
    SOURCE(ODBC(
        db 'DatabaseName'
        table 'SchemaName.TableName'
        connection_string 'DSN=some_parameters'
        invalidate_query 'SQL_QUERY'
        query 'SELECT id, value_1, value_2 FROM db_name.table_name'
    ))
    ```
  </Tab>

  <Tab title="Файл конфигурации">
    ```xml theme={null}
    <source>
        <odbc>
            <db>DatabaseName</db>
            <table>ShemaName.TableName</table>
            <connection_string>DSN=some_parameters</connection_string>
            <invalidate_query>SQL_QUERY</invalidate_query>
            <query>SELECT id, value_1, value_2 FROM ShemaName.TableName</query>
        </odbc>
    </source>
    ```
  </Tab>
</Tabs>

<br />

Поля настроек:

| Настройка              | Описание                                                                                                                                                                           |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `db`                   | Имя базы данных. Не указывайте его, если имя базы данных задано в параметрах `<connection_string>`.                                                                                |
| `table`                | Имя таблицы и схемы, если она есть.                                                                                                                                                |
| `connection_string`    | Строка подключения.                                                                                                                                                                |
| `invalidate_query`     | Запрос для проверки состояния словаря. Необязательно. Подробнее см. в разделе [Обновление данных словаря с помощью LIFETIME](/ru/reference/statements/create/dictionary/lifetime). |
| `background_reconnect` | Повторно подключаться к реплике в фоновом режиме, если соединение не удалось. Необязательно.                                                                                       |
| `query`                | Пользовательский запрос. Необязательно.                                                                                                                                            |

<Note>
  Поля `table` и `query` нельзя использовать одновременно. При этом должно быть указано либо поле `table`, либо `query`.
</Note>

ClickHouse получает символы кавычек от ODBC-драйвера и заключает в кавычки все настройки в запросах к драйверу, поэтому имя таблицы необходимо задавать с точным учетом регистра, используемого в базе данных.

Если при использовании Oracle у вас возникают проблемы с кодировками, см. соответствующий пункт [FAQ](/ru/resources/support-center/knowledge-base/integrations/oracle-odbc).

<div id="known-vulnerability-of-the-odbc-dictionary-functionality">
  ### Известная уязвимость функциональности ODBC-словарей
</div>

<Note>
  При подключении к базе данных через параметр подключения ODBC-драйвера `Servername` его можно подменить. В этом случае значения `USERNAME` и `PASSWORD` из `odbc.ini` отправляются на удалённый сервер и могут быть скомпрометированы.
</Note>

**Пример небезопасного использования**

Настроим unixODBC для PostgreSQL. Содержимое `/etc/odbc.ini`:

```text theme={null}
[gregtest]
Driver = /usr/lib/psqlodbca.so
Servername = localhost
PORT = 5432
DATABASE = test_db
#OPTION = 3
USERNAME = test
PASSWORD = test
```

Если затем выполнить, например, такой запрос

```sql theme={null}
SELECT * FROM odbc('DSN=gregtest;Servername=some-server.com', 'test_db');
```

ODBC-драйвер отправит значения `USERNAME` и `PASSWORD` из `odbc.ini` на сервер `some-server.com`.

<div id="example-of-connecting-postgresql">
  ### Пример подключения PostgreSQL
</div>

ОС Ubuntu.

Установка unixODBC и ODBC-драйвера для PostgreSQL:

```bash theme={null}
$ sudo apt-get install -y unixodbc odbcinst odbc-postgresql
```

Настройка `/etc/odbc.ini` (или `~/.odbc.ini`, если вы вошли в систему под пользователем, от имени которого запускается ClickHouse):

```text theme={null}
    [DEFAULT]
    Driver = myconnection

    [myconnection]
    Description         = PostgreSQL connection to my_db
    Driver              = PostgreSQL Unicode
    Database            = my_db
    Servername          = 127.0.0.1
    UserName            = username
    Password            = password
    Port                = 5432
    Protocol            = 9.3
    ReadOnly            = No
    RowVersioning       = No
    ShowSystemTables    = No
    ConnSettings        =
```

Конфигурация словаря в ClickHouse:

<Tabs>
  <Tab title="DDL">
    ```sql theme={null}
    CREATE DICTIONARY table_name (
        id UInt64,
        some_column UInt64 DEFAULT 0
    )
    PRIMARY KEY id
    SOURCE(ODBC(connection_string 'DSN=myconnection' table 'postgresql_table'))
    LAYOUT(HASHED())
    LIFETIME(MIN 300 MAX 360)
    ```
  </Tab>

  <Tab title="Файл конфигурации">
    ```xml theme={null}
    <clickhouse>
        <dictionary>
            <name>table_name</name>
            <source>
                <odbc>
                    <!-- В connection_string можно указать следующие параметры: -->
                    <!-- DSN=myconnection;UID=username;PWD=password;HOST=127.0.0.1;PORT=5432;DATABASE=my_db -->
                    <connection_string>DSN=myconnection</connection_string>
                    <table>postgresql_table</table>
                </odbc>
            </source>
            <lifetime>
                <min>300</min>
                <max>360</max>
            </lifetime>
            <layout>
                <hashed/>
            </layout>
            <structure>
                <id>
                    <name>id</name>
                </id>
                <attribute>
                    <name>some_column</name>
                    <type>UInt64</type>
                    <null_value>0</null_value>
                </attribute>
            </structure>
        </dictionary>
    </clickhouse>
    ```
  </Tab>
</Tabs>

<br />

При необходимости отредактируйте `odbc.ini`, чтобы указать полный путь к библиотеке драйвера: `DRIVER=/usr/local/lib/psqlodbcw.so`.

<div id="example-of-connecting-ms-sql-server">
  ### Пример подключения к MS SQL Server
</div>

В ОС Ubuntu.

Установка ODBC-драйвера для подключения к MS SQL:

```bash theme={null}
$ sudo apt-get install tdsodbc freetds-bin sqsh
```

Настройка драйвера:

```bash theme={null}
    $ cat /etc/freetds/freetds.conf
    ...

    [MSSQL]
    host = 192.168.56.101
    port = 1433
    tds version = 7.0
    client charset = UTF-8

    # проверка TDS-соединения
    $ sqsh -S MSSQL -D database -U user -P password

    $ cat /etc/odbcinst.ini

    [FreeTDS]
    Description     = FreeTDS
    Driver          = /usr/lib/x86_64-linux-gnu/odbc/libtdsodbc.so
    Setup           = /usr/lib/x86_64-linux-gnu/odbc/libtdsS.so
    FileUsage       = 1
    UsageCount      = 5

    $ cat /etc/odbc.ini
    # $ cat ~/.odbc.ini # если вы вошли под пользователем, от имени которого запускается ClickHouse

    [MSSQL]
    Description     = FreeTDS
    Driver          = FreeTDS
    Servername      = MSSQL
    Database        = test
    UID             = test
    PWD             = test
    Port            = 1433

    # (необязательно) проверка ODBC-соединения (для использования isql-tool установите пакет [unixodbc](https://packages.debian.org/sid/unixodbc))
    $ isql -v MSSQL "user" "password"
```

Примечания:

* чтобы определить самую раннюю версию TDS, поддерживаемую той или иной версией SQL Server, обратитесь к документации продукта или ознакомьтесь с [MS-TDS Product Behavior](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-tds/135d0ebe-5c4c-4a94-99bf-1811eccb9f4a)

Настройка словаря в ClickHouse:

<Tabs>
  <Tab title="DDL">
    ```sql theme={null}
    CREATE DICTIONARY test (
        k UInt64,
        s String DEFAULT ''
    )
    PRIMARY KEY k
    SOURCE(ODBC(table 'dict' connection_string 'DSN=MSSQL;UID=test;PWD=test'))
    LAYOUT(FLAT())
    LIFETIME(MIN 300 MAX 360)
    ```
  </Tab>

  <Tab title="Файл конфигурации">
    ```xml theme={null}
    <clickhouse>
        <dictionary>
            <name>test</name>
            <source>
                <odbc>
                    <table>dict</table>
                    <connection_string>DSN=MSSQL;UID=test;PWD=test</connection_string>
                </odbc>
            </source>

            <lifetime>
                <min>300</min>
                <max>360</max>
            </lifetime>

            <layout>
                <flat />
            </layout>

            <structure>
                <id>
                    <name>k</name>
                </id>
                <attribute>
                    <name>s</name>
                    <type>String</type>
                    <null_value></null_value>
                </attribute>
            </structure>
        </dictionary>
    </clickhouse>
    ```
  </Tab>
</Tabs>