Postgrex v0.9.1 → Overview → Postgrex → Extension

Postgrex.Extension behaviour

Types
Callbacks

An extension knows how to encode and decode Postgres types to and from Elixir values.

Source

Types ↑

t :: module

opts :: term

Callbacks

decode/4

(callback) # ↑

Specs:

decode(Postgrex.TypeInfo.t, binary, Postgrex.Types.types, opts) :: term

Should decode a binary in the specified Postgres protocol format to an Elixir value.

Source

encode/4

(callback) # ↑

Specs:

encode(Postgrex.TypeInfo.t, term, Postgrex.Types.types, opts) :: binary

Should encode an Elixir value to a binary in the specified Postgres protocol format.

Source

format/1

(callback) # ↑

Specs:

format(opts) :: :binary | :text

Returns the format the type should be encoded as. See http://www.postgresql.org/docs/9.4/static/protocol-overview.html#PROTOCOL-FORMAT-CODES.

Source

init/2

(callback) # ↑

Specs:

init(Map.t, term) :: opts

Should perform any initialization of the extension. The function receives the server parameters (http://www.postgresql.org/docs/9.4/static/runtime-config.html) and user options. The options returned from this function will be passed to all other callbacks.

Source

matching/1

(callback) # ↑

Specs:

matching(opts) :: [type: String.t, send: String.t, receive: String.t, input: String.t, output: String.t]

Specifies the types the extension matches, see Postgrex.TypeInfo for specification of the fields.

Source