RabbitMQ 引擎

该引擎允许将 ClickHouse 与 RabbitMQ 集成。

RabbitMQ 让您可以：

发布或订阅数据流。
处理可用的流。

创建表

CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cluster]
(
    name1 [type1],
    name2 [type2],
    ...
) ENGINE = RabbitMQ SETTINGS
    rabbitmq_host_port = 'host:port' [or rabbitmq_address = 'amqp(s)://guest:guest@localhost/vhost'],
    rabbitmq_exchange_name = 'exchange_name',
    rabbitmq_format = 'data_format'[,]
    [rabbitmq_exchange_type = 'exchange_type',]
    [rabbitmq_routing_key_list = 'key1,key2,...',]
    [rabbitmq_secure = 0,]
    [rabbitmq_schema = '',]
    [rabbitmq_num_consumers = N,]
    [rabbitmq_num_queues = N,]
    [rabbitmq_queue_base = 'queue',]
    [rabbitmq_deadletter_exchange = 'dl-exchange',]
    [rabbitmq_persistent = 0,]
    [rabbitmq_skip_broken_messages = N,]
    [rabbitmq_max_block_size = N,]
    [rabbitmq_flush_interval_ms = N,]
    [rabbitmq_queue_settings_list = 'x-dead-letter-exchange=my-dlx,x-max-length=10,x-overflow=reject-publish',]
    [rabbitmq_queue_consume = false,]
    [rabbitmq_address = '',]
    [rabbitmq_vhost = '/',]
    [rabbitmq_username = '',]
    [rabbitmq_password = '',]
    [rabbitmq_commit_on_select = false,]
    [rabbitmq_max_rows_per_message = 1,]
    [rabbitmq_handle_error_mode = 'default']

必需参数：

rabbitmq_host_port – 主机:端口（例如，localhost:5672）。
rabbitmq_exchange_name – RabbitMQ 交换名称。
rabbitmq_format – 消息格式。使用与 SQL FORMAT 函数相同的语法，例如 JSONEachRow。有关更多信息，请参见格式部分。

可选参数：

rabbitmq_exchange_type – RabbitMQ 交换类型：direct、fanout、topic、headers、consistent_hash。默认值：fanout。
rabbitmq_routing_key_list – 逗号分隔的路由键列表。
rabbitmq_schema – 如果格式需要模式定义，则必须使用的参数。例如，Cap'n Proto 要求提供模式文件的路径和根 schema.capnp:Message 对象的名称。
rabbitmq_num_consumers – 每个表的消费者数量。如果一个消费者的吞吐量不足，请指定更多消费者。默认值：1
rabbitmq_num_queues – 队列的总数。增加此数字可以显著提高性能。默认值：1。
rabbitmq_queue_base - 指定队列名称的提示。有关此设置的用例请参见下文。
rabbitmq_deadletter_exchange - 指定死信交换的名称。您可以使用此交换名称创建另一个表并在消息重新发布到死信交换时收集消息。默认情况下，不指定死信交换。
rabbitmq_persistent - 如果设置为 1（真），则插入查询的传递模式将设置为 2（将消息标记为“持久”）。默认值：0。
rabbitmq_skip_broken_messages – RabbitMQ 消息解析器对每个块不兼容模式的消息的容忍度。如果 rabbitmq_skip_broken_messages = N，则引擎跳过 N 个无法解析的 RabbitMQ 消息（消息等于一行数据）。默认值：0。
rabbitmq_max_block_size - 在从 RabbitMQ 刷新数据之前收集的行数。默认值：max_insert_block_size。
rabbitmq_flush_interval_ms - 从 RabbitMQ 刷新数据的超时。默认值：stream_flush_interval_ms。
rabbitmq_queue_settings_list - 在创建队列时允许设置 RabbitMQ 设置。可用设置：x-max-length、x-max-length-bytes、x-message-ttl、x-expires、x-priority、x-max-priority、x-overflow、x-dead-letter-exchange、x-queue-type。队列的 durable 设置会自动启用。
rabbitmq_address - 连接地址。使用此设置或 rabbitmq_host_port。
rabbitmq_vhost - RabbitMQ vhost。默认值：'\'。
rabbitmq_queue_consume - 使用用户定义的队列而不进行任何 RabbitMQ 设置：声明交换、队列、绑定。默认值：false。
rabbitmq_username - RabbitMQ 用户名。
rabbitmq_password - RabbitMQ 密码。
reject_unhandled_messages - 在出现错误的情况下拒绝消息（发送 RabbitMQ 负确认）。如果在 rabbitmq_queue_settings_list 中定义了 x-dead-letter-exchange，则此设置会自动启用。
rabbitmq_commit_on_select - 在进行选择查询时提交消息。默认值：false。
rabbitmq_max_rows_per_message — 单个 RabbitMQ 消息中写入的最大行数（针对行式格式）。默认值：1。
rabbitmq_empty_queue_backoff_start — 在 RabbitMQ 队列为空时，重新调度读取的启动回退点。
rabbitmq_empty_queue_backoff_end — 在 RabbitMQ 队列为空时，重新调度读取的结束回退点。
rabbitmq_handle_error_mode — 如何处理 RabbitMQ 引擎的错误。可能的值：default（如果解析消息失败，异常将被抛出），stream（异常消息和原始消息将保存在虚拟列 _error 和 _raw_message 中），dead_letter_queue（与错误相关的数据将保存在 system.dead_letter_queue 中）。
- SSL 连接：

