defmodule Mix.Tasks.Ecto.Dump do
use Mix.Task
import Mix.Ecto
import Mix.EctoSQL
@shortdoc "Dumps the repository database structure"
@default_opts [quiet: false]
@aliases [
d: :dump_path,
q: :quiet,
r: :repo
]
@switches [
dump_path: :string,
quiet: :boolean,
repo: [:string, :keep],
no_compile: :boolean,
no_deps_check: :boolean
]
@moduledoc """
Dumps the current environment's database structure for the
given repository into a structure file.
The repository must be set under `:ecto_repos` in the
current app configuration or given via the `-r` option.
This task needs some shell utility to be present on the machine
running the task.
Database | Utility needed
:--------- | :-------------
PostgreSQL | pg_dump
MySQL | mysqldump
## Example
$ mix ecto.dump
## Command line options
* `-r`, `--repo` - the repo to load the structure info from
* `-d`, `--dump-path` - the path of the dump file to create
* `-q`, `--quiet` - run the command quietly
* `--no-compile` - does not compile applications before dumping
* `--no-deps-check` - does not check dependencies before dumping
"""
@impl true
def run(args) do
{opts, _} = OptionParser.parse! args, strict: @switches, aliases: @aliases
opts = Keyword.merge(@default_opts, opts)
Enum.each parse_repo(args), fn repo ->
ensure_repo(repo, args)
ensure_implements(repo.__adapter__(), Ecto.Adapter.Structure,
"dump structure for #{inspect repo}")
migration_repo = repo.config()[:migration_repo] || repo
for repo <- Enum.uniq([repo, migration_repo]) do
config = Keyword.merge(repo.config(), opts)
case repo.__adapter__().structure_dump(source_repo_priv(repo), config) do
{:ok, location} ->
unless opts[:quiet] do
Mix.shell().info "The structure for #{inspect repo} has been dumped to #{location}"
end
{:error, term} when is_binary(term) ->
Mix.raise "The structure for #{inspect repo} couldn't be dumped: #{term}"
{:error, term} ->
Mix.raise "The structure for #{inspect repo} couldn't be dumped: #{inspect term}"
end
end
end
end
end