singyeong v0.4.14

Singyeong.Query (singyeong v0.4.14) View Source

Link to this section Summary

Types

boolean_op()
boolean_op_name()
logical_op()
logical_op_name()
op()
ops()
selector()
t()

Functions

merge(query, ops)

Merge the given ops into this query

new(name)

Creates a new query for the given target application

values_to_op(op, key, value)

Converts the provided values into a proper boolean op.

with_logical_op(query, logical_op, op1, op2)

Adds the provided logical op over the provided ops to the query.

with_op(query, op)

Adds the provided boolean op to the query.

with_op(query, op, key, value)

Adds the provided boolean op to the query.

with_selector(query, selector, key)

Sets the query's selector to the specified key

Link to this section Types

Link to this type

boolean_op()

View Source

Specs

boolean_op() :: %{required(boolean_op_name()) => term()}
Link to this type

boolean_op_name()

View Source

Specs

boolean_op_name() ::
  :"$eq"
  | :"$ne"
  | :"$gt"
  | :"$gte"
  | :"$lt"
  | :"$lte"
  | :"$in"
  | :"$nin"
  | :"$contains"
  | :"$ncontains"
Link to this type

logical_op()

View Source

Specs

logical_op() :: %{
  required(logical_op_name()) => maybe_improper_list(boolean_op(), logical_op())
}
Link to this type

logical_op_name()

View Source

Specs

logical_op_name() :: :"$and" | :"$or" | :"$nor"
Link to this type

op()

View Source

Specs

op() :: %{required(binary()) => boolean_op() | logical_op()}
Link to this type

ops()

View Source

Specs

ops() :: [op()] | []
Link to this type

selector()

View Source

Specs

selector() :: :"$min" | :"$max" | :"$avg"
Link to this type

t()

View Source

Specs

t() :: %Singyeong.Query{
  application: (String.t() | nil) | nil,
  droppable: boolean(),
  key: String.t() | nil,
  ops: [op()],
  optional: boolean(),
  restricted: boolean(),
  selector: selector() | nil
}

Link to this section Functions

Link to this function

merge(query, ops)

View Source

Specs

merge(t(), [op()]) :: t()

Merge the given ops into this query

Link to this function

new(name)

View Source

Specs

new(String.t() | nil) :: t()

Creates a new query for the given target application

Link to this function

values_to_op(op, key, value)

View Source

Specs

values_to_op(boolean_op_name(), String.t(), term()) :: boolean_op()

Converts the provided values into a proper boolean op.

Link to this function

with_logical_op(query, logical_op, op1, op2)

View Source

Specs

with_logical_op(t(), logical_op_name(), op(), op()) :: t()

Adds the provided logical op over the provided ops to the query.

Link to this function

with_op(query, op)

View Source

Specs

with_op(t(), boolean_op()) :: t()

Adds the provided boolean op to the query.

Link to this function

with_op(query, op, key, value)

View Source

Specs

with_op(t(), boolean_op_name(), String.t(), term()) :: t()

Adds the provided boolean op to the query.

Link to this function

with_selector(query, selector, key)

View Source

Specs

with_selector(t(), selector(), String.t()) :: t()

Sets the query's selector to the specified key