db_connection v2.0.5 DBConnection.Query protocol View Source

The DBConnection.Query protocol is responsible for preparing and encoding queries.

Link to this section Summary

t()

Decode a result using a query

Describe a query

Encode parameters using a query

Parse a query

t() :: term()

decode(query, result, opts)

decode(any(), any(), Keyword.t()) :: any()

Decode a result using a query.

This function is called to decode a result after it is returned by a connection callback module.

describe(query, opts)

describe(any(), Keyword.t()) :: any()

Describe a query.

This function is called to describe a query after it is prepared using a connection callback module.

encode(query, params, opts)

encode(any(), any(), Keyword.t()) :: any()

Encode parameters using a query.

This function is called to encode a query before it is executed using a connection callback module.

If this function raises DBConnection.EncodeError, then the query is prepared once again.

parse(query, opts)

parse(any(), Keyword.t()) :: any()

Parse a query.

This function is called to parse a query term before it is prepared using a connection callback module.