Socrata

v2.0.0

Socrata v2.0.0 Socrata.Query View Source

Queries are the building blocks for finding the data you need in Socrata. This module provides you with a simple struct to define SODA queries.

All of the filters and query operators defined in the Socrata filter docs and in the Socrata SoQL docs are implemented here. Each function composes a base query.

Link to this section Summary

Types

t()

Functions

ensure_bom(query)

Adds a SoQL $$bom=true directive to the query

filter(query, key, value)

Adds a simple field filter to the query

group(query, expression)

Adds a SoQL $group filter to the query

having(query, expression)

Adds a SoQL $having filter to the query

limit(query, cap)

Adds a SoQL $limit filter to the query

new(opts)

Creates a new query struct from a keywrod list

new(fourby, domain)

Creates a new query struct from positional fourby and domain arguments

offset(query, skip)

Adds a SoQL $offset filter to the query

order(query, expression)

Adds a SoQL $order filter to the query

q(query, expression)

Adds a SoQL $q filter to the query

query(query, expression)

Adds a SoQL $query filter to the query

select(query, columns)

Adds a SoQL $select filter to the query

where(query, expression)

Adds a SoQL $where filter to the query

Link to this section Types

Link to this type t() View Source 
t() :: %Socrata.Query{domain: String.t(), fourby: String.t(), state: map()}

Link to this section Functions

Link to this function ensure_bom(query) View Source 
ensure_bom(Socrata.Query.t()) :: Socrata.Query.t()

Adds a SoQL $$bom=true directive to the query.

See the general Socrata SoQL docs and the bom specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.ensure_bom()
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$$bom" => true}}
Link to this function filter(query, key, value) View Source 
filter(Socrata.Query.t(), String.t(), any()) :: Socrata.Query.t()

Adds a simple field filter to the query.

See the Socrata simple filters docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.filter("name", "whatever")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"name" => "whatever"}}
Link to this function group(query, expression) View Source 
group(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $group filter to the query.

See the general Socrata SoQL docs and the group specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.select(["location", "SUM(attendees)"]) |> Q.group("location")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$select" => "location, SUM(attendees)", "$group" => "location"}}
Link to this function having(query, expression) View Source 
having(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $having filter to the query.

See the general Socrata SoQL docs and the having specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.select(["location", "SUM(attendees) as count"]) |> Q.group("location") |> Q.having("count > 500")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$select" => "location, SUM(attendees) as count", "$group" => "location", "$having" => "count > 500"}}
Link to this function limit(query, cap) View Source 
limit(Socrata.Query.t(), integer()) :: Socrata.Query.t()

Adds a SoQL $limit filter to the query.

See the general Socrata SoQL docs and the limit specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.limit(10)
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$limit" => 10}}
Link to this function new(opts) View Source 
new(keyword()) :: Socrata.Query.t()

Creates a new query struct from a keywrod list.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new(fourby: "asdf-asdf", domain: "example.com")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{}}
Link to this function new(fourby, domain) View Source 
new(String.t(), String.t()) :: Socrata.Query.t()

Creates a new query struct from positional fourby and domain arguments.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{}}
Link to this function offset(query, skip) View Source 
offset(Socrata.Query.t(), integer()) :: Socrata.Query.t()

Adds a SoQL $offset filter to the query.

See the general Socrata SoQL docs and the offset specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.limit(5) |> Q.offset(10)
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$limit" => 5, "$offset" => 10}}
Link to this function order(query, expression) View Source 
order(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $order filter to the query.

See the general Socrata SoQL docs and the order specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.order("name ASC")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$order" => "name ASC"}}
Link to this function q(query, expression) View Source 
q(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $q filter to the query.

See the general Socrata SoQL docs and the q specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.q("a bag of words")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$q" => "a bag of words"}}
Link to this function query(query, expression) View Source 
query(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $query filter to the query.

See the general Socrata SoQL docs and the query specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.query("SELECT name, location, SUM(attendees) as count GROUP BY location HAVING count > 500")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$query" => "SELECT name, location, SUM(attendees) as count GROUP BY location HAVING count > 500"}}
Link to this function select(query, columns) View Source 
select(Socrata.Query.t(), list()) :: Socrata.Query.t()

Adds a SoQL $select filter to the query.

See the general Socrata SoQL docs and the select specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.select(~w|name location|)
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$select" => "name, location"}}
Link to this function where(query, expression) View Source 
where(Socrata.Query.t(), String.t()) :: Socrata.Query.t()

Adds a SoQL $where filter to the query.

See the general Socrata SoQL docs and the where specific docs for more info.

Example 

iex> alias Socrata.Query, as: Q
iex> Q.new("asdf-asdf", "example.com") |> Q.where("height >= 1000")
%Socrata.Query{fourby: "asdf-asdf", domain: "example.com", state: %{"$where" => "height >= 1000"}}