FlowKit 镜像文档

镜像概述

FlowKit 是一款基于 FlowDB 的 Docker 镜像，专为需要集成合成数据功能的数据库环境设计。该镜像通过可配置卷管理数据持久化，并内置合成数据生成工具，简化了具备模拟数据能力的数据库部署与运维流程，适用于开发、测试及演示场景。

核心功能与特性

1. FlowDB 核心功能集成

• 完整继承 FlowDB 的数据库核心能力，包括数据存储、查询处理及基础管理功能。
• 保持与 FlowDB 原生接口兼容，支持标准数据库操作命令。

2. 可配置卷支持

• 支持自定义数据卷配置，可通过 Docker 卷挂载实现数据持久化与隔离。
• 支持指定数据存储路径、卷大小限制及权限配置，满足不同环境的存储需求。

3. 合成数据生成工具

• 内置合成数据生成模块，可按需生成结构化模拟数据（如用户数据、交易记录等）。
• 支持配置数据量、字段规则及数据分布特征，生成贴近真实场景的模拟数据。

使用场景与适用范围

开发与测试环境

• 快速搭建包含模拟数据的数据库环境，无需依赖真实业务数据。
• 支持动态调整合成数据参数，满足不同测试场景的数据需求。

数据模拟与演示

• 用于产品演示或培训，生成可视化效果良好的模拟数据。
• 支持临时数据环境搭建，避免真实数据泄露风险。

教学与研究

• 作为数据库教学工具，提供带模拟数据的实操环境。
• 支持数据生成规则自定义，用于数据处理算法测试。

使用方法与配置说明

基本部署命令

通过 docker run 快速启动 FlowKit 容器：

docker run -d \
  --name flowkit-instance \
  -p 5432:5432 \  # 假设 FlowDB 默认端口为 5432，需根据实际调整
  -v /host/data/path:/var/lib/flowdb \  # 挂载主机目录作为数据卷
  -e SYNTHETIC_DATA_SIZE=1000 \  # 生成 1000 条合成数据
  -e DB_USER=admin \
  -e DB_PASSWORD=securepass \
  flowkit:latest

配置参数说明

数据卷配置

环境变量配置

合成数据生成配置

通过环境变量或配置文件自定义合成数据规则（示例配置文件 synthetic-config.json）：

{
  "data_type": "transaction",
  "fields": [
    {"name": "id", "type": "uuid"},
    {"name": "amount", "type": "float", "min": 10, "max": 1000},
    {"name": "timestamp", "type": "datetime", "start": "2023-01-01", "end": "2023-12-31"}
  ],
  "row_count": 2000
}

挂载配置文件启动容器：

docker run -d \
  --name flowkit-custom \
  -v /host/config/synthetic-config.json:/etc/flowkit/synthetic-config.json \
  -e SYNTHETIC_CONFIG_PATH=/etc/flowkit/synthetic-config.json \
  flowkit:latest

注意事项

• 合成数据仅用于非生产环境，请勿在生产系统中依赖模拟数据。
• 数据卷挂载时需确保主机目录权限正确，避免容器内权限不足导致启动失败。
• 首次启动时，合成数据生成可能需要数秒至数分钟（取决于数据量），可通过容器日志查看进度。