[![ version](](

EctoEnumerize allows to define custom enums (keyword lists) to be used in your Ecto schemes.

## Why?

It differs from [EctoEnum]( because
EctoEnumerize does not use the PostgreSQL native *Enum* type, instead it stores
the value as an integer and therefore it should work on any database.

While it's easy to add new values to your Enum when using PostgreSQL native Enum type,
it appears there is no easy solution to remove them without having to drop and create the enum again.
Check this [thread](
on stackoverflow for more info.

It does not affect this library since the Enum is handled at the application level.

## Usage

First, we add `ecto_enumerize` to `mix.exs`:

def deps do
    {:ecto_enumerize, "~> 0.1.1"}

Run `mix deps.get` to install `ecto_enumerize`.

Now we can define our enum as follow:

defmodule Order do
  use Ecto.Schema
  import EctoEnumerize

  defenum Status, pending: 0, shipped: 1, delivered: 2

  schema "orders" do
    field :status, Status, default: :pending

  def changeset(order, attrs) do
    cast(order, attrs, [:status])

In the above example, the `:status` will behave like an enum and will allow you to
pass an `integer`, `atom` or `string` to it. This applies to saving the model,
invoking `Ecto.Changeset.cast/4`, or performing a query on the status field.

Some examples:

iex> Order.Status.get_enum()
[pending: 0, shipped: 1, delivered: 2]

iex> order = Repo.insert!(%Order{status: :delivered})
iex> Repo.get(Order,

iex> # any of these values will produce the same result
iex> s = Enum.random([:delivered, "delivered", 2])
iex> from(o in Order, where: o.status == ^s) |> Repo.aggregate(:count, :id)

Passing an invalid value to a `Ecto.Changeset.cast/3` will add an error to
`changeset.errors` field.

    iex> cs = Order.changeset(order, %{status: :unknown})
    iex> cs.errors
    [status: {"is invalid", [type: Order.Status, validation: :cast]}]

### Migrations

Simple as that:

def change do
  create table(:orders) do
    add :status, :integer

## Important links

  * [Documentation](
  * [License](