Drill behaviour (drill v0.1.1)
Drill is an elixir seeder library inspired by Seed Fu and Phinx.
usage
Usage
- Create your seeder modules. The directory where the seeder modules are located
does not matter as long as it has
use Drill, ...
.
In my_app/lib/seeds/user.ex
:
defmodule MyApp.Seeds.User do
use Drill, key: :users, source: MyApp.Accounts.User
def run(_context) do
[
%{
email: "user1@example.com",
first_name: "John",
last_name: "Smith"
},
...
]
end
end
In my_app/lib/seeds/post.ex
:
defmodule MyApp.Seeds.Post do
use Drill, key: :posts, source: MyApp.Blogs.Post
def deps do
[MyApp.Seeds.User]
end
def run(%Drill.Context{seeds: %{users: [user1, user2, user3 | _]}}) do
[
%{
content: Lorem.paragraph(),
user_id: user1.id
},
...
]
end
end
Configure drill by adding the name of your application. This will let drill know which application contains the seeder modules. In
my_app/config/config.exs
:config :drill, :otp_app, :my_app
Run
mix drill --r MyApp.Repo
in the terminal with your project root as the current working directory
installation
Installation
This project is not yet published on Hex so for the meantime you can add it to the list of dependencies in mix.exs as a github path:
def deps do
[
{:drill, git: "git@github.com:dgigafox/drill.git"}
]
end
use-drill-options
use Drill
options
source
- source is the schema modulekey
- once the seeder module runs, the inserted result will be saved to%Drill.Context{}.seeds[key]
. Drill.Context struct is passed to one of Drill's callback which isrun/1
to be discussed in theCallback
section below.
callbacks
Callbacks
constraints/0
(optional) - returns a list of column names to verify for conflicts. If a conflict occurs all fields will just be updated. This prevents insertion of new records based on the constraints when drill is run again.deps/0
(optional) - returns a list of seeder modules that should be run prior to the current seederrun/1
(required) - returns a list of maps which keys are fields of the:source
schema. Autogenerated fields such as:inserted_at
or:updated_at
may not be defined. The first argument is theDrill.Context
struct, which you can use to get the inserted records from previously run seeder modules (see Usage section above).
Link to this section Summary
Link to this section Callbacks
Link to this callback
constraints()
@callback constraints() :: [atom()]
Link to this callback
deps()
@callback deps() :: [atom()]
Link to this callback
run(t)
@callback run(Drill.Context.t()) :: [map()]