Postgrex

v0.12.2

Postgrex v0.12.2 Postgrex.Extensions.JSON View Source

An extension that supports the json and jsonb types.

This extension is not used by default, it needs to be included in the :extensions option to Postgrex.start_link/1.

Options

  • :library - The module to encode and decode JSON binaries, calls module.encode!/1 to encode and module.decode!/1 to decode (required);
  • :decode_binary - Either :copy to copy binary values before decoding with the library module or :reference to use a reference counted binary of the binary received from the socket. Referencing a potentially larger binary can be more efficient if the binary value is going to be garbaged collected soon because a copy is avoided. However the larger binary can not be garbage collected until all references are garbage collected (defaults to :copy);

Link to this section Summary

Functions

decode(type_info, json, state, arg4)

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

encode(type_info, map, state, arg)

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

format(_)

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

init(parameters, 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

matching(_)

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

Link to this section Functions

Link to this function decode(type_info, json, state, arg4) View Source

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

Callback implementation for Postgrex.Extension.decode/4.

Link to this function encode(type_info, map, state, arg) View Source

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

Callback implementation for Postgrex.Extension.encode/4.

Link to this function format(_) View Source

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

Callback implementation for Postgrex.Extension.format/1.

Link to this function init(parameters, opts) View Source

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.

Callback implementation for Postgrex.Extension.init/2.

Link to this function matching(_) View Source

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

Callback implementation for Postgrex.Extension.matching/1.