Steward.Config behaviour (Steward v0.1.0)

Copy Markdown View Source

Interface and validation for global Steward configuration.

NOTE: Do not use this directly, use Steward.

Usage

Define your Steward configuration on a custom module in your application.

defmodule MyApp.Steward do
  use Steward, repo: MyApp.Repo
end

Options

  • :repo - the Ecto.Repo storing resources. Required.
  • :table - the resources table. Defaults to "steward_resources".
  • :prefix - the resources table's schema. Defaults to "public".

The behaviour of Steward's background processes is configured on the plugin, see Steward.Plugin.

Summary

Types

t()

(since 0.1.0)
@type t() :: %{repo: module(), table: String.t(), prefix: String.t()}