06-queries.html

<h5>Queries</h5>

<p>Grasshopper&#39;s query builder accepts a query object that contains several parameters, some optional.</p>

<p>The returned object is an array with limit, skip and total.  The total is the value of all content matched by query, not just returned objects.</p>

<p>Definitions for all possible query parameters/options</p>

<ul>
<li><em>filters</em>: An array of optional filter objects for the query.

<ul>
<li><em>key</em>: The key of the content being filtered.</li>
<li><em>cmp</em>: The comparison operator for the filter value.  Currently supported operators (Query accepts symbol or string value):

<ul>
<li><em>&#39;=&#39;</em>: equals</li>
<li><em>&#39;!=&#39; or &#39;not&#39; or &#39;notequal&#39; or &#39;notequals&#39;</em>: not equal to</li>
<li><em>&#39;&gt;=&#39; or &#39;gte&#39;</em>: greater than or equals</li>
<li><em>&#39;&gt;&#39; or &#39;gt&#39;</em>: greater than</li>
<li><em>&#39;&lt;=&#39; or &#39;lte&#39;</em>: less than or equals</li>
<li><em>&#39;&lt;&#39; or &#39;lt&#39;</em>: less than</li>
<li><em>&#39;in&#39; or &#39;contains&#39;</em>: contains</li>
<li><em>&#39;!in&#39; or &#39;notin&#39; or &#39;notcontains&#39;</em>: does not contain</li>
<li><em>&#39;%&#39; or &#39;like&#39;</em>: like (Allows for &#39;fuzzy matching&#39;)</li>
<li><em>&#39;!%&#39; or &#39;notlike&#39;</em>: not like (Allows for &#39;fuzzy matching&#39;)</li>
<li><em>&#39;between&#39;</em>: between</li>
<li><em>&#39;notbetween&#39;</em>: not between</li>
<li><em>&#39;size&#39;</em>: size</li>
<li><em>&#39;exists&#39;</em>: exists</li>
</ul></li>
<li><em>value</em>: Then value the filter will be compared with.</li>
</ul></li>
<li><em>types</em>: An optional array of content type ids.</li>
<li><em>nodes</em>: An optional array of node ids.</li>
<li><em>options</em>: Object.  Possible key/value pairs are:

<ul>
<li>* limit : Limit number of results. String or number.</li>
<li>* skip : Skip specified number of results.  String or number. (limit and skip support pagination)</li>
<li>* distinct : return distinct results within a find.  Can include types.</li>
<li>* exclude : array of fields to be excluded from query.</li>
<li>* include : array of fields to be included in query.</li>
</ul></li>
</ul>

<p>Important Notes:</p>

<ul>
<li>The options object can have include or exclude parameters, but not both in the same query.</li>
<li>When using &#39;options.distinct&#39;, filters can&#39;t be used.  This means paging is not available.</li>
</ul>