Sqlcommenter (sqlcommenter v0.1.3)

Documentation for Sqlcommenter.

Summary

Functions

Appends serialized data to query

Appends serialized data to query

extracts serialized data from query

Encodes enumerable to iodata iex> Sqlcommenter.to_iodata(controller: :person, function: :index) [ " /", [["controller", "='", "person", "'"], ",", "function", "='", "index", "'"], "/" ]

Encodes enumerable to string iex> Sqlcommenter.to_str(controller: :person, function: :index) " /controller='person',function='index'/"

Functions

Link to this function

append_to_io_query(query, params)

@spec append_to_io_query(String.t(), Enumerable.t() | nil) :: String.t()

Appends serialized data to query

iex> query = ["SELECT", [~s{p0."id"}, ", ", ~s{p0."first_name"}], " FROM ", ~s{"person"."person"}, " AS ", "p0"] iex> Sqlcommenter.append_to_io_query(query, %{controller: :person, function: :index}) [ ["SELECT", [~s{p0."id"}, ", ", ~s{p0."first_name"}], " FROM ", ~s{"person"."person"}, " AS ", "p0"], " /", [["controller", "='", "person", "'"], ",", "function", "='", "index", "'"], "/"]

Link to this function

append_to_query(query, params)

@spec append_to_query(String.t(), Enumerable.t() | nil) :: String.t()

Appends serialized data to query

iex> query = ~s{SELECT p0."id", p0."first_name" FROM "person"."person" AS p0} iex> Sqlcommenter.append_to_query(query, %{controller: :person, function: :index}) ~s{SELECT p0."id", p0."first_name" FROM "person"."person" AS p0 } <> "/controller='person',function='index'/"

Link to this function

deserialize(query)

@spec deserialize(String.t()) :: map()

extracts serialized data from query

Example

iex> query = ~s{SELECT p0."id", p0."first_name" FROM "person"."person" AS p0 /request_id='fa2af7b2-d8e1-4e8f-8820-3fd648b73187'/} iex> Sqlcommenter.deserialize(query) %{"request_id" => "fa2af7b2-d8e1-4e8f-8820-3fd648b73187"}

Link to this function

to_iodata(params)

@spec to_iodata(Enumerable.t() | nil) :: maybe_improper_list()

Encodes enumerable to iodata iex> Sqlcommenter.to_iodata(controller: :person, function: :index) [ " /", [["controller", "='", "person", "'"], ",", "function", "='", "index", "'"], "/" ]

@spec to_str(Enumerable.t()) :: String.t()

Encodes enumerable to string iex> Sqlcommenter.to_str(controller: :person, function: :index) " /controller='person',function='index'/"