使用 rabbitmq_secure = 1 或在连接地址中使用 amqps：rabbitmq_address = 'amqps://guest:guest@localhost/vhost'。所使用库的默认行为是不检查创建的 TLS 连接是否足够安全。无论证书是否过期、自签名、丢失或无效：连接都被允许。可能在未来实现对证书的更严格检查。

还可以在与 RabbitMQ 相关的设置中添加格式设置。

示例：

CREATE TABLE queue (
  key UInt64,
  value UInt64,
  date DateTime
) ENGINE = RabbitMQ SETTINGS rabbitmq_host_port = 'localhost:5672',
                          rabbitmq_exchange_name = 'exchange1',
                          rabbitmq_format = 'JSONEachRow',
                          rabbitmq_num_consumers = 5,
                          date_time_input_format = 'best_effort';

RabbitMQ 服务器配置应使用 ClickHouse 配置文件添加。

必需配置：

<rabbitmq>
   <username>root</username>
   <password>clickhouse</password>
</rabbitmq>

附加配置：

<rabbitmq>
   <vhost>clickhouse</vhost>
</rabbitmq>

描述

SELECT 在读取消息时并不是特别有用（除非是调试），因为每条消息只能读取一次。使用物化视图创建实时线程更为实际。要做到这一点：

使用该引擎创建 RabbitMQ 消费者并将其视为数据流。
创建具有所需结构的表。
创建一个物化视图，将来自引擎的数据转换并放入先前创建的表中。

当 MATERIALIZED VIEW 连接到引擎时，它开始在后台收集数据。这允许您不断从 RabbitMQ 接收消息并使用 SELECT 将其转换为所需格式。一个 RabbitMQ 表可以有任意数量的物化视图。

可以根据 rabbitmq_exchange_type 和指定的 rabbitmq_routing_key_list 进行数据通道。每个表最多只能有一个交换。一个交换可以在多个表之间共享 - 这使得能够同时路由到多个表。

交换类型选项：

direct - 路由基于键的精确匹配。示例表键列表：key1,key2,key3,key4,key5，消息键可以等于其中任何一个。
fanout - 路由到所有表（交换名称相同）而不考虑键。
topic - 路由基于用点分隔的键模式。示例：*.logs、records.*.*.2020、*.2018,*.2019,*.2020。
headers - 路由根据 key=value 匹配，设置 x-match=all 或 x-match=any。示例表键列表：x-match=all,format=logs,type=report,year=2020。
consistent_hash - 数据在所有绑定表之间均匀分配（交换名称相同）。注意，必须启用此交换类型的 RabbitMQ 插件：rabbitmq-plugins enable rabbitmq_consistent_hash_exchange。

