searchql v1.0.0 SearchQL

A parser for the Canvas Query Language—a syntax for searching and filtering Canvas documents.

Summary

Functions

Return whether a query matches data using a given module

Parse a query string into a tree that can be iterated over in order to evaluate the query against data

Types

token()
token() :: {atom, String.t | {token, token}}

Functions

matches?(query_string, data, mod)
matches?(String.t, any, atom) :: boolean

Return whether a query matches data using a given module.

parse(query_string)
parse(String.t) :: [token]

Parse a query string into a tree that can be iterated over in order to evaluate the query against data.

iex> SearchQL.parse(~s(foo bar baz))
[{:data, "foo bar baz"}]