カスタムMixタスクでEcto経由でデータベースを操作する(Elixir)

はじめに

• カスタムMixタスクでEcto経由でデータベースを操作したいです
  • Mix.Taskは独自に作れるんです
• 私は前提知識として、lib/mix/tasks/hoge.exつくれば、mix hogeで実行できるタスクを実装できるのですよね〜 というところまでは知っていました
• 今回はそのタスクの中でEcto経由でデータベースを操作することをしてみたときに、エラーに遭遇しまして、解決策がわかりましたのでその記録を残しておきます
  • Phoenixタグをつけるかどうかは迷ったのですが、まあPhoenixアプリを作っているときに遭遇したのでつけておきました

カスタムMixタスク

lib/mix/tasks/db_all_delete.ex

defmodule Mix.Tasks.DbAllDelete do
  use Mix.Task

  def run(_) do
    Mix.Task.run "app.start", []

    Demo.Repo.delete_all(Demo.Accounts.User)
  end
end

• Mix.Task.run "app.start", []の呼び出しが必要になります
• Gigalixirにデプロイしている場合には、gigalixir run mix db_all_deleteなんて感じで実行できます

Mix.Task.run "app.start", []の呼び出しがない場合

$ mix db_all_delete                                                                                                                     
Compiling 1 file (.ex)
** (RuntimeError) could not lookup Ecto repo Demo.Repo because it was not started or it does not exist
    lib/ecto/repo/registry.ex:19: Ecto.Repo.Registry.lookup/1
    lib/ecto/repo/queryable.ex:210: Ecto.Repo.Queryable.execute/4
    lib/mix/tasks/db_all_delete.ex:7: Mix.Tasks.DbAllDelete.run/1
    (mix 1.10.4) lib/mix/task.ex:330: Mix.Task.run_task/3
    (mix 1.10.4) lib/mix/cli.ex:82: Mix.CLI.run_task/2
    (elixir 1.10.4) lib/code.ex:926: Code.require_file/2

• Ecto repoが始まっていないだなんだ言われています

参考記事

• 詳しくはこれらの記事をご参照ください
• How to get data from Ecto in a custom mix task
• カスタムMixタスク#アプリケーションの読み込み
  • ありがとうございます！

Wrapping Up

• カスタムMixタスクについては、リンク先が詳しいです
  • Mix.Task
• Enjoy Elixir !!!