Oban.Migrations (Oban v2.10.1) View Source
Migrations create and modify the database tables Oban needs to function.
Usage
To use migrations in your application you'll need to generate an Ecto.Migration
that wraps
calls to Oban.Migrations
:
mix ecto.gen.migration add_oban
Open the generated migration in your editor and call the up
and down
functions on
Oban.Migrations
:
defmodule MyApp.Repo.Migrations.AddOban do
use Ecto.Migration
def up, do: Oban.Migrations.up()
def down, do: Oban.Migrations.down()
end
This will run all of Oban's versioned migrations for your database. Migrations between versions are idempotent. As new versions are released you may need to run additional migrations.
Now, run the migration to create the table:
mix ecto.migrate
Isolation with Prefixes
Oban supports namespacing through PostgreSQL schemas, also called "prefixes" in Ecto. With prefixes your jobs table can reside outside of your primary schema (usually public) and you can have multiple separate job tables.
To use a prefix you first have to specify it within your migration:
defmodule MyApp.Repo.Migrations.AddPrefixedObanJobsTable do
use Ecto.Migration
def up, do: Oban.Migrations.up(prefix: "private")
def down, do: Oban.Migrations.down(prefix: "private")
end
The migration will create the "private" schema and all tables, functions and triggers within that schema. With the database migrated you'll then specify the prefix in your configuration:
config :my_app, Oban,
prefix: "private",
...
In some cases, for example if your "private" schema already exists and your database user in production doesn't have permissions to create a new schema, trying to create the schema from the migration will result in an error. In such situations, it may be useful to inhibit the creation of the "private" schema:
defmodule MyApp.Repo.Migrations.AddPrefixedObanJobsTable do
use Ecto.Migration
def up, do: Oban.Migrations.up(prefix: "private", create_schema: false)
def down, do: Oban.Migrations.down(prefix: "private")
end
Link to this section Summary
Functions
Run the down
changes for all migrations between the current version and the initial version.
Run the up
changes for all migrations between the initial version and the current version.
Link to this section Functions
Run the down
changes for all migrations between the current version and the initial version.
Example
Run all migrations from current version down to the first:
Oban.Migrations.down()
Run migrations down to a specified version:
Oban.Migrations.down(version: 5)
Run migrations in an alternate prefix:
Oban.Migrations.down(prefix: "payments")
Run the up
changes for all migrations between the initial version and the current version.
Example
Run all migrations up to the current version:
Oban.Migrations.up()
Run migrations up to a specified version:
Oban.Migrations.up(version: 2)
Run migrations in an alternate prefix:
Oban.Migrations.up(prefix: "payments")
Run migrations in an alternate prefix but don't try to create the schema:
Oban.Migrations.up(prefix: "payments", create_schema: false)