The representation of a filter in Ash.

Ash filters are stored as nested Ash.Query.Expression{} and %Ash.Query.Not{} structs, terminating in an operator or a function struct. An expression is simply a boolean operator and the left and right hand side of that operator.

Filter Templates

Filter templates are simplified fielter statements (they only support atom keys), that have substitutions in them. Currently, the substitutions are {:_actor, :field} and {:_actor, :_primary_key}

You can pass a filter template to build_filter_from_template/2 with an actor, and it will return the new result

Additionally, you can ask if the filter template contains an actor reference via template_references_actor?/1

Writing a filter

Built In Predicates

• is_nil
• ==
• !=
• in
• <
• >
• <=
• >=
• eq (alias for ==)
• equals (alias for ==)
• not_eq (alias for !=)
• not_equals (alias for !=)
• gt (alias for >)
• greater_than (alias for >)
• lt (alias for <)
• less_than (alias for <)
• gte (alias for >=)
• greater_than_or_equal (alias for >=)
• lte (alias for <=)
• less_than_or_equal (alias for <=)

Expression syntax

The expression syntax ultimately just builds the keyword list style filter, but with lots of conveniences that would be very annoying to do manually.

Examples

Ash.Query.filter(resource, name == "Zardoz")
Ash.Query.filter(resource, first_name == "Zar" and last_name == "Doz")
Ash.Query.filter(resource, first_name == "Zar" and last_name in ["Doz", "Daz"] and high_score > 10)
Ash.Query.filter(resource, first_name == "Zar" or last_name == "Doz" or (high_score > 10 and high_score < -10))

Keyword list syntax

A filter is a nested keyword list (with some exceptions, like true for everything and false for nothing).

The key is the "predicate" (A.K.A condition) and the value is the parameter. You can use and and or to create nested filters. Datalayers can expose custom predicates. Eventually, you will be able to define your own custom predicates, which will be a mechanism for you to attach complex filters supported by the data layer to your queries.

Important In a given keyword list, all predicates are considered to be "ands". So [or: [first_name: "Tom", last_name: "Bombadil"]] doesn't mean 'First name == "tom" or last_name == "bombadil"'. To say that, you want to provide a list of filters, like so: [or: [[first_name: "Tom"], [last_name: "Bombadil"]]]

Some example filters:

Ash.Query.filter(resource, [name: "Zardoz"]))
Ash.Query.filter(resource, [first_name: "Zar", last_name: "Doz"])
Ash.Query.filter(resource, [first_name: "Zar", last_name: [in: ["Doz", "Daz"]], high_score: [greater_than: 10]])
Ash.Query.filter(resource, [or: [
  [first_name: "Zar"],
  [last_name: "Doz"],
  [or: [
    [high_score: [greater_than: 10]]],
    [high_score: [less_than: -10]]
  ]
]])