rabbitmq_queue_base 的设置可用于以下情况：

让不同的表共享队列，以便可以为相同的队列注册多个消费者，从而改善性能。如果使用 rabbitmq_num_consumers 和/或 rabbitmq_num_queues 设置，则在这些参数相同的情况下可以实现队列的精确匹配。
能够在不是所有消息都成功消费后从特定持久队列恢复读取。要从一个特定队列恢复消费 - 在 rabbitmq_queue_base 设置中设置其名称，并且不指定 rabbitmq_num_consumers 和 rabbitmq_num_queues（默认值为 1）。要恢复所有声明为特定表的队列的消费 - 只需指定相同的设置：rabbitmq_queue_base、rabbitmq_num_consumers、rabbitmq_num_queues。默认情况下，队列名称将在表之间唯一。
由于它们被声明为持久且不自动删除，因此可以重用队列。（可以通过任何 RabbitMQ CLI 工具删除。）

为了提高性能，接收到的消息被分组到具有 max_insert_block_size 的块中。如果在 stream_flush_interval_ms 毫秒内未形成块，则数据将被刷新到表中，而不管块是否完整。

如果 rabbitmq_num_consumers 和/或 rabbitmq_num_queues 设置与 rabbitmq_exchange_type 一起指定，则：

必须启用 rabbitmq-consistent-hash-exchange 插件。
发布的消息的 message_id 属性必须指定（对于每条消息/批次唯一）。

对于插入查询，有消息元数据，它会为每条发布的消息添加：messageID 和 republished 标志（如果发布超过一次，则为真） - 可以通过消息头访问。

不要对插入和物化视图使用相同的表。

示例：

CREATE TABLE queue (
  key UInt64,
  value UInt64
) ENGINE = RabbitMQ SETTINGS rabbitmq_host_port = 'localhost:5672',
                          rabbitmq_exchange_name = 'exchange1',
                          rabbitmq_exchange_type = 'headers',
                          rabbitmq_routing_key_list = 'format=logs,type=report,year=2020',
                          rabbitmq_format = 'JSONEachRow',
                          rabbitmq_num_consumers = 5;

CREATE TABLE daily (key UInt64, value UInt64)
  ENGINE = MergeTree() ORDER BY key;

CREATE MATERIALIZED VIEW consumer TO daily
  AS SELECT key, value FROM queue;

SELECT key, value FROM daily ORDER BY key;

虚拟列

_exchange_name - RabbitMQ 交换名称。数据类型：String。
_channel_id - 声明接收消息的消费者的 ChannelID。数据类型：String。
_delivery_tag - 接收消息的 DeliveryTag。按通道作用域。数据类型：UInt64。
_redelivered - 消息的 redelivered 标志。数据类型：UInt8。
_message_id - 接收消息的 messageID；如果在消息发布时设置，则非空。数据类型：String。
_timestamp - 接收消息的时间戳；如果在消息发布时设置，则非空。数据类型：UInt64。

当 rabbitmq_handle_error_mode='stream' 时的附加虚拟列：

_raw_message - 无法成功解析的原始消息。数据类型：Nullable(String)。
_error - 在解析失败时发生的异常消息。数据类型：Nullable(String)。

注意：只有在解析时发生异常的情况下，_raw_message 和 _error 虚拟列才会填充，当消息成功解析时，它们始终为 NULL。

注意事项

即使您可以在表定义中指定默认列表达式（如 DEFAULT、MATERIALIZED、ALIAS），这些也会被忽略。相反，列将填充其类型的各自默认值。

数据格式支持

RabbitMQ 引擎支持 ClickHouse 中支持的所有格式。一个 RabbitMQ 消息中的行数取决于格式是行式还是块式：

对于行式格式，单个 RabbitMQ 消息中的行数可以通过设置 rabbitmq_max_rows_per_message 来控制。
对于块式格式，我们无法将块分割为更小的部分，但可以通过通用设置 max_block_size 控制一个块中的行数。

创建表​

描述​

虚拟列​

注意事项​

数据格式支持​

创建表

描述

虚拟列

注意事项

数据格式支持