Alembic

v3.2.1

Alembic v3.2.1 Alembic.ToEctoSchema behaviour

The Alembic.ToEctoSchema behaviour converts a struct in the Alembic namespace to an Ecto.Schema.t struct.

Summary

Types

ecto_schema()
  • nil if an empty singleton
  • struct - if a non-empty singleton
  • [] - if an empty collection
  • [struct] - if a non-empty collection
ecto_schema_module()

A module that defines __struct__/0 and __schema__(:fields) as happens when use Ecto.Schema is run in a module

ecto_schema_module_by_type()

Maps JSON API Alembic.Resource.type to ecto_schema_module for casting that Alembic.Resource.type

Functions

put_named_association(acc, params, ecto_schema_module, association_name)
to_ecto_schema(params, ecto_schema_module)
to_ecto_schema(map, params, ecto_schema_module_by_type)

Callbacks

to_ecto_schema(struct, arg1, ecto_schema_module_by_type)

Parameters

Types

ecto_schema() 
ecto_schema() :: nil | struct | [] | [struct, ...]
  • nil if an empty singleton
  • struct - if a non-empty singleton
  • [] - if an empty collection
  • [struct] - if a non-empty collection
ecto_schema_module() 
ecto_schema_module() :: atom

A module that defines __struct__/0 and __schema__(:fields) as happens when use Ecto.Schema is run in a module.

ecto_schema_module_by_type() 
ecto_schema_module_by_type() :: %{optional(Alembic.Resource.type) => ecto_schema_module}

Maps JSON API Alembic.Resource.type to ecto_schema_module for casting that Alembic.Resource.type.

Functions

put_named_association(acc, params, ecto_schema_module, association_name)
to_ecto_schema(params, ecto_schema_module) 
to_ecto_schema(Alembic.ToParams.params, ecto_schema_module) :: struct
to_ecto_schema(map, params, ecto_schema_module_by_type) 
to_ecto_schema(%{type: Alembic.Resource.type}, Alembic.ToParams.params, ecto_schema_module_by_type) :: struct

Callbacks

to_ecto_schema(struct, arg1, ecto_schema_module_by_type) 
to_ecto_schema(struct, Alembic.ToParams.resource_by_id_by_type, ecto_schema_module_by_type) :: ecto_schema

Parameters

  • struct - an Alembic.Document.t hierarchy struct
  • attributes_by_id_by_type - Maps a resource identifier’s Alembic.ResourceIdentifier.type and Alembic.ResourceIdentifier.id to its Alembic.Resource.attributes from Alembic.Document.t included.
  • ecto_schema_module_by_type -

Returns

  • nil if an empty singleton
  • struct - if a non-empty singleton
  • [] - if an empty collection
  • [struct] - if a non-empty collection