📋 概述
本文档详细说明 Core API V1 数据库中各表的字段定义、允许的选项(枚举值)以及入库时的填写规范。1. 信号表 (signals)
存储从分析层接收到的原始信号数据。
🟢 信号状态选项 (status)
2. 待投递表 (outbox)
存储待发送到下游服务(如 Ghost, Rocket.Chat)的任务。
🔵 投递状态选项 (status)
3. 管道日志表 (pipeline_log)
用于追踪信号在系统内部流转的审计日志。
4. API 密钥表 (api_keys)
管理访问权限和使用统计。
💡 入库填写指南
1. 如何确保“命中”选项?
在进行数据库入库(通过 API 或 SQL)时,请遵循以下规则:- 大小写敏感:所有选项必须使用 小写 英文字母(例如:填写
high而不是High)。 - 严格匹配:不能包含空格或特殊字符。
- Pydantic 校验:如果你使用 Python SDK 或直接调用 API,系统会通过 Pydantic 模型进行预校验。如果值不匹配,会直接返回
422 Unprocessable Entity。
2. 必填项示例 (JSON)
当你作为分析层向 Core API 发送数据时,最关键的“命中”字段是priority:
3. 数据库层面的保护
即使绕过了 API 校验,数据库层面也设置了CheckConstraint。
如果尝试插入非法值,PostgreSQL 会抛出约束错误:
violates check constraint "check_priority"