跳至主要内容

可执行和 ExecutablePool 表引擎

ExecutableExecutablePool 表引擎允许您定义一个表,其行从您定义的脚本生成(通过写入 **stdout**)。可执行脚本存储在 users_scripts 目录中,可以从任何来源读取数据。

  • Executable 表:脚本在每次查询时运行
  • ExecutablePool 表:维护一个持久进程池,并从池中获取进程以进行读取

您还可以选择包含一个或多个输入查询,这些查询将其结果流式传输到 **stdin** 以供脚本读取。

创建可执行表

Executable 表引擎需要两个参数:脚本名称和传入数据的格式。您可以选择传入一个或多个输入查询

Executable(script_name, format, [input_query...])

以下是 Executable 表的相关设置

  • send_chunk_header
    • 描述:在发送数据块进行处理之前,发送每个数据块中的行数。此设置可以帮助您以更有效的方式编写脚本,以预分配一些资源
    • 默认值:false
  • command_termination_timeout
    • 描述:命令终止超时时间(以秒为单位)
    • 默认值:10
  • command_read_timeout
    • 描述:从命令 stdout 读取数据的超时时间(以毫秒为单位)
    • 默认值:10000
  • command_write_timeout
    • 描述:将数据写入命令 stdin 的超时时间(以毫秒为单位)
    • 默认值:10000

让我们看一个例子。以下 Python 脚本名为 my_script.py,并保存到 user_scripts 文件夹中。它读取一个数字 i,并打印 i 个随机字符串,每个字符串前面都带有用制表符分隔的数字

#!/usr/bin/python3

import sys
import string
import random

def main():

# Read input value
for number in sys.stdin:
i = int(number)

# Generate some random rows
for id in range(0, i):
letters = string.ascii_letters
random_string = ''.join(random.choices(letters ,k=10))
print(str(id) + '\t' + random_string + '\n', end='')

# Flush results to stdout
sys.stdout.flush()

if __name__ == "__main__":
main()

以下 my_executable_table 是从 my_script.py 的输出构建的,它将在每次运行来自 my_executable_tableSELECT 时生成 10 个随机字符串

CREATE TABLE my_executable_table (
x UInt32,
y String
)
ENGINE = Executable('my_script.py', TabSeparated, (SELECT 10))

创建表立即返回,不会调用脚本。查询 my_executable_table 会导致脚本被调用

SELECT * FROM my_executable_table
┌─x─┬─y──────────┐
│ 0 │ BsnKBsNGNH │
│ 1 │ mgHfBCUrWM │
│ 2 │ iDQAVhlygr │
│ 3 │ uNGwDuXyCk │
│ 4 │ GcFdQWvoLB │
│ 5 │ UkciuuOTVO │
│ 6 │ HoKeCdHkbs │
│ 7 │ xRvySxqAcR │
│ 8 │ LKbXPHpyDI │
│ 9 │ zxogHTzEVV │
└───┴────────────┘

将查询结果传递给脚本

Hacker News 网站的用户会留下评论。Python 包含一个自然语言处理工具包 (nltk),其中包含一个 SentimentIntensityAnalyzer,用于确定评论是积极、消极还是中立——包括分配一个介于 -1(非常消极的评论)和 1(非常积极的评论)之间的值。让我们创建一个 Executable 表,使用 nltk 计算 Hacker News 评论的情感。

此示例使用 此处 所述的 hackernews 表。hackernews 表包含一个类型为 UInt64id 列和一个名为 commentString 列。让我们从定义 Executable 表开始

CREATE TABLE sentiment (
id UInt64,
sentiment Float32
)
ENGINE = Executable(
'sentiment.py',
TabSeparated,
(SELECT id, comment FROM hackernews WHERE id > 0 AND comment != '' LIMIT 20)
);

关于 sentiment 表的一些评论

  • 文件 sentiment.py 保存到 user_scripts 文件夹(user_scripts_path 设置的默认文件夹)
  • TabSeparated 格式意味着我们的 Python 脚本需要生成包含用制表符分隔的值的原始数据行
  • 该查询从 hackernews 中选择两列。Python 脚本将需要从传入的行中解析出这些列值

以下是 sentiment.py 的定义

#!/usr/local/bin/python3.9

import sys
import nltk
from nltk.sentiment import SentimentIntensityAnalyzer

def main():
sentiment_analyzer = SentimentIntensityAnalyzer()

while True:
try:
row = sys.stdin.readline()
if row == '':
break

split_line = row.split("\t")

id = str(split_line[0])
comment = split_line[1]

score = sentiment_analyzer.polarity_scores(comment)['compound']
print(id + '\t' + str(score) + '\n', end='')
sys.stdout.flush()
except BaseException as x:
break

if __name__ == "__main__":
main()

关于我们的 Python 脚本的一些评论

  • 要使此功能正常工作,您需要运行 nltk.downloader.download('vader_lexicon')。这可以放在脚本中,但这会导致它在每次对 sentiment 表执行查询时都被下载——这效率不高
  • row 的每个值都将是 SELECT id, comment FROM hackernews WHERE id > 0 AND comment != '' LIMIT 20 结果集中的一个行
  • 传入的行是用制表符分隔的,因此我们使用 Python split 函数解析出 idcomment
  • polarity_scores 的结果是一个包含许多值的 JSON 对象。我们决定只获取此 JSON 对象的 compound
  • 回想一下,ClickHouse 中的 sentiment 表使用 TabSeparated 格式,并包含两列,因此我们的 print 函数用制表符分隔这两列

每次编写从 sentiment 表中选择行的查询时,SELECT id, comment FROM hackernews WHERE id > 0 AND comment != '' LIMIT 20 查询都会被执行,结果将被传递给 sentiment.py。让我们试一下

SELECT *
FROM sentiment

响应看起来像

┌───────id─┬─sentiment─┐
│ 7398199 │ 0.4404 │
│ 21640317 │ 0.1779 │
│ 21462000 │ 0 │
│ 25168863 │ 0 │
│ 25168978 │ -0.1531 │
│ 25169359 │ 0 │
│ 25169394 │ -0.9231 │
│ 25169766 │ 0.4137 │
│ 25172570 │ 0.7469 │
│ 25173687 │ 0.6249 │
│ 28291534 │ 0 │
│ 28291669 │ -0.4767 │
│ 28291731 │ 0 │
│ 28291949 │ -0.4767 │
│ 28292004 │ 0.3612 │
│ 28292050 │ -0.296 │
│ 28292322 │ 0 │
│ 28295172 │ 0.7717 │
│ 28295288 │ 0.4404 │
│ 21465723 │ -0.6956 │
└──────────┴───────────┘

创建 ExecutablePool 表

ExecutablePool 的语法类似于 Executable,但有一些特定于 ExecutablePool 表的相关设置

  • pool_size
    • 描述:进程池大小。如果大小为 0,则没有大小限制
    • 默认值:16
  • max_command_execution_time
    • 描述:最大命令执行时间(以秒为单位)
    • 默认值:10

我们可以轻松地将上面的 sentiment 表转换为使用 ExecutablePool 而不是 Executable

CREATE TABLE sentiment_pooled (
id UInt64,
sentiment Float32
)
ENGINE = ExecutablePool(
'sentiment.py',
TabSeparated,
(SELECT id, comment FROM hackernews WHERE id > 0 AND comment != '' LIMIT 20000)
)
SETTINGS
pool_size = 4;

当您的客户端查询 sentiment_pooled 表时,ClickHouse 将按需维护 4 个进程。