参数化聚合函数

某些聚合函数不仅可以接受用于压缩的参数列，还可以接受一组参数 - 初始化的常量。语法使用两个括号对而不是一个。第一个用于参数，第二个用于参数列。

histogram

计算自适应直方图。它不保证精确结果。

该函数使用 A Streaming Parallel Decision Tree Algorithm。直方图箱的边界随着新数据进入函数而调整。在常见情况下，箱的宽度是不相等的。

参数

values — 表达式 结果为输入值。

参数

number_of_bins — 直方图中箱的数量的上限。该函数自动计算箱的数量。它尝试达到指定的箱数量，但如果失败，它将使用更少的箱。

返回值

• 数组 的 元组，格式如下：

• lower — 箱的下界。
• upper — 箱的上界。
• height — 箱的计算高度。

示例

您可以使用 bar 函数可视化直方图，例如：

在这种情况下，您应该记住您不知道直方图箱的边界。

sequenceMatch

检查序列是否包含与模式匹配的事件链。

语法

备注

同时发生在同一秒钟的事件可能会以未定义的顺序出现在序列中，从而影响结果。

参数

• timestamp — 被认为包含时间数据的列。典型的数据类型是 Date 和 DateTime。您还可以使用任何支持的 UInt 数据类型。

• cond1, cond2 — 描述事件链的条件。数据类型：UInt8。您可以传递最多 32 个条件参数。该函数仅考虑在这些条件中描述的事件。如果序列包含未在条件中描述的数据，则该函数会跳过它们。

参数

• pattern — 模式字符串。请参见 模式语法。

返回值

• 如果模式匹配，则返回 1。
• 如果模式不匹配，则返回 0。

类型：UInt8。

模式语法

• (?N) — 匹配位置为 N 的条件参数。条件编号在 [1, 32] 范围内。例如，(?1) 匹配传递给 cond1 参数的参数。

• .* — 匹配任意数量的事件。您无需条件参数来匹配模式的这一元素。

• (?t operator value) — 设置应分隔两个事件的秒数。例如，模式 (?1)(?t>1800)(?2) 匹配在 1800 秒以上发生的事件。任意数量的事件可以位于这两个事件之间。您可以使用 >=，>，<，<=，== 运算符。

示例

考虑 t 表中的数据：

执行查询：

该函数找到编号 2 紧跟编号 1 的事件链。它跳过了它们之间的编号 3，因为该编号未被描述为事件。如果我们想在搜索示例中给定的事件链时考虑这个编号，我们应该为它建立一个条件。

在这种情况下，该函数无法找到与模式匹配的事件链，因为编号 3 的事件发生在 1 和 2 之间。如果在同样的情况下我们检查编号 4 的条件，序列将匹配该模式。

参见

• sequenceCount

sequenceCount

统计匹配模式的事件链数量。该函数搜索不重叠的事件链。在当前链匹配后，它开始搜索下一个链。

备注

同时发生在同一秒钟的事件可能会以未定义的顺序出现在序列中，从而影响结果。

语法

参数

• timestamp — 被认为包含时间数据的列。典型的数据类型是 Date 和 DateTime。您还可以使用任何支持的 UInt 数据类型。

• cond1, cond2 — 描述事件链的条件。数据类型：UInt8。您可以传递最多 32 个条件参数。该函数仅考虑在这些条件中描述的事件。如果序列包含未在条件中描述的数据，则该函数会跳过它们。

参数

• pattern — 模式字符串。请参见 模式语法。

返回值

• 匹配的非重叠事件链的数量。

类型：UInt64。

示例

考虑 t 表中的数据：

统计编号 2 在编号 1 之后、其间有任意数量其他数字出现的次数：

sequenceMatchEvents

返回与模式匹配的最长事件链的事件时间戳。

备注

同时发生在同一秒钟的事件可能会以未定义的顺序出现在序列中，从而影响结果。

语法

参数

• timestamp — 被认为包含时间数据的列。典型的数据类型是 Date 和 DateTime。您还可以使用任何支持的 UInt 数据类型。

