View Source Seeker.Extractor (seeker v0.2.0)

Extractor implementation for Seeker.

Summary

association(key)

Returns atom association name tuple based on a string key.

Returns atom association name based on a string key.

column(key)

Returns atom column name tuple based on a string key.

column!(key)

Returns atom column name based on a string key.

@spec association(String.t()) :: {:ok, atom()}

Returns atom association name tuple based on a string key.

iex> association("category__name")
{:ok, :category}

iex> association("email")
{:ok, :root}

@spec association!(String.t()) :: atom()

Returns atom association name based on a string key.

iex> association!("category__name")
:category

iex> association!("email")
:root

@spec column(String.t()) :: {:ok, atom()}

Returns atom column name tuple based on a string key.

iex> column("category__name")
{:ok, :name}

iex> column("email")
{:ok, :email}

@spec column!(String.t()) :: atom()

Returns atom column name based on a string key.

iex> column!("category__name")
:name

iex> column!("email")
:email