Seed Dump 技术文档

2024-12-20 15:32:16作者：羿妍玫Ivan

本文档将详细介绍如何安装和使用 Seed Dump 插件，该插件为 Rails 4 和 5 提供了一个名为 db:seed:dump 的 rake 任务。它允许您从数据库中现有的数据创建种子数据文件。

1. 安装指南

要安装 Seed Dump，您可以将它添加到您的 Gemfile 中：

gem 'seed_dump'

或者手动安装：

$ gem install seed_dump

2. 项目的使用说明

Seed Dump 可以通过两种方式使用：rake 任务和 Rails 控制台。

Rake 任务

以下是一些使用 rake 任务的基本示例：

将所有数据直接转储到 db/seeds.rb：

$ rake db:seed:dump

仅转储 users 表中的数据，且最多转储一条记录：

$ rake db:seed:dump MODELS=User LIMIT=1

将数据追加到 db/seeds.rb 而不是覆盖它：

$ rake db:seed:dump APPEND=true

使用另一个输出文件而不是 db/seeds.rb：

$ rake db:seed:dump FILE=db/seeds/users.rb

从转储中排除 name 和 age：

$ rake db:seed:dump EXCLUDE=name,age

控制台

以下是一些使用 Rails 控制台的基本示例：

输出所有 User 记录的转储：

puts SeedDump.dump(User)

将转储写入文件：

SeedDump.dump(User, file: 'db/seeds.rb')

将转储追加到文件：

SeedDump.dump(User, file: 'db/seeds.rb', append: true)

从转储中排除 name 和 age：

SeedDump.dump(User, exclude: [:name, :age])

在任何情况下，ActiveRecord 行的关系可以被转储（但不能转储单个对象）。

3. 项目API使用文档

Seed Dump 提供了以下选项，这些选项适用于 rake 任务和控制台，除非另有说明：

append: 如果设置为 true，将数据追加到文件而不是覆盖它。默认：false。
batch_size: 控制一次写入文件记录的数量。默认：1000。如果转储时内存不足，尝试减少这个值。如果转储速度太慢，尝试增加这个值。
exclude: 从转储中排除的属性。对于 rake 任务，传递逗号分隔的列表（例如 name,age），对于控制台，传递数组（例如 [:name, :age]）。默认：[:id, :created_at, :updated_at]。
file: 写入指定的输出文件。Rake 任务默认为 db/seeds.rb。控制台默认返回字符串。
import: 如果设置为 true，输出将采用 activerecord-import gem 需要的格式，而不是默认格式。默认：false。
limit: 不超过此数量的数据。默认：无限制。仅在 rake 任务中使用。在控制台中，只需传递具有适当限制的 ActiveRecord::Relation（例如 SeedDump.dump(User.limit(5))）。
conditions: 只转储特定的记录。在控制台中，只需传递具有适当条件的 ActiveRecord::Relation（例如 SeedDump.dump(User.where(state: :active))）。
model[s]: 限制转储到指定的模型列表。默认：所有模型。如果您使用的是 Rails 引擎，可以通过传递 "EngineName::ModelName" 来转储特定的模型。仅在 rake 任务中使用。例如：rake db:seed:dump MODELS="User, Position, Function"。
models_exclude: 从转储中排除指定的模型列表。默认：不排除任何模型。仅在 rake 任务中使用。例如：rake db:seed:dump MODELS_EXCLUDE="User"。