MySQL 字典源

设置示例：

DDL
配置文件

SOURCE(MYSQL(
    port 3306
    user 'clickhouse'
    password 'qwerty'
    replica(host 'example01-1' priority 1)
    replica(host 'example01-2' priority 1)
    db 'db_name'
    table 'table_name'
    where 'id=10'
    invalidate_query 'SQL_QUERY'
    fail_on_connection_loss 'true'
    query 'SELECT id, value_1, value_2 FROM db_name.table_name'
    enable_compression 1
))

<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>
      <fail_on_connection_loss>true</fail_on_connection_loss>
      <query>SELECT id, value_1, value_2 FROM db_name.table_name</query>
      <enable_compression>1</enable_compression>
  </mysql>
</source>

设置字段：

Setting	Description
`port`	MySQL 服务器的端口。可以为所有副本统一指定，也可以为每个副本单独指定 (在 `<replica>` 内) 。
`user`	MySQL 用户名。可以为所有副本统一指定，也可以为每个副本单独指定 (在 `<replica>` 内) 。
`password`	MySQL 用户的密码。可以为所有副本统一指定，也可以为每个副本单独指定 (在 `<replica>` 内) 。
`replica`	副本配置段。可以有多个。
`replica/host`	MySQL 主机。
`replica/priority`	副本优先级。尝试连接时，ClickHouse 会按优先级顺序遍历各个副本。数字越小，优先级越高。
`db`	数据库名称。
`table`	表名称。
`where`	筛选条件。其语法与 MySQL 的 `WHERE` 子句相同，例如 `id > 10 AND id < 20`。可选。
`invalidate_query`	用于检查字典状态的查询。可选。更多信息，请参见使用 LIFETIME 刷新字典数据一节。
`fail_on_connection_loss`	控制连接丢失时服务器的行为。如果为 `true`，当客户端与服务器之间的连接断开时，会立即抛出异常。如果为 `false`，服务器会在报告错误之前至少重试拉取数据三次。请注意，重试会增加响应时间。默认值：`false`。
`query`	自定义查询。可选。
`enable_compression`	为 MySQL 协议连接启用 zlib 压缩。设置为 `1` 时，ClickHouse 会向 MySQL 服务器请求协议级压缩。也可以在 `<replica>` 内为每个副本单独设置。默认值：`0`。
`enable_local_infile`	允许 MySQL 服务器向 ClickHouse 索取本地文件的内容 (`LOAD DATA LOCAL INFILE`) 。只有在服务器配置文件中定义的字典才可以启用它；`CREATE DICTIONARY` 查询可以不设置该项，或将其设置为 `0`。也可以在 `<replica>` 内为每个副本单独设置，未设置该项的 `<replica>` 会继承上层的值。默认值：`0`。
`ssl_ca_pem`	用于验证 MySQL 服务器证书的 CA 证书内容。可选。
`ssl_cert_pem`	用于基于证书的身份验证的客户端证书内容。可选。
`ssl_key_pem`	属于 `ssl_cert_pem` 的私钥内容。可选。
`ssl_ca`, `ssl_cert`, `ssl_key`	与上述相同的凭据，但以服务器上文件的路径形式指定。仅允许用于在服务器配置文件中定义的字典，或通过其中定义的命名集合定义的字典，见下文。可选。

table 或 where 字段不能与 query 字段同时使用。此外，必须声明 table 或 query 其中之一。

ssl_ca、ssl_cert 和 ssl_key 指定的是服务器以自身特权打开的文件，因此它们仅在服务器配置文件中定义的字典，或通过其中定义的命名集合定义的字典中才被接受。若 CREATE DICTIONARY 查询要直接指定 TLS 凭证，则必须改为通过 ssl_ca_pem、ssl_cert_pem 和 ssl_key_pem 传入其内容。这些值会像密码一样，在日志和 SHOW 查询中被掩码处理。

enable_local_infile 允许 MySQL 服务器向 ClickHouse 索取由其自行选择的文件内容，而该文件由服务器以自身特权读取，因此它仅在服务器配置文件中定义的字典中才被接受。若 CREATE DICTIONARY 查询在源或其某个 <replica> 条目中启用该项，则会以 BAD_ARGUMENTS 被拒绝。

没有显式的 secure 参数。建立 SSL 连接时，安全性是强制的。

可以通过套接字在本地主机上连接 MySQL。为此，请设置 host 和 socket。设置示例：

DDL
配置文件

SOURCE(MYSQL(
    host 'localhost'
    socket '/path/to/socket/file.sock'
    user 'clickhouse'
    password 'qwerty'
    db 'db_name'
    table 'table_name'
    where 'id=10'
    invalidate_query 'SQL_QUERY'
    fail_on_connection_loss 'true'
    query 'SELECT id, value_1, value_2 FROM db_name.table_name'
))

<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>
      <fail_on_connection_loss>true</fail_on_connection_loss>
      <query>SELECT id, value_1, value_2 FROM db_name.table_name</query>
  </mysql>
</source>

SQL 参考文档

数据类型

引擎

函数

格式

设置

系统表

数据湖