Jak używać Postgres' typ wyliczany z Ecto

Question

Z PostgreSQL, możemy zrobić coś takiego:

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

Od Ecto's official doc, nie ma natywnego typu mapować postgres' typ wymienić. Ten module zapewnia niestandardowy typ dla wyliczonych struktur, ale odwzorowuje na liczbę całkowitą w bazie danych. Mogłabym z łatwością korzystać z tej biblioteki, ale wolałbym używać natywnego typu wyliczeniowego, który jest dostarczany z bazą danych.

Ecto zapewnia również sposób tworzenia custom types, ale o ile widzę, niestandardowy typ musi mapować do natywnego typu ekto ...

ktoś wie, czy można to zrobić w schemacie z Ecto ? Jeśli tak, w jaki sposób migracja zadziałałaby?

Answer 1

Ecto_enum teraz obsługuje PostgreSQL type ENUM https://github.com/gjaldon/ecto_enum#using-postgress-enum-type

Answer 2

Musisz utworzyć typ Ecto dla każdego wyliczenia postgresql. W definicji schematu po prostu masz typ: :string. W przypadku migracji ustawiasz typ na nazwę modułu. To może się naprawdę uciążliwe, choć, więc mam następujące makro w moim projekcie, który używa PostgreSQL teksty stałe:

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 

Możliwe wykorzystanie:

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

ColorsEnum będzie nazwa modułu, "colors_enum" będzie nazwa wewnętrzna do Postgresql: musisz dodać instrukcję, aby utworzyć typ wyliczeniowy w swoich migracjach baz danych. Ostatnim argumentem jest lista wartości wyliczeniowych. Użyłem sigila ~w, które podzieli ciąg znaków na białe znaki, aby pokazać, jak zwięźle to może być. Dodałem także klauzulę, która konwertuje wartości atomów do wartości łańcuchów, gdy przechodzą przez schemat Ecto.

Answer 3

Może zrobiłem coś złego, ale ja po prostu stworzył rodzaj i pole takiego:

# 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 

a potem po prostu wykonane polu ciąg:

field :post_status, :string 

i wydaje się działać.

Answer 4

Mała korekta dla @JustMichael. Jeśli trzeba cofnąć, można użyć:

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

Answer 5

dodanie do co @JustMichael i @swennemen powiedzieć ... jak z ekto 2.2.6 mamy ekto .Migration.execute/2, która przyjmuje argument w górę i w dół. Tak więc możemy zrobić:

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

W naszym pliku migracji wewnątrz bloku change i ekto będzie mógł skutecznie cofnąć.