@harishreddym/baqend
Version:
Baqend JavaScript SDK
3,105 lines (980 loc) • 86.4 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Baqend JavaScript SDK 2.14.1 - Interface: Condition<T></title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css">
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="navbar-inner container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href="/"><img src="img/logo.png"></a>
</div>
<!-- Expanded navigation -->
<div id="nav" class="navbar-collapse collapse">
<!-- Search -->
<form class="navbar-right form-inline search-form">
<div class="form-group search-form-group">
<input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off">
<div id="search-results" class="search-results">
<p class="search-no-results">Please enter a search query ...</p>
</div>
<i class="search-icon fa fa-search"></i>
</div>
</form>
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li>
<a href="https://dashboard.baqend.com/">Dashboard</a>
</li>
<!-- Guide Navigation -->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.baqend.com/guide/">Home</a></li>
<li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li>
<li><a href="https://www.baqend.com/guide/#platform">Platform</a></li>
<li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li>
<li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li>
</ul>
</li>
<!-- Starter Kits -->
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li>
<li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li>
<li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li>
<li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li>
<li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li>
<li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li>
</ul>
</li>
<li class="active">
<a href="baqend.html">JS API</a>
</li>
<li>
<a href="https://www.baqend.com/tutorial.html">Tutorial</a>
</li>
</ul>
</div>
</div>
</nav>
<div class="box gray pt-32 pb-32">
<div class="container">
<div class="row">
<!-- <div class="col-md-3"></div> -->
<div class="bs-sidebar hidden-print fixed affix" role="complementary">
<input class="filter form-control input-sm" type="text" placeholder="FILTER"/>
<ul class="nav bs-sidenav">
<li class=""><a href="Acl.html" class="nav-name">Acl</a></li>
<li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li>
<li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li>
<li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li>
<li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li>
<li class=""><a href="baqend.html" class="nav-name">baqend</a></li>
<li class="">
<a href="binding.html" class="nav-name">binding</a>
<ul class="nav">
<li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li>
<li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li>
<li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li>
<li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li>
<li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li>
<li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li>
<li class=""><a href="binding.File.html" class="nav-name">File</a></li>
<li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li>
<li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li>
<li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li>
<li class=""><a href="binding.Role.html" class="nav-name">Role</a></li>
<li class=""><a href="binding.User.html" class="nav-name">User</a></li>
<li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li>
</ul>
</li>
<li class="">
<a href="caching.html" class="nav-name">caching</a>
<ul class="nav">
<li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li>
</ul>
</li>
<li class="">
<a href="connector.html" class="nav-name">connector</a>
<ul class="nav">
<li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li>
<li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li>
<li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li>
<li class=""><a href="connector.Message.html" class="nav-name">Message</a></li>
<li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li>
<li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li>
<li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li>
<li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li>
<li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li>
</ul>
</li>
<li class="">
<a href="error.html" class="nav-name">error</a>
<ul class="nav">
<li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li>
<li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li>
<li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li>
<li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li>
<li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li>
</ul>
</li>
<li class="">
<a href="metamodel.html" class="nav-name">metamodel</a>
<ul class="nav">
<li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li>
<li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li>
<li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li>
<li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li>
<li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li>
<li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li>
<li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li>
<li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li>
<li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li>
<li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li>
<li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li>
<li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li>
<li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li>
<li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li>
<li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li>
</ul>
</li>
<li class="">
<a href="model.html" class="nav-name">model</a>
<ul class="nav">
<li class=""><a href="model.Device.html" class="nav-name">Device</a></li>
<li class=""><a href="model.Role.html" class="nav-name">Role</a></li>
<li class=""><a href="model.User.html" class="nav-name">User</a></li>
</ul>
</li>
<li class="">
<a href="partialupdate.html" class="nav-name">partialupdate</a>
<ul class="nav">
<li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li>
<li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li>
<li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li>
</ul>
</li>
<li class="active">
<a href="query.html" class="nav-name">query</a>
<ul class="nav">
<li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li>
<li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li>
<li class=""><a href="query.Node.html" class="nav-name">Node</a></li>
<li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li>
<li class=""><a href="query.Query.html" class="nav-name">Query</a></li>
<li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li>
<li class="active"><a href="query.Condition.html" class="nav-name">Condition</a></li>
</ul>
</li>
<li class="">
<a href="util.html" class="nav-name">util</a>
<ul class="nav">
<li class=""><a href="util.Code.html" class="nav-name">Code</a></li>
<li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li>
<li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li>
<li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li>
<li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li>
<li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li>
<li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li>
<li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li>
<li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li>
<li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li>
<li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li>
</ul>
</li>
</ul>
</div>
<div class="col-md-12" id="main">
<div class="content">
<h1 class="page-title">Interface: Condition<T></h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="query.html">query</a>.</span>Condition<T></h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>The Condition interface defines all existing query filters</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="in"><span class="type-signature"></span>in<span class="type-signature"></span></h4>
<div class="description">
<p>Adds an “in” filter to the field</p>
<p>The field value must be equal to one of the given values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line135">line 135</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/in/">http://docs.mongodb.org/manual/reference/operator/query/in/</a></li>
</ul>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addFilter"><span class="type-signature"></span>addFilter<span class="signature">(field, filter, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a filter to this query</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>filter</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line423">line 423</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="between"><span class="type-signature"></span>between<span class="signature">(field, greaterValue, lessValue)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a between filter to the field. This is a shorthand for an less than and greater than filter.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>greaterValue</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The field value must be greater than this value</p></td>
</tr>
<tr>
<td class="name"><code>lessValue</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The field value must be less than this value</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="containsAll"><span class="type-signature"></span>containsAll<span class="signature">(field, …args)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a contains all filter to the collection field</p>
<p>The collection must contain all the given values.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type">*</span>
|
<span class="param-type">Array.<*></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The field value or values to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line205">line 205</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/all/">http://docs.mongodb.org/manual/reference/operator/query/all/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="containsAny"><span class="type-signature"></span>containsAny<span class="signature">(field, …args)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>The collection must contains one of the given values</p>
<p>Adds a contains any filter to the collection field.<br>Alias for <code>query.Condition#in</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type">*</span>
|
<span class="param-type">Array.<*></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The field value or values to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line420">line 420</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/in/">http://docs.mongodb.org/manual/reference/operator/query/in/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="eq"><span class="type-signature"></span>eq<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a equal filter to the field</p>
<p>All other other filters on the field will be discarded.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line337">line 337</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="equal"><span class="type-signature"></span>equal<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a equal filter to the field. All other other filters on the field will be discarded</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line31">line 31</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="ge"><span class="type-signature"></span>ge<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a greater than or equal to filter to the field</p>
<p>Shorthand for <code>query.Condition#greaterThanOrEqualTo</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line405">line 405</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/gte/">http://docs.mongodb.org/manual/reference/operator/query/gte/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="greaterThan"><span class="type-signature"></span>greaterThan<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a greater than filter to the field</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line59">line 59</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/gt/">http://docs.mongodb.org/manual/reference/operator/query/gt/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="greaterThanOrEqualTo"><span class="type-signature"></span>greaterThanOrEqualTo<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a greater than or equal to filter to the field</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line73">line 73</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/gte/">http://docs.mongodb.org/manual/reference/operator/query/gte/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="gt"><span class="type-signature"></span>gt<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a greater than filter to the field</p>
<p>Shorthand for <code>query.Condition#greaterThan</code>.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">string</span>
|
<span class="param-type">Date</span>
|
<span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span>
</td>
<td class="description last"><p>The value used to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line391">line 391</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/gt/">http://docs.mongodb.org/manual/reference/operator/query/gt/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="in"><span class="type-signature"></span>in<span class="signature">(field, …args)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a “in” filter to the field</p>
<p>The field value must be equal to one of the given values.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type">*</span>
|
<span class="param-type">Array.<*></span>
</td>
<td class="attributes">
<repeatable><br>
</td>
<td class="description last"><p>The field value or values to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line131">line 131</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="http://docs.mongodb.org/manual/reference/operator/query/in/">http://docs.mongodb.org/manual/reference/operator/query/in/</a></li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="isNotNull"><span class="type-signature"></span>isNotNull<span class="signature">(field)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a “is not null” filter to the field</p>
<p>The field value must not be null.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line188">line 188</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="isNull"><span class="type-signature"></span>isNull<span class="signature">(field)</span><span class="type-signature"> → {<a href="query.Filter.html">query.Filter.<T></a>}</span></h4>
<div class="description">
<p>Adds a “is null” filter to the field</p>
<p>The field value must be null.</p>
</div>
<h5>Parameters:</h5>
<table class="params table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>field</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The field to filter</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="lib_query_Condition.js.html">lib/query/Condition.js</a>, <a href="lib_query_Condition.js.html#line175">line 175</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>The resulting Query</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="query.Filter.html">query.Filter.<T></a></span>
</dd>
</dl>
<h4 class="name" id="le"><span class="type-signature"></span>le<span class="signature">(field, value)</span><span class="type-signature"> → {<a href="query.Filter.htm