RQL Reference

An example of an RQL for finding resources with a category of "toy" and sorted by price in ascending order:
category=toy&sort(+price)

RQL is a compatible superset of standard HTML form URL encoding. The following queries are identical:
eq(foo,3)
foo=3

We can write a query that finds resources with a "price" property below 10 with a "lt" operator using FIQL syntax:
price=lt=10
lt(price,10)

One can combine conditions with multiple operators with "&":
foo=3&price=lt=10
eq(foo,3)&lt(price,10)
and(eq(foo,3),lt(price,10))

The | operator can be used to indicate an "or" operation. We can also use paranthesis to group expressions. For example:
(foo=3|foo=bar)&price=lt=10

Queries
select	select(<property>,<property>,...)
Trims each object down o the set of properties defined in the arguments Examples `select(firstname)` `select(firstname,age)`
values	values(<property>)
Returns an array of the given property value for each object
distinct	distinct()
Returns a result set with duplicates removed Examples `select(age)&distinct()`
limit	limit(count,start,maxCount)
Returns the given range of objects from the result set Examples `limit(2)&sort(+_id)` `limit(2,1)&sort(+_id)`
sort	sort(<+\|-><property)
Sorts by the given property in order specified by the prefix (+ for ascending, - for descending) Examples `sort(+firstname)` `sort(+firstname,-age)`
Filtering
eq	eq(<property>,<value>)
Filters for objects where the specified property's value is equal to the provided value Examples `firstname=Jane` `firstname=eq=Jane` `eq(firstname,Jane)`
ne	ne(<property>,<value>)
Filters for objects where the specified property's value is not equal to the provided value Examples `firstname!=Jane` `firstname=ne=Jane` `ne(firstname,Jane)`
lt	lt(<property>,<value>)
Filters for objects where the specified property's value is less than the provided value Examples `age<30` `age=lt=30` `lt(age,30)`
le	le(<property>,<value>)
Filters for objects where the specified property's value is less than or equal to the provided value Examples `age<=30` `age=le=30` `le(age,30)`
gt	gt(<property>,<value>)
Filters for objects where the specified property's value is greater than the provided value Examples `age>30` `age=gt=30` `gt(age,30)`
ge	ge(<property>,<value>)
Filters for objects where the specified property's value is greater than or equal to the provided value Examples `age>=30` `age=ge=30` `ge(age,30)`
in	in(<property>,<array-of-values>)
Filters for objects where the specified property's value is not in the provided array Examples `in(firstname,(Alice,James))` `in(age,(28,42))`
out	out(<property>,<array-of-values>)
Filters for objects where the specified property's value is an array and the array Examples `out(firstname,(Alice,James))` `out(age,(30,28))`
contains	contains(<property>,<value \| expression>)
Filters for objects where the specified property's value is an array and the array contains any value that equals the provided value or satisfies the provided expression.
excludes	excludes(<property>,<value \| expression>)
Filters for objects where the specified property's value is an array and the array does not contain any of value that equals the provided value or satisfies the provided expression.
rel	rel(<relation name?>,<query>)
Applies the provided query against the linked data of the provided relation name.
and	and(<query>,<query>,...)
Applies all the given queries Examples `age>28&age!=42` `age>28,age!=42` `and(or(age=28,age=30),or(firstname=Alice,firstname=John))` `or(age=28,age=30)&or(firstname=Alice,firstname=John)` `(age=28\|age=30)&(firstname=Alice\|firstname=John)`
or	or(<query>,<query>,...)
The union of the given queries Examples `(age>30\|age=28)` `or(age>30,age=28)` `or(and(age=28,firstname=Alice),and(age=30,firstname=John))` `(and(age=28,firstname=Alice)\|and(age=30,firstname=John))` `((age=28&firstname=Alice)\|(age=30&firstname=John))`
Aggregating
aggregate	aggregate(<property\|function>,...)
Aggregates the array, grouping by objects that are distinct for the provided properties, and then reduces the remaining other property values using the provided functions
sum	sum(<property?>)
Finds the sum of every value in the array or if the property argument is provided, returns the sum of the value of property for every object in the array
mean	mean(<property?>)
Finds the mean of every value in the array or if the property argument is provided, returns the mean of the value of property for every object in the array
max	max(<property?>)
Finds the maximum of every value in the array or if the property argument is provided, returns the maximum of the value of property for every object in the array
min	min(<property?>)
Finds the minimum of every value in the array or if the property argument is provided, returns the minimum of the value of property for every object in the array
count	count()
Returns the count of the number of records in the query's result set
Misc
Nested properties
Any property can be nested by using an array of properties. To search by the bar property of the object in the foo property we can do: (foo,bar)=3 shorthand: foo/bar=3
Typed values
foo=string:3
recurse	recurse(<property?>)
Recursively searches, looking in children of the object as objects in arrays in the given property value
first	first()
Returns the first record of the query's result set is first() just alias for limit(1)?
one	one()
Returns the first and only record of the query's result set, or produces an error if the query's result set has more or less than one record in it.

RQL

MongoDB

SQL

Elastic Search

Misc

Created by: Jakub Dundalek
Some texts and examples taken from RQL docs created by Kris Zyp
Last updated: 1.8.2012

RQL Reference

Examples

Reference

Compatibility Matrix

Resources

RQL

MongoDB

SQL

Elastic Search

Misc