graze/sprout

Sprout

镜像概述和主要用途

Sprout 是一款数据库数据管理工具，主要用于帮助开发者在开发环境中进行数据库数据的转储（Dump）、截断（Truncate）和种子数据填充（Seed）。通过该工具，用户可以便捷地从本地文件导入种子数据、将数据库表数据导出备份、并行处理数据操作，并支持多组种子数据管理，满足不同场景下的开发数据需求。

核心功能和特性

• 种子数据导入：支持从本地文件导入 SQL 格式的种子数据
• 数据转储：可将 MySQL 数据库表数据导出为文件
• 并行操作：支持并行执行数据处理任务，提升效率
• 多组数据管理：支持对不同分组（如 static、core、testing）的种子数据进行管理
• 灵活配置：可通过配置文件自定义数据路径、连接信息等参数

使用场景和适用范围

• 开发环境数据库初始化：快速导入基础静态数据（如国家、地区信息）
• 测试数据准备：为不同测试场景准备特定分组的测试数据
• 数据备份与迁移：将重要表数据导出为文件，便于版本控制和团队共享
• 多环境数据同步：在开发、测试环境间同步必要的基础数据

使用方法和配置说明

安装（Docker方式）

bash
docker run -v [本地目录挂载] --rm graze/sprout [命令]

说明：需将本地种子数据目录或配置文件目录挂载到容器中，以便工具访问。

文件结构

默认文件结构如下，可通过配置文件修改根路径及各分组路径：

text
- /seed
  - group1
    - schema1
      - table1.sql
      - table2.sql
    - schema2
      - table3.sql
  - group2
    - schema3
      - table4.sql

• group：数据分组（如 static、core）
• schema：数据库模式/库名
• table.sql：对应表的种子数据文件

快速开始

bash
# 1. 转储指定表数据到文件
docker run -v $(pwd)/seed:/seed -v $(pwd)/config:/config --rm graze/sprout dump --config=/config/sprout.yml --group=static a_schema:table_1,table_2

# 2. 将种子数据纳入版本控制
git add seed/static/*

# 3. 从本地文件种子数据到数据库
docker run -v $(pwd)/seed:/seed -v $(pwd)/config:/config --rm graze/sprout seed --config=/config/sprout.yml --group=static

命令详解

种子数据填充（seed）

bash
# 基本语法
sprout seed [--config=<配置文件路径>] [--group=<分组名>] [--no-chop|--chop-all] [<schema>[:<table>,...]] ...

# 示例
# 填充指定模式的所有表（默认截断表）
docker run -v ... graze/sprout seed --config=/config/sprout.yml the_schema

# 填充指定模式的所有表（不截断表）
docker run -v ... graze/sprout seed --config=/config/sprout.yml --no-chop the_schema

# 填充指定模式的特定表
docker run -v ... graze/sprout seed --config=/config/sprout.yml the_schema:country

# 填充指定分组的所有数据
docker run -v ... graze/sprout seed --config=/config/sprout.yml --group=core

• --no-chop：填充前不截断表
• --chop-all：填充前截断所有相关表

数据截断（chop）

bash
# 基本语法
sprout chop [--config=<配置文件路径>] [--group=<分组名>] [--all] [<schema>[:<table>,...]] ...

# 示例
# 截断指定模式的所有表
docker run -v ... graze/sprout chop --config=/config/sprout.yml the_schema

# 截断指定模式的特定表
docker run -v ... graze/sprout chop --config=/config/sprout.yml the_schema:country

# 截断指定分组的所有表
docker run -v ... graze/sprout chop --config=/config/sprout.yml --group=core --all

• --all：截断所有相关表

数据转储（dump）

bash
# 基本语法
sprout dump [--config=<配置文件路径>] [--group=<分组名>] [<schema>[:<table>,...]] ...

# 示例
# 转储指定模式的所有表数据
docker run -v ... graze/sprout dump --config=/config/sprout.yml the_schema

# 转储指定模式的特定表数据
docker run -v ... graze/sprout dump --config=/config/sprout.yml the_schema:country

# 转储指定分组的所有数据
docker run -v ... graze/sprout dump --config=/config/sprout.yml --group=core

配置说明

默认配置文件路径为 config/sprout.yml，可通过 --config 参数指定自定义路径。配置文件结构如下：

yaml
defaults:
  group: core  # 默认分组
  path: /seed  # 种子数据根路径
  simultaneousProcesses: 10  # 并行进程数（默认10）

groups:
  core:  # 分组配置
    path: /custom/path/to/group  # 自定义分组路径

schemas:
  <schema_name>:  # 模式名称（用于命令中引用）
    schema: 'actual_schema_name'  # 数据库中实际模式名（可选，默认使用<schema_name>）
    connection:  # 数据库连接信息
      user: 'username'  # 用户名
      password: 'password'  # 密码
      driver: 'mysql'  # 数据库驱动（当前仅支持mysql）
      dbName: 'database_name'  # 数据库名（可选）
      host: 'db'  # 数据库主机
      port: 3306  # 端口（默认3306，可选）