跳到主要内容
跳到主要内容

NATS 引擎

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

NATS 让您可以：

  • 发布或订阅消息主题。
  • 处理新消息，当它们可用时。

创建表​

必需参数：

  • nats_url – 主机:端口（例如，localhost:5672）。
  • nats_subjects – NATS 表订阅/发布的主题列表。支持通配符主题，如 foo.*.bar 或 baz.>。
  • nats_format – 消息格式。使用与 SQL FORMAT 函数相同的表示法，例如 JSONEachRow。有关更多信息，请参见 Formats 部分。

可选参数：

  • nats_schema – 如果格式需要架构定义，必须使用的参数。例如，Cap'n Proto 需要架构文件的路径和根 schema.capnp:Message 对象的名称。
  • nats_num_consumers – 每个表的消费者数量。默认值: 1。如果单个消费者的吞吐量不足，请指定更多消费者。
  • nats_queue_group – NATS 订阅者的队列组名称。默认是表名。
  • nats_max_reconnect – 已弃用并且没有效果，重连始终以 nats_reconnect_wait 超时永久执行。
  • nats_reconnect_wait – 每次重连尝试之间的等待时间（毫秒）。默认值: 5000。
  • nats_server_list - 连接的服务器列表。可以指定以连接到 NATS 集群。
  • nats_skip_broken_messages - NATS 消息解析器对每个块中的架构不兼容消息的容忍度。默认值: 0。如果 nats_skip_broken_messages = N，则引擎会跳过 N 个无法解析的 NATS 消息（消息等于一行数据）。
  • nats_max_block_size - 从 NATS 刷新数据时由轮询收集的行数。默认值: max_insert_block_size。
  • nats_flush_interval_ms - 刷新从 NATS 读取的数据的超时。默认值: stream_flush_interval_ms。
  • nats_username - NATS 用户名。
  • nats_password - NATS 密码。
  • nats_token - NATS 认证令牌。
  • nats_credential_file - NATS 凭证文件的路径。
  • nats_startup_connect_tries - 启动时的连接尝试次数。默认值: 5。
  • nats_max_rows_per_message — 一条 NATS 消息中写入的最大行数（适用于基于行的格式）。默认值: 1。
  • nats_handle_error_mode — 如何处理 NATS 引擎的错误。可能的值：默认（如果我们无法解析消息，将抛出异常），流（异常消息和原始消息将保存在虚拟列 _error 和 _raw_message 中）。

SSL 连接：

要进行安全连接，请使用 nats_secure = 1。 所使用的库的默认行为是不检查创建的 TLS 连接是否足够安全。证书是否过期、自签名、缺失或无效：都将允许连接。可能会在未来实现对证书的更严格检查。

写入 NATS 表：

如果表仅从一个主题读取，则任何插入都将发布到同一主题。 但是，如果表从多个主题读取，我们需要指定要发布到的主题。 因此，每当插入到具有多个主题的表中时，都需要设置 stream_like_engine_insert_queue。 您可以从表读取的主题中选择一个，并将数据发布到那里。例如：

还可以添加格式设置以及与 nats 相关的设置。

示例：

NATS 服务器配置可以使用 ClickHouse 配置文件添加。 更具体地说，您可以为 NATS 引擎添加 Redis 密码：

描述​

SELECT 对于读取消息不是特别有用（除了调试），因为每条消息只能读取一次。使用 物化视图 创建实时线程更为实用。为此：

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

当 MATERIALIZED VIEW 加入引擎时，它开始在后台收集数据。这使您能够不断接收来自 NATS 的消息，并使用 SELECT 将其转换为所需格式。 一个 NATS 表可以拥有任意数量的物化视图，它们不是直接从表中读取数据，而是以块的形式接收新记录，这样您可以将数据写入多个具有不同细节级别的表（有聚合和没有聚合）。

示例：

要停止接收流数据或更改转换逻辑，请分离物化视图：

如果您想通过使用 ALTER 更改目标表，建议禁用物化视图以避免目标表与视图数据之间的不一致。

虚拟列​

  • _subject - NATS 消息主题。数据类型：String。

如果 nats_handle_error_mode='stream'，则还有附加的虚拟列：

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

注意：在解析期间发生异常时，_raw_message 和 _error 虚拟列才会被填充，当消息成功解析时，它们始终为 NULL。

数据格式支持​

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

  • 对于基于行的格式，可以通过设置 nats_max_rows_per_message 来控制一条 NATS 消息中的行数。
  • 对于基于块的格式，我们不能将块拆分为更小的部分，但可以通过通用设置 max_block_size 控制单个块中的行数。