Getting Started

快速开始

Wiki 首页 · 正式文档

sqlseed 根据已有数据库表结构生成测试数据。准备好 Python 3.10+ 和虚拟环境后，按需要选择一个入口；入口包会自动安装 Core，无需全部安装。

使用方式	安装命令
Python API	python -m pip install sqlseed
命令行	python -m pip install sqlseed-cli
浏览器工作台	python -m pip install sqlseed-web

先准备一个数据库

第一次使用，直接运行 README 的完整 SQLite 示例。它会创建 demo.db 和 users 表，再生成 100 个用户，不需要克隆仓库或配置 API key。

下面的 Python 和 CLI 命令都假设这份数据库与表已经存在，并且当前目录包含 demo.db。sqlseed 负责向已有表生成数据，不代替建表工具。

Python

import sqlseed

result = sqlseed.fill(
    "demo.db", table="users", count=100, provider="faker", seed=42
)
print(result.count, result.errors)

该调用追加数据。count 是实际写入数；同时检查 errors，因为后续批次失败时，前面已提交的批次可能保留。完整参数见 Python API 参考。

CLI

sqlseed inspect demo.db --table users --show-mapping
sqlseed preview demo.db -t users -n 5 --provider faker
sqlseed fill demo.db -t users -n 100 --provider faker --no-ai

先查看结构和样例，再执行生成。preview 不写入数据库。配置文件、快照和重放见 CLI 参考。

Web

sqlseed-web

打开 http://127.0.0.1:8630，连接已有数据库，选择表、编辑规则、预览，再生成数据。此命令随安装包提供，无需自定义启动脚本；未安装 AI 时仍可手动操作。具体连接方式见 Web 工作台指南。

下一步

• 用 YAML 配置保存和复用规则。
• PostgreSQL 需要 sqlseed[postgres]，连接及支持边界见 用户指南与支持范围。
• 遇到安装或复现问题，先看 FAQ；其余入口见文档导航。