Как использовать Postgres' перечисляемого типа с Ecto

Question

С PostgreSQL, мы можем сделать что-то вроде этого:

CREATE TYPE order_status AS ENUM ('placed','shipping','delivered') 

От Ecto's official doc, нет родного типа для отображения в Postgres' перечисляемого типа. Этот module предоставляет настраиваемый тип для перечисляемых структур, но он сопоставляет целое число в базе данных. Я мог бы легко использовать эту библиотеку, но я бы предпочел использовать собственный нумерованный тип, который поставляется с базой данных.

Ecto обеспечивает также способ создания custom types, но, насколько я могу видеть, пользовательский тип должен отображать в родной типа экто ...

Любой знает, если это может быть сделано в схеме с Ecto ? Если да, то как будет работать миграция?

Answer 1

Ecto_enum теперь поддерживает Postgres перечислимого типа https://github.com/gjaldon/ecto_enum#using-postgress-enum-type

Answer 2

Вам нужно создать тип Ecto для каждого перечисления postgresql. В определении схемы у вас просто есть тип :string. В миграциях вы устанавливаете тип как имя модуля. Это может стать очень утомительно, хотя, так что у меня есть следующий макрос в моем проекте, который использует PostGreSQL перечислений:

defmodule MyDB.Enum do 

    alias Postgrex.TypeInfo 

    defmacro defenum(module, name, values, opts \\ []) do 
    quote location: :keep do 
     defmodule unquote(module) do 

     @behaviour Postgrex.Extension 

     @typename unquote(name) 
     @values unquote(values) 

     def type, do: :string 

     def init(_params, opts), do: opts 

     def matching(_), do: [type: @typename] 

     def format(_), do: :text 

     def encode(%TypeInfo{type: @typename}=typeinfo, str, args, opts) when is_atom(str), do: encode(typeinfo, to_string(str), args, opts) 
     def encode(%TypeInfo{type: @typename}, str, _, _) when str in @values, do: to_string(str) 
     def decode(%TypeInfo{type: @typename}, str, _, _), do: str 

     def __values__(), do: @values 

     defoverridable init: 2, matching: 1, format: 1, encode: 4, decode: 4 

     unquote(Keyword.get(opts, :do, [])) 
     end 
    end 
    end 

end 

Возможное использование:

import MyDB.Enum 
defenum ColorsEnum, "colors_enum", ~w"blue red yellow" 

ColorsEnum будет имя модуля, "colors_enum" будет enum name internal to Postgresql: вам нужно будет добавить инструкцию для создания типа перечисления в ваших миграциях базы данных. Конечным аргументом является список значений перечисления. Я использовал сигалью ~w, которая разделит строку пробелом, чтобы показать, насколько это может быть кратким. Я также добавил предложение, которое преобразует значения атомов в строковые значения, когда они проходят через схему Ecto.

Answer 3

Может быть, я сделал что-то неправильно, но я просто создал тип и поле, как это:

# creating the database type 
execute("create type post_status as enum ('published', 'editing')") 

# creating a table with the column 
create table(:posts) do 
    add :post_status, :post_status, null: false 
end 

, а затем просто сделал поле строку:

field :post_status, :string 

и это похоже на работу.

Answer 4

Небольшое улучшение для @JustMichael. Если вам необходимо откатить, вы можете использовать:

def down do 
    drop table(:posts) 
    execute("drop type post_type") 
end 

Answer 5

добавление к тому, что сказали @JustMichael и @swennemen ... от экто 2.2.6 мы имеем экто .Migration.execute/2, который принимает вверх и вниз аргумент. Таким образом, мы можем сделать:

execute("create type post_status as enum ('published', 'editing')", "drop type post_status")

В нашей миграции файла внутри change блока, и экто сможет эффективно откатить.