ClickHouse/docs/ru/dicts/external_dicts_dict_sources.rst

412 lines
12 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

.. _dicts-external_dicts_dict_sources:
**************************
Источники внешних словарей
**************************
Внешний словарь можно подключить из множества источников.
Общий вид конфигурации:
.. code-block:: xml
<dictionaries>
<dictionary>
...
<source>
<source_type>
<!-- Source configuration -->
</source_type>
</source>
...
</dictionary>
...
</dictionaries>
Источник настраивается в разделе ``source``.
Типы источников (``source_type``):
* :ref:`dicts-external_dicts_dict_sources-local_file`
* :ref:`dicts-external_dicts_dict_sources-executable`
* :ref:`dicts-external_dicts_dict_sources-http`
* :ref:`dicts-external_dicts_dict_sources-odbc`
* СУБД:
* :ref:`dicts-external_dicts_dict_sources-mysql`
* :ref:`dicts-external_dicts_dict_sources-clickhouse`
* :ref:`dicts-external_dicts_dict_sources-mongodb`
.. _dicts-external_dicts_dict_sources-local_file:
Локальный файл
==============
Пример настройки:
.. code-block:: xml
<source>
<file>
<path>/opt/dictionaries/os.tsv</path>
<format>TabSeparated</format>
</file>
</source>
Поля настройки:
* ``path`` - Абсолютный путь к файлу.
* ``format`` - Формат файла. Поддерживаются все форматы, описанные в разделе ":ref:`formats`".
.. _dicts-external_dicts_dict_sources-executable:
Исполняемый файл
================
Работа с исполняемым файлом зависит от :ref:`размещения словаря в памяти <dicts-external_dicts_dict_layout>`. Если тип размещения словаря ``cache`` и ``complex_key_cache``, то ClickHouse запрашивает необходимые ключи, отправляя запрос в ``STDIN`` исполняемого файла.
Пример настройки:
.. code-block:: xml
<source>
<executable>
<command>cat /opt/dictionaries/os.tsv</command>
<format>TabSeparated</format>
</executable>
</source>
Поля настройки:
* ``command`` - Абсолютный путь к исполняемому файлу или имя файла (если каталог программы прописан в ``PATH``).
* ``format`` - Формат файла. Поддерживаются все форматы, описанные в разделе ":ref:`formats`".
.. _dicts-external_dicts_dict_sources-http:
HTTP(s)
=======
Работа с HTTP(s) сервером зависит от :ref:`размещения словаря в памяти <dicts-external_dicts_dict_layout>`. Если тип размещения словаря ``cache`` и ``complex_key_cache``, то ClickHouse запрашивает необходимые ключи, отправляя запрос методом ``POST``.
Пример настройки:
.. code-block:: xml
<source>
<http>
<url>http://[::1]/os.tsv</url>
<format>TabSeparated</format>
</http>
</source>
Чтобы ClickHouse смог обратиться к HTTPS-ресурсу, необходимо :ref:`настроить openSSL <server_settings-openSSL>` в конфигурации сервера.
Поля настройки:
* ``url`` - URL источника.
* ``format`` - Формат файла. Поддерживаются все форматы, описанные в разделе ":ref:`formats`".
.. _dicts-external_dicts_dict_sources-odbc:
ODBC
====
Этим способом можно подключить любую базу данных, имеющую ODBC драйвер.
Пример настройки:
.. code-block:: xml
<odbc>
<db>DatabaseName</db>
<table>TableName</table>
<connection_string>DSN=some_parameters</connection_string>
<invalidate_query>SQL_QUERY</invalidate_query>
</odbc>
Поля настройки:
* ``db`` - имя базы данных. Не указывать, если имя базы задано в параметрах ``<connection_string>``.
* ``table`` - имя таблицы.
* ``connection_string`` - строка соединения.
* ``invalidate_query`` - запрос для проверки статуса словаря. Необязательный параметр. Читайте подробнее в разделе :ref:`dicts-external_dicts_dict_lifetime`.
Пример подключения PostgreSQL
-----------------------------
ОС Ubuntu.
Установка unixODBC и ODBC-драйвера для PostgreSQL: ::
sudo apt-get install -y unixodbc odbcinst odbc-postgresql
Настройка ``/etc/odbc.ini`` (или ``~/.odbc.ini``): ::
[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:
.. code-block:: xml
<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>
Может понадобиться в ``odbc.ini`` указать полный путь до библиотеки с драйвером ``DRIVER=/usr/local/lib/psqlodbcw.so``.
Пример подключения MS SQL Server
--------------------------------
ОС Ubuntu.
Установка драйвера: ::
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
$ 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 ~/.odbc.ini
...
[MSSQL]
Description = FreeTDS
Driver = FreeTDS
Servername = MSSQL
Database = test
UID = test
PWD = test
Port = 1433
Настройка словаря в ClickHouse:
.. code-block:: xml
<dictionaries>
<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>
</dictionaries>
СУБД
====
.. _dicts-external_dicts_dict_sources-mysql:
MySQL
-----
Пример настройки:
.. code-block:: xml
<source>
<mysql>
<port>3306</port>
<user>clickhouse</user>
<password>qwerty</password>
<replica>
<host>example01-1</host>
<priority>1</priority>
</replica>
<replica>
<host>example01-2</host>
<priority>1</priority>
</replica>
<db>db_name</db>
<table>table_name</table>
<where>id=10</where>
<invalidate_query>SQL_QUERY</invalidate_query>
</mysql>
</source>
Поля настройки:
* ``port`` - порт сервера MySQL. Можно указать для всех реплик или для каждой в отдельности (внутри ``<replica>``).
* ``user`` - имя пользователя MySQL. Можно указать для всех реплик или для каждой в отдельности (внутри ``<replica>``).
* ``password`` - пароль пользователя MySQL. Можно указать для всех реплик или для каждой в отдельности (внутри ``<replica>``).
* ``replica`` - блок конфигурации реплики. Блоков может быть несколько.
* ``replica/host`` - хост MySQL.
* ``replica/priority`` - приоритет реплики. При попытке соединения ClickHouse обходит реплики в соответствии с приоритетом. Чем меньше цифра, тем выше приоритет.
* ``db`` - имя базы данных.
* ``table`` - имя таблицы.
* ``where`` - условие выбора. Необязательный параметр.
* ``invalidate_query`` - запрос для проверки статуса словаря. Необязательный параметр. Читайте подробнее в разделе :ref:`dicts-external_dicts_dict_lifetime`.
MySQL можно подключить на локальном хосте через сокеты, для этого необходимо задать ``host`` и ``socket``.
Пример настройки:
.. code-block:: xml
<source>
<mysql>
<host>localhost</host>
<socket>/path/to/socket/file.sock</socket>
<user>clickhouse</user>
<password>qwerty</password>
<db>db_name</db>
<table>table_name</table>
<where>id=10</where>
<invalidate_query>SQL_QUERY</invalidate_query>
</mysql>
</source>
.. _dicts-external_dicts_dict_sources-clickhouse:
ClickHouse
----------
Пример настройки:
.. code-block:: xml
<source>
<clickhouse>
<host>example01-01-1</host>
<port>9000</port>
<user>default</user>
<password></password>
<db>default</db>
<table>ids</table>
<where>id=10</where>
</clickhouse>
</source>
Поля настройки:
* ``host`` - хост ClickHouse. Если host локальный, то запрос выполняется без сетевого взаимодействия. Чтобы повысить отказоустойчивость решения, можно создать таблицу типа :ref:`Distributed <table_engines-distributed>` и прописать её в дальнейших настройках.
* ``port`` - порт сервера ClickHouse.
* ``user`` - имя пользователя ClickHouse.
* ``password`` - пароль пользователя ClickHouse.
* ``db`` - имя базы данных.
* ``table`` - имя таблицы.
* ``where`` - условие выбора. Может отсутствовать.
.. _dicts-external_dicts_dict_sources-mongodb:
MongoDB
-------
Пример настройки:
.. code-block:: xml
<source>
<mongodb>
<host>localhost</host>
<port>27017</port>
<user></user>
<password></password>
<db>test</db>
<collection>dictionary_source</collection>
</mongodb>
</source>
Поля настройки:
* ``host`` - хост MongoDB.
* ``port`` - порт сервера MongoDB.
* ``user`` - имя пользователя MongoDB.
* ``password`` - пароль пользователя MongoDB.
* ``db`` - имя базы данных.
* ``collection`` - имя коллекции.