Haystack

View Source Haystack.Query.Expression behaviour (Haystack v0.1.0)

A module for defining query expressions.

Link to this section Summary

Types

k()
t()

Callbacks

evaluate(t, t)

Evaluate the given clause.

Functions

build(expression)

Build the expression into a statement.

default()

Return the default expressions.

new(k, opts)

Create a new expression.

Link to this section Types

Link to this type

k()

View Source 
@type k() :: atom()
Link to this type

t()

View Source 
@type t() :: %Haystack.Query.Expression{field: String.t(), k: k(), term: String.t()}

Link to this section Callbacks

Link to this callback

evaluate(t, t)

View Source 
@callback evaluate(Haystack.Index.t(), t()) :: [map()]

Evaluate the given clause.

Link to this section Functions

Link to this function

build(expression)

View Source 
@spec build(t()) :: Haystack.Query.statement()

Build the expression into a statement.

examples

 Examples 

iex> expression = Query.Expression.new(:match, field: "name", term: "Haystack")
iex> Query.Expression.build(expression)
Link to this function

default()

View Source 
@spec default() :: [{atom(), module()}]

Return the default expressions.

examples

 Examples 

iex> Query.Expression.default()
Link to this function

new(k, opts)

View Source 
@spec new(k(), Keyword.t()) :: t()

Create a new expression.

examples

 Examples 

iex> Query.Expression.new(:match, field: "name", term: "Haystack")