SonnetDB

SonnetDB 文档中心

SonnetDB 多模型数据引擎的产品、开发与部署文档总览,覆盖八种数据模型、嵌入式、服务端、Studio、Copilot、ADO.NET、CLI 和批量写入。

SonnetDB 是一款多模型数据引擎。它在一套引擎中提供时序、关系表、KV、JSON 文档、全文检索、向量检索、对象桶和消息队列,并配套 SQL、标准 API、SonnetDB Studio、Copilot 与 MCP 接口。

“八种数据模型,一套引擎”是 SonnetDB 的核心产品口径。它支持嵌入式与服务端部署,可用于本地应用、业务系统、设备与边缘节点、搜索与 AI 应用等不同场景;具体行业和部署方式不构成产品定位限制。

当前版本的持久化方式是数据库目录中的多文件布局,不再以“单文件数据库”作为产品描述。文档中的示例、目录结构和启动方式都以当前仓库代码为准。

嵌入式与服务端

可在进程内打开数据库目录,也可作为 HTTP 服务运行,并通过 SQL 与标准 API 访问。

八种数据模型

支持设备时序、关系表、KV、JSON 文档、全文、向量、Hybrid Search、对象桶和本地消息队列。

AI、Agent 与运维

内置聚合、窗口、预测、PID、地理空间、Copilot、MCP、权限、Token、备份恢复和管理后台。

从哪里开始

如果你要做什么 建议先看
启动 Docker 镜像、完成首次安装、打开后台 开始使用
了解 measurement、tag、field、time 和 series 的关系 数据模型
编写 CREATE/INSERT/SELECT/DELETE 或控制面 SQL SQL 参考
想直接复制一段常用 SQL 模板 SQL Cookbook
使用 SonnetDB Studio 浏览 schema、编辑 SQL、做 staged preview SonnetDB Studio
在 VS Code 中连接 SonnetDB、浏览 schema、执行 SQL 和查看结果 从 Visual Studio Marketplace 安装 SonnetDB 扩展
对比 Web Admin、Studio 桌面、VS Code 的八模型管理能力 管理工具与三面能力矩阵
了解 Copilot 如何辅助 SQL、排障和知识检索 SonnetDB Studio 和 Copilot 技能库
配置 Copilot Provider、模型分组或本地模型 Copilot Provider 与模型目录
构建工业 AI 应用或 Industrial Data Agent 使用 SonnetDB 构建工业 AI 应用
在进程内直接使用引擎 嵌入式与 in-proc API
使用轻量 KV keyspace 存储 metadata 或小对象 KV Keyspace
试用受限 GQL 风格的原生图或关系映射图查询 Graph GQL 风格查询入口
通过 provenance、claim 与 source/chunk 引用构建 GraphRAG 知识图谱与 GraphRAG 合同
使用 JSON 文档集合或从 MongoDB-like 负载迁移 Document Store 能力矩阵 和 迁移指南
使用 SigLIP2 做文搜图或图搜图 语义图片检索 和 可运行工业图片样例
评估 Document Store 推荐规模、恢复时间和内存曲线 Document Store 容量与长稳报告
通过 ADO.NET 访问本地或远程实例 ADO.NET 参考
通过 EF Core DbContext 与现有 .NET 应用集成 EF Core Provider
使用 sndb 命令行工具 CLI 参考
走 Line Protocol、JSON 或批量 VALUES 快路径 批量写入
在 MQTT、Sparkplug B、CoAP、Line Protocol HTTP/UDP 中选择设备接入方式 设备与遥测协议接入
通过工业 MQTT 接入 Sparkplug B 节点与设备 Sparkplug B 接入
接入 Prometheus、OTLP、Grafana 或 Aspire Dashboard 可观测性
定位慢查询、内存、ThreadPool、Flush 或 Compaction 问题 故障排查
了解当前组件关系与存储路径 架构总览 和 文件格式与目录布局
复核最近的性能、可靠性和格式演进 性能与可靠性近期变更
查看发布产物与打包说明 发布与打包

当前产品形态

SonnetDB 现在由这些主线组成:

  1. 多模型核心库 SonnetDB.Core
  2. HTTP 服务端 SonnetDB
  3. ADO.NET 提供程序:NuGet 包 SonnetDB,命名空间 SonnetDB.Data
  4. EF Core Provider:NuGet 包 SonnetDB.EntityFrameworkCore
  5. CLI 工具 SonnetDB.Cli
  6. SonnetDB Studio 与 CopilotDock
  7. C、Go、Rust、Java、Python、VB6、PureBasic 等连接器
  8. SonnetDB for VS Code
  9. 面向 AI / Agent 的 llms.txt、MCP 工具和工业应用文档

这几部分共享同一套底层存储格式和大部分 SQL 行为。服务端额外增加了:

  • 首次安装流程
  • 用户、授权、Token 管理
  • /admin/ 管理界面
  • /help/ 静态帮助中心
  • /v1/events SSE 事件流
  • /healthz 与 /metrics
  • /mcp/{db} 工具入口
  • Copilot 云端桥接、上下文摘要和写入审批

文档约定

  • 示例优先使用当前测试和包说明中已经验证过的写法。
  • 详细示例统一放在具体主题页,首页只保留导航和产品定位。
  • 如果代码行为与常见 TSDB 习惯不同,会在对应页面明确标注当前真实行为。