SampleDB

SampleDB 是一个用于展示示例数据与场景的项目。其核心目标是助力用户快速掌握 KWDB 数据库的使用方法，为用户提供便捷的测试与学习环境。

快速体验

如果你想按当前环境快速体验 SampleDB 示例，可以直接使用 sampledb-quickstart skill。它会先检查环境，再根据你当前是容器部署还是本机部署来准备 KWDB，然后让你逐步选择示例和查询方式，并在每一步开始前解释它在做什么。

在支持 skill 的环境中，可以直接这样发起：

帮助我根据当前环境快速体验 SampleDB 示例，并解释每一步做了什么。

或者更简单一点：

运行本示例项目。

这个 skill 会：

• 先检查当前项目环境和是否已有 KWDB 在运行
• 在确认后启动或复用合适的 KWDB
• 让你选择要体验的示例，不会默认跳到某个示例
• 在查询步骤中提供“执行完整 query.sh”或“只执行一个查询示例”的选择
• 在你输入 stop 时清理本次创建的 kwbase-data 临时目录

skill 在本仓库中同时提供给 Codex 和 Claude 使用。如果您使用其他 AI Agent，可以直接将 .agents/skills/sampledb-quickstart 复制到对应 AI Agent 的 Skill 目录中。

示例一：智能电表模型

• 表结构设计
• 导入数据
• 准备数据
  • 关系库 rdb
  • 时序库 tsdb
  • 时序数据生成语句
• 场景示例
  • 查询区域用电量TOP10
  • 查询故障电表及用户信息
  • 电表概要查询
  • 告警检测查询
  • 区域用电量统计
  • 查询指定电表最近24小时用电趋势量
  • 分时负荷统计
  • 用电会话分析
  • 电压状态持续分析
  • 异常电流事件识别
  • 滑动采样趋势分析

智能电表示例也支持脚本化体验：

cd smart-meter
bash smart_meter_test.sh --container <kwdb_container_name>

同时，还提供了一个基于 KWDB 多模数据库的智能电表数据管理和可视化演示系统。推荐使用 docker 进行试用：

# 运行容器
docker run -d --name smart-meter \
  -p 3001:3001 \
  kwdb/smart-meter:latest

# 访问应用
# 统一访问地址: http://localhost:3001

KWDB 提供了多种容器镜像下载渠道，用户可以根据当前网络环境选择合适的镜像。

• 官方仓库：kwdb/smart-meter
• 国内镜像：registry.cn-hangzhou.aliyuncs.com/kwdb/smart-meter
• Github 容器镜像：ghcr.io/kwdb/smart-meter

示例二：跨模查询

跨模式查询（Multi-Mode Query）是指在一个查询语句中同时从多个数据库模式（如关系型数据库、时序数据库等）中获取数据，并对这些数据进行联合分析。本示例为物联网场景跨模查询，展示关系数据与时序数据的联合分析能力：

技术亮点

• 跨模统计信息和代价估算融合技术
• 跨模聚合下推技术
• 高速跨模连接算子技术

文件清单

multi-mode/
    ├── start_service.sh   # 启动数据库单机服务脚本
    ├── generate_data.sh   # 数据生成脚本，
    ├── create_load.sh     # 创建数据库，创建表以及导入数据的脚本 
    ├── create_load.sql    # 创建数据库，创建表以及导入数据的SQL命令
    ├── query.sh           # 跨模查询的脚本
    ├── query.sql          # 跨模查询的SQL命令
    ├── kwdb_common.sh     # 本机与容器模式公共函数
    ├── multi_test.sh      # 一键测试的脚本
    └── README.md          # 跨模查询测试介绍文档

快速体验

1. 执行 generate_data.sh 脚本，生成时序表数据以及关系表数据
2. 执行 create-load.sh 脚本，创建数据库、时序表、关系表，并将数据导入表中
3. 执行 query.sh 脚本，体验跨模查询
4. （可选）执行 multi_test.sh 脚本，一键体验

容器部署的 KWDB 可直接使用容器模式：

cd multi-mode
bash multi_test.sh --container <kwdb_container_name>

详细操作指南请参考跨模查询文档

示例三：窗口函数

窗口函数示例展示 KWDB 对分组窗口查询的支持能力，覆盖 COUNT_WINDOW、EVENT_WINDOW、SESSION_WINDOW、STATE_WINDOW 和 TIME_WINDOW 五类典型窗口模型。

文件清单

window/
    ├── start_service.sh   # 启动数据库单机服务脚本
    ├── generate_data.sh   # 生成窗口函数示例数据
    ├── create_load.sh     # 建库建表并导入数据
    ├── create_load.sql    # 建库建表与导入数据 SQL
    ├── query.sh           # 执行窗口函数示例查询
    ├── query.sql          # 窗口函数示例 SQL
    ├── kwdb_common.sh     # 本机与容器模式公共函数
    ├── window_test.sh     # 一键体验脚本
    └── README.md          # 窗口函数示例说明文档

快速体验

1. 执行 window/start_service.sh 启动数据库
2. 执行 window/generate_data.sh 生成示例数据
3. 执行 window/create_load.sh 建表并导入数据
4. 执行 window/query.sh 体验窗口函数查询
5. 或直接执行 window/window_test.sh 一键体验

容器部署的 KWDB 可直接使用容器模式：

cd window
bash window_test.sh --container <kwdb_container_name>

详细操作指南请参考窗口函数文档

示例四：聚合函数

聚合函数示例展示 KWDB 对聚合函数查询的支持能力，覆盖 COUNT、AVG、SUM、MIN 、MAX、STDDEV、FIRST、LAST、TWA和 TIME_BUCKET 多种典型聚合函数模型。

文件清单

aggregate/
    ├── start_service.sh   # 启动数据库单机服务脚本
    ├── generate_data.sh   # 生成聚合函数示例数据
    ├── create_load.sh     # 建库建表并导入数据
    ├── create_load.sql    # 建库建表与导入数据 SQL
    ├── query.sh           # 执行聚合函数示例查询
    ├── query.sql          # 聚合函数示例 SQL
    ├── kwdb_common.sh     # 本机与容器模式公共函数
    ├── aggregate_test.sh  # 一键体验脚本
    └── README.md          # 聚合函数示例说明文档

快速体验

1. 执行 aggregate/start_service.sh 启动数据库
2. 执行 aggregate/generate_data.sh 生成示例数据
3. 执行 aggregate/create_load.sh 建表并导入数据
4. 执行 aggregate/query.sh 体验聚合函数查询
5. 或直接执行 aggregate/aggregate_test.sh 一键体验

容器部署的 KWDB 可直接使用容器模式：

cd aggregate
bash aggregate_test.sh --container <kwdb_container_name>

详细操作指南请参考聚合函数文档

贡献

我们欢迎任何形式的贡献！请随时提交 Issue 或 PR。

许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE 文件。