# Base62UUIDField [![Build Status](]( [![Coverage Status](](

An [Ecto.Type]( for Base62-encoded UUIDs.

## Installation

If [available in Hex](, the package can be installed
by adding `base62_uuid_field` to your list of dependencies in `mix.exs`:

def deps do
    {:base62_uuid_field, "~> 1.0.0"}

## Usage

This Ecto type builds on top of the existing `Ecto.UUID` type, except that it ensures that the types at runtime are represented as [Base62-encoded UUIDs](

For example, given an `identity_users` table with a `:binary_id` primary key:

create table(:identity_users, primary_key: false) do
  add :id, :binary_id, primary_key: true

We can have Base62-encoded primary keys at runtime instead of much longer and less URL-friendly hexadecimal-encoded UUIDs.

defmodule App.Identity.User do
  use Ecto.Schema

  @primary_key {:id, Base62UUIDField, autogenerate: true}

  # ...etc.

iex> %App.Identity.User{} |> App.Identity.User.changeset(%{}) |> App.Repo.insert!()
  __meta__: #Ecto.Schema.Metadata<:loaded, "identity_users">,
  id: "6UupZ56JriyqxwjYXR9Aiz",
  inserted_at: ~N[2018-12-13 18:22:57],
  updated_at: ~N[2018-12-13 18:22:57]