插件库

浏览 InfluxDB 3 Core 的插件。使用这些插件可以通过在写入事件、计划或 HTTP 请求上运行的自定义 Python 代码来扩展数据库功能。

要求

所有插件都需要

• InfluxDB 3 Core 或已启用处理引擎的 InfluxDB 3 Enterprise
• Python 环境（由 InfluxDB 3 自动管理）
• 适当的触发器配置

插件元数据

此库中的插件包含一个位于 docstring 头部的 JSON 元数据模式，该模式定义了支持的触发器类型和配置参数。此元数据使

• InfluxDB 3 Explorer UI 能够显示和配置插件
• 对存储库中插件的自动化测试和验证

使用 TOML 配置文件

此库中的许多插件都支持使用 TOML 配置文件来指定所有插件参数。这对于复杂的配置或您希望对插件设置进行版本控制很有用。

重要要求

要使用 TOML 配置文件，您必须在 InfluxDB 3 Core 主机环境中设置 PLUGIN_DIR 环境变量。 在启动 InfluxDB 3 Core 时，除了 --plugin-dir 标志外，还需要此设置。

• --plugin-dir 告诉 InfluxDB 3 Core 在何处查找插件 Python 文件
• PLUGIN_DIR 环境变量告诉插件在何处查找 TOML 配置文件

设置 TOML 配置

1. 设置 PLUGIN_DIR 环境变量以启动 InfluxDB 3 Core:

   PLUGIN_DIR=~/.plugins influxdb3 serve --node-id node0 --object-store file --data-dir ~/.influxdb3 --plugin-dir ~/.plugins

2. 将 TOML 配置文件复制或创建到您的插件目录中:

   # Example: copy a plugin's configuration template
   cp plugin_config_example.toml ~/.plugins/my_config.toml

3. 编辑 TOML 文件以满足您的要求。TOML 文件应包含插件参数模式中定义的所有参数。

4. 使用 config_file_path 参数创建触发器：创建触发器时，请指定 config_file_path 参数以指向您的 TOML 配置文件。

   • 仅指定文件名（而不是完整路径）
   • 文件必须位于 PLUGIN_DIR 下

   influxdb3 create trigger \
     --database mydb \
     --plugin-filename plugin_name.py \
     --trigger-spec "every:1d" \
     --trigger-arguments config_file_path=my_config.toml \
     my_trigger_name

有关使用 TOML 配置文件的更多信息，请参阅项目的 README。