Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated docs

  • Loading branch information...
commit cb1bafac21558d60d015a4c2fb3b90d851ff28e6 1 parent 9fd7aa4
@kriszyp kriszyp authored
Showing with 10 additions and 3 deletions.
  1. +10 −3 README.md
View
13 README.md
@@ -26,7 +26,9 @@ using chained operator calls in JavaScript. We could
write this query:
var Query = require("rql/query").Query;
- new Query().eq("foo",3).forEach(...);
+ var fooEq3Query = new Query().eq("foo",3);
+
+
The RQL grammar is based around standard URI delimiters. The standard rules for
encoding strings with URL encoding (%xx) are observed. RQL also supersets FIQL.
@@ -77,11 +79,16 @@ we can do:
foo=string:3
-Any property can be nested by using a dot syntax. To search by the bar property of
+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
+ (foo,bar)=3
+We can also use slashes as shorthand for arrays, so we could equivalently write the nested
+query:
+
+ foo/bar=3
+
Another common operator is sort. We can use the sort operator to sort by a specified property.
To sort by foo in ascending order:
Please sign in to comment.
Something went wrong with that request. Please try again.