# MatchEngine

[![Build Status](]( [![](]()

A query language for filtering and scoring of documents, inspired by
the MongoDB query language and Solr. The query language consists of
nested Elixir *keyword list*. Each component of the query consists of
a *key* part and a *value* part. The key part is either a logic
operator (and/or/not), or a reference to a field, the value part is
either a plain value, or a value operator.

When a query is run against a document, where each term is scored
individually and then summed. (This implies "or").

Example queries:

[title: "hoi"]
[title: [_eq: "hoi"]]
[_and: [name: "Arjan", age: 36]]
[_or: [name: "Arjan", age: 36]]
[_not: [title: "foo"]]

Full documentation can be found at [](

## Installation

If [available in Hex](, the package can be installed
by adding `match_engine` to your list of dependencies in `mix.exs`:

def deps do
    {:match_engine, "~> 1.0"}