ecto_identifier v0.1.0 Ecto.Nanoid View Source

Custom type that can auto-generate nanoids.

Usage

defmodule Post do
  use Ecto.Schema
  alias Ecto.Nanoid

  schema "posts" do
    field(:number, Ecto.Nanoid, autogenerate: true)
    field(:data, :string)
  end
end

In your migrations for the posts table,

create table(:posts) do
  add :number, :string
  add :data, :string
end

Link to this section Summary

Functions

Delegates generation of the field to Nanoid.generate/0

Casts the given input to the custom type

Dumps the given term into an Ecto native type

Loads the given term into a custom type

Returns the underlying schema type for the custom type

Link to this section Functions

Link to this function autogenerate() View Source
autogenerate() :: String.t()

Delegates generation of the field to Nanoid.generate/0.

Casts the given input to the custom type.

This callback is called on external input and can return any type, as long as the dump/1 function is able to convert the returned value into an Ecto native type. There are two situations where this callback is called:

  1. When casting values by Ecto.Changeset
  2. When passing arguments to Ecto.Query

Callback implementation for Ecto.Type.cast/1.

Dumps the given term into an Ecto native type.

This callback is called with any term that was stored in the struct and it needs to validate them and convert it to an Ecto native type.

Callback implementation for Ecto.Type.dump/1.

Loads the given term into a custom type.

This callback is called when loading data from the database and receive an Ecto native type. It can return any type, as long as the dump/1 function is able to convert the returned value back into an Ecto native type.

Callback implementation for Ecto.Type.load/1.

Returns the underlying schema type for the custom type.

For example, if you want to provide your own date structures, the type function should return :date.

Note this function is not required to return Ecto primitive types, the type is only required to be known by the adapter.

Callback implementation for Ecto.Type.type/0.