• cond1, cond2 — 描述事件链的条件。数据类型：UInt8。您可以传递最多 32 个条件参数。该函数仅考虑在这些条件中描述的事件。如果序列包含未在条件中描述的数据，则该函数会跳过它们。

参数

• pattern — 模式字符串。请参见 模式语法。

返回值

• 匹配条件参数 (?N) 的事件链时间戳数组。数组中的位置与模式中的条件参数位置匹配

类型：数组。

示例

考虑 t 表中的数据：

返回最长链的事件时间戳

参见

• sequenceMatch

windowFunnel

在滑动时间窗口中搜索事件链并计算从链中发生的最大事件数量。

该函数根据算法工作：

• 该函数搜索触发条件链的第一个条件的数据，并将事件计数器设置为 1。这是滑动窗口开始的时刻。

• 如果链中的事件在窗口内连续发生，则计数器增加。如果事件序列被打断，则计数器不增加。

• 如果数据在不同完成点有多个事件链，该函数只会输出最长链的大小。

语法

参数

• timestamp — 包含时间戳的列名称。支持的数据类型有：Date，DateTime 和其他无符号整数类型（注意，即使时间戳支持 UInt64 类型，其值也不能超过 Int64 的最大值，即 2^63 - 1）。
• cond — 描述事件链的条件或数据。 UInt8。

参数

• window — 滑动窗口的长度，即第一个和最后一个条件之间的时间间隔。window 的单位取决于 timestamp 本身并有所不同。使用表达式 timestamp of cond1 <= timestamp of cond2 <= ... <= timestamp of condN <= timestamp of cond1 + window 确定。
• mode — 这是一个可选参数。可以设置一个或多个模式。
  • 'strict_deduplication' — 如果相同的条件在事件序列中成立，则此类重复事件会中断进一步处理。注意：如果多个条件同时成立于同一事件，可能会出现意外情况。
  • 'strict_order' — 不允许其他事件的干预。例如，在 A->B->D->C 的情况下，它在 D 停止寻找 A->B->C，最大事件级别为 2。
  • 'strict_increase' — 仅将条件应用于时间戳严格递增的事件。
  • 'strict_once' — 即使事件多次满足条件，也只在链中计数一次。

返回值

在滑动时间窗口内，链中连续触发的条件的最大数量。 所有选择中的链都进行分析。

类型：整数。

示例

确定一段时间是否足够用户在网上商店选择手机并购买两次。

设置以下事件链：

1. 用户登录到他们的商店帐户 (eventID = 1003)。
2. 用户搜索手机 (eventID = 1007, product = 'phone')。
3. 用户下订单 (eventID = 1009)。
4. 用户再次下单 (eventID = 1010)。

输入表：

查看用户 user_id 在 2019 年 1 月至 2 月期间通过链的进展。

查询：

结果：

retention

该函数接受一组条件作为参数，条件的数量从 1 到 32，类型为 UInt8，指示事件是否满足某个条件。 可以在参数中指定任何条件（如 WHERE）。

除第一个条件外，条件按对应用：如果第一个和第二个条件为真，则第二个的结果为真，如果第一个和第三个为真，则第三个的结果为真，等等。

语法

参数

• cond — 返回 UInt8 结果（1 或 0）的表达式。

返回值

返回 1 或 0 的数组。

• 1 — 事件满足条件。
• 0 — 事件未满足条件。

类型：UInt8。

示例

让我们考虑使用 retention 函数来确定网站流量的示例。

1. 创建一个表来说明示例。

输入表：

查询：

结果：

2. 使用 retention 函数按唯一 ID uid 对用户进行分组。

查询：

结果：

3. 计算每天的网站访问总数。

查询：

结果：

其中：

• r1 - 在 2020-01-01 期间访问网站的唯一访客数量（cond1 条件）。
• r2 - 在 2020-01-01 与 2020-01-02 之间的特定时间段内访问网站的唯一访客数量（cond1 和 cond2 条件）。
• r3 - 在 2020-01-01 和 2020-01-03 之间的特定时间段内访问网站的唯一访客数量（cond1 和 cond3 条件）。

