Functions which can be called in an Ecto migration for Beacon installation and upgrades.

Usage

To install Beacon, you'll need to generate an Ecto.Migration that wraps calls to Beacon.Migration:

$ mix ecto.gen.migration create_beacon_tables

Open the generated migration in your editor and either call or delegate to up/1 and down/1:

defmodule MyApp.Repo.Migrations.CreateBeaconTables do
  use Ecto.Migration
  def up, do: Beacon.Migration.up()
  def down, do: Beacon.Migration.down()
end

Then, run the migrations for your app to create the necessary Beacon tables in your database:

$ mix ecto.migrate

By calling up() with no arguments, this will execute all migration steps from the initial version to the latest version. As new versions are released, you may need to repeat this process, by first generating a new migration:

$ mix ecto.gen.migration upgrade_beacon_tables_to_v2

Then in the generated migration, you could simply call up() again, because the migrations are idempotent, but you can be safer and more efficient by specifying the migration version to execute:

 defmodule MyApp.Repo.Migrations.UpgradeBeaconTables do
  use Ecto.Migration
  def up, do: Beacon.Migration.up(version: 2)
  def down, do: Beacon.Migration.down(version: 2)
end

Now this migration will update to v2, but if rolled back, will only roll back the v2 changes, leaving v1 tables in-place.

To see this step within the larger context of installing Beacon, check out the your first site guide.