Skip to main content
Skip to main content
Edit this page

外部字典的来源

外部字典可以从许多不同的来源连接。

如果使用xml-file配置字典，则配置如下所示:

在情况下 DDL-查询，相等的配置将看起来像:

源配置在 source 科。

对于源类型 本地文件, 可执行文件, HTTP(s), ClickHouse 可选设置:

或

来源类型 (source_type):

本地文件​

设置示例:

或

设置字段:

  • path – The absolute path to the file.
  • format – The file format. All the formats described in “格式” 支持。

可执行文件​

使用可执行文件取决于 字典如何存储在内存中. 如果字典存储使用 cache 和 complex_key_cache，ClickHouse通过向可执行文件的STDIN发送请求来请求必要的密钥。 否则，ClickHouse将启动可执行文件并将其输出视为字典数据。

设置示例:

或

设置字段:

  • command – The absolute path to the executable file, or the file name (if the program directory is written to PATH).
  • format – The file format. All the formats described in “格式” 支持。

Http(s)​

使用HTTP（s）服务器取决于 字典如何存储在内存中. 如果字典存储使用 cache 和 complex_key_cache，ClickHouse通过通过发送请求请求必要的密钥 POST 方法。

设置示例:

或

为了让ClickHouse访问HTTPS资源，您必须 配置openSSL 在服务器配置中。

设置字段:

  • url – The source URL.
  • format – The file format. All the formats described in “格式” 支持。
  • credentials – Basic HTTP authentication. Optional parameter.
    • user – Username required for the authentication.
    • password – Password required for the authentication.
  • headers – All custom HTTP headers entries used for the HTTP request. Optional parameter.
    • header – Single HTTP header entry.
    • name – Identifiant name used for the header send on the request.
    • value – Value set for a specific identifiant name.

ODBC​

您可以使用此方法连接具有ODBC驱动程序的任何数据库。

设置示例:

或

设置字段:

  • db – Name of the database. Omit it if the database name is set in the <connection_string> 参数。
  • table – Name of the table and schema if exists.
  • connection_string – Connection string.
  • invalidate_query – Query for checking the dictionary status. Optional parameter. Read more in the section 更新字典.

ClickHouse接收来自ODBC-driver的引用符号，并将查询中的所有设置引用到driver，因此有必要根据数据库中的表名大小写设置表名。

如果您在使用Oracle时遇到编码问题，请参阅相应的 FAQ 文章.

ODBC字典功能的已知漏洞​

"注意"

通过ODBC驱动程序连接参数连接到数据库时 Servername 可以取代。 在这种情况下，值 USERNAME 和 PASSWORD 从 odbc.ini 被发送到远程服务器，并且可能会受到损害。

不安全使用示例

让我们为PostgreSQL配置unixODBC。 的内容 /etc/odbc.ini:

如果然后进行查询，例如

ODBC驱动程序将发送的值 USERNAME 和 PASSWORD 从 odbc.ini 到 some-server.com.

连接Postgresql的示例​

Ubuntu操作系统。

为PostgreSQL安装unixODBC和ODBC驱动程序:

配置 /etc/odbc.ini （或 ~/.odbc.ini):

ClickHouse中的字典配置:

或

您可能需要编辑 odbc.ini 使用驱动程序指定库的完整路径 DRIVER=/usr/local/lib/psqlodbcw.so.

连接MS SQL Server的示例​

Ubuntu操作系统。

安装驱动程序: :

配置驱动程序:

在ClickHouse中配置字典:

或

DBMS​

Mysql​

设置示例:

或

设置字段:

  • port – The port on the MySQL server. You can specify it for all replicas, or for each one individually (inside <replica>).

  • user – Name of the MySQL user. You can specify it for all replicas, or for each one individually (inside <replica>).

  • password – Password of the MySQL user. You can specify it for all replicas, or for each one individually (inside <replica>).

  • replica – Section of replica configurations. There can be multiple sections.

    • replica/host – The MySQL host.
    • replica/priority – The replica priority. When attempting to connect, ClickHouse traverses the replicas in order of priority. The lower the number, the higher the priority.

  • db – Name of the database.

  • table – Name of the table.

  • where – The selection criteria. The syntax for conditions is the same as for WHERE 例如，mysql中的子句, id > 10 AND id < 20. 可选参数。

  • invalidate_query – Query for checking the dictionary status. Optional parameter. Read more in the section 更新字典.

MySQL可以通过套接字在本地主机上连接。 要做到这一点，设置 host 和 socket.

设置示例:

或

ClickHouse​

设置示例:

或

设置字段:

  • host – The ClickHouse host. If it is a local host, the query is processed without any network activity. To improve fault tolerance, you can create a 分布 表并在后续配置中输入它。
  • port – The port on the ClickHouse server.
  • user – Name of the ClickHouse user.
  • password – Password of the ClickHouse user.
  • db – Name of the database.
  • table – Name of the table.
  • where – The selection criteria. May be omitted.
  • invalidate_query – Query for checking the dictionary status. Optional parameter. Read more in the section 更新字典.

Mongodb​

设置示例:

或

设置字段:

  • host – The MongoDB host.
  • port – The port on the MongoDB server.
  • user – Name of the MongoDB user.
  • password – Password of the MongoDB user.
  • db – Name of the database.
  • collection – Name of the collection.

Redis​

设置示例:

或

设置字段:

  • host – The Redis host.
  • port – The port on the Redis server.
  • storage_type – The structure of internal Redis storage using for work with keys. simple 适用于简单源和散列单键源, hash_map 用于具有两个键的散列源。 不支持具有复杂键的范围源和缓存源。 可以省略，默认值为 simple.
  • db_index – The specific numeric index of Redis logical database. May be omitted, default value is 0.