WhereQuery [class]

Description

A fluent API operation for creating a filter for a query by chaining different rules.

Access: protected

Members

Instance members

Name Return type Description
all(field, value) WhereQuery Adds a condition that a field must include all of the specified values. Applicable to Array fields.
and() WhereQuery Adds an and clause to the current condition and returns it for further chaining.
done() Query Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent Query. All other WhereQuery methods return the current instance of WhereQuery to allow chaining.
endsWith(field, value, [options]) WhereQuery Adds a condition that a field value must end with a specified string.
eq(field, value) WhereQuery Adds a condition that a field must be equal to a specific value.
equal(field, value) WhereQuery Adds a condition that a field must be equal to a specific value.
greaterThan(field, value) WhereQuery Adds a condition that a field must be greater than a certain value. Applicable to Number, String, and Date fields.
greaterThanEqual(field, value) WhereQuery Adds a condition that a field must be greater than or equal to a certain value. Applicable to Number, String, and Date fields.
gt(field, value) WhereQuery Adds a condition that a field must be greater than a certain value. Applicable to Number, String, and Date fields.
gte(field, value) WhereQuery Adds a condition that a field must be greater than or equal to a certain value. Applicable to Number, String, and Date fields.
isin(field, value) WhereQuery Adds a condition that a field must be in a set of values.
lessThan(field, value) WhereQuery Adds a condition that a field must be less than a certain value. Applicable to Number, String, and Date fields.
lessThanEqual(field, value) WhereQuery Adds a condition that a field must be less than or equal to a certain value. Applicable to Number, String, and Date fields.
lt(field, value) WhereQuery Adds a condition that a field must be less than a certain value. Applicable to Number, String, and Date fields.
lte(field, value) WhereQuery Adds a condition that a field must be less than or equal to a certain value. Applicable to Number, String, and Date fields.
ne(field, value) WhereQuery Adds a condition that a field must not be equal to a specific value.
nearSphere(field, point, distance, [metrics]) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a certain distance from another geopoint. Applicable to GeoPoint fields only.
not() WhereQuery Adds a not clause to the current condition and returns it for further chaining.
notEqual(field, value) WhereQuery Adds a condition that a field must not be equal to a specific value.
notin(field, value) WhereQuery Adds a condition that a field must not be in a set of values.
or() WhereQuery Adds an or clause to the current condition and returns it for further chaining.
regex(field, regularExpression, [options]) WhereQuery Adds a condition that a field must satisfy a specified regex.
size(field, value) WhereQuery Adds a condition that a field must contain an array whose length is larger than a specified value. Applicable to Array fields.
startsWith(field, value, [options]) WhereQuery Adds a condition that a field value must start with a specified string.
withinBox(field, pointBottomLeft, pointUpperRight) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a specified coordinate rectangle. Applicable to GeoPoint fields only.
withinCenterSphere(field, center, radius, [metrics]) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a coordinate circle. Applicable to GeoPoint fields only.
withinPolygon(field, points) WhereQuery Adds a Geospatial condition that a specified geopoint must be within a specified coordinate polygon. The polygon is specified as an array of geopoints. The last point in the array is implicitly connected to the first point thus closing the shape. Applicable to GeoPoint fields only.
Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.