uniqUpTo(N)(x)

计算在指定限制 N 之前的不同参数值的数量。如果不同参数值的数量大于 N，则该函数返回 N + 1，否则计算确切值。

建议与小的 N（最多 10）一起使用。N 的最大值为 100。

对于聚合函数的状态，该函数使用的内存量等于 1 + N 乘以一个值的字节大小。 在处理字符串时，该函数存储一个非加密哈希值为 8 字节；对于字符串的计算是近似的。

例如，如果您有一个表记录每个用户在您网站上所做的搜索查询。表中的每一行代表一个单独的搜索查询，列包括用户 ID、搜索查询和查询的时间戳。您可以使用 uniqUpTo 生成报告，仅显示产生至少 5 个唯一用户的关键字。

uniqUpTo(4)(UserID) 计算每个 SearchPhrase 的唯一 UserID 值的数量，但最多只计数 4 个唯一值。如果某个 SearchPhrase 的唯一 UserID 值超过 4，则该函数返回 5（4 + 1）。然后 HAVING 子句过滤掉唯一 UserID 值少于 5 的 SearchPhrase 值。这将给您提供一个至少被 5 个唯一用户使用的搜索关键字的列表。

sumMapFiltered

该函数的行为与 sumMap 相同，只是它还接受一个用于筛选的键数组作为参数。当处理高基数键时，这尤其有用。

语法

sumMapFiltered(keys_to_keep)(keys, values)

参数

• keys_to_keep: 数组 的键以供筛选。
• keys: 数组 的键。
• values: 数组 的值。

返回值

• 返回一个元组，包括排序后的键数组和对应键的值总和数组。

示例

查询：

结果：

sumMapFilteredWithOverflow

该函数的行为与 sumMap 相同，只是它还接受一个用于筛选的键数组作为参数。当处理高基数键时，这尤其有用。它与 sumMapFiltered 函数的不同之处在于它进行带溢出的求和 - 即，对于求和，它返回与参数数据类型相同的数据类型。

语法

sumMapFilteredWithOverflow(keys_to_keep)(keys, values)

参数

• keys_to_keep: 数组 的键以供筛选。
• keys: 数组 的键。
• values: 数组 的值。

返回值

• 返回一个元组，包括排序后的键数组和对应键的值总和数组。

示例

在此示例中，我们创建一个表 sum_map，插入一些数据，然后使用 sumMapFilteredWithOverflow 和 sumMapFiltered 以及 toTypeName 函数进行比较结果。在创建的表中，requests 的类型为 UInt8，sumMapFiltered 提升了求和值的类型至 UInt64 以避免溢出，而 sumMapFilteredWithOverflow 保持类型为 UInt8，这不足以存储结果 - 即溢出已发生。

查询：

结果：

sequenceNextNode

返回匹配事件链的下一个事件的值。

实验性函数，使用 SET allow_experimental_funnel_functions = 1 启用。

语法

参数

• direction — 用于导航方向。

  • forward — 向前移动。
  • backward — 向后移动。

• base — 用于设置基点。

  • head — 将基点设置为第一个事件。
  • tail — 将基点设置为最后一个事件。
  • first_match — 将基点设置为第一个匹配的 event1。
  • last_match — 将基点设置为最后一个匹配的 event1。

参数

• timestamp — 包含时间戳的列名称。支持的数据类型：Date，DateTime 和其他无符号整数类型。
• event_column — 包含要返回的下一个事件值的列名称。支持的数据类型：String 和 Nullable(String)。
• base_condition — 基点必须满足的条件。
• event1, event2, ... — 描述事件链的条件。 UInt8。

返回值

• event_column[next_index] — 如果模式匹配且存在下一个值。
• NULL — 如果模式不匹配或下一个值不存在。

类型：Nullable(String)。

示例

当事件是 A->B->C->D->E 时，您想知道 B->C 后的事件，即 D。

查询语句搜索 A->B 之后的事件：

结果：

对 forward 和 head 的行为

对 backward 和 tail 的行为

对 forward 和 first_match 的行为

对 backward 和 last_match 的行为

对 base_condition 的行为