Constructor
new Query(objectClass)
Parameters:
Name | Type | Description |
---|---|---|
objectClass |
String
|
Parse.Object
|
An instance of a subclass of Parse.Object, or a Parse className string. |
Methods
(static) and(…var_args) → {Parse.Query}
Constructs a Parse.Query that is the AND of the passed in queries. For example:
var compoundQuery = Parse.Query.and(query1, query2, query3);
will create a compoundQuery that is an and of the query1, query2, and query3.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
var_args |
Parse.Query
|
<repeatable> |
The list of queries to AND. |
(static) fromJSON(className, json) → {Parse.Query}
Static method to restore Parse.Query by json representation Internally calling Parse.Query.withJSON
Parameters:
Name | Type | Description |
---|---|---|
className |
String
|
|
json |
QueryJSON
|
from Parse.Query.toJSON() method |
(static) nor(…var_args) → {Parse.Query}
Constructs a Parse.Query that is the NOR of the passed in queries. For example:
const compoundQuery = Parse.Query.nor(query1, query2, query3);
will create a compoundQuery that is a nor of the query1, query2, and query3.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
var_args |
Parse.Query
|
<repeatable> |
The list of queries to NOR. |
(static) or(…var_args) → {Parse.Query}
Constructs a Parse.Query that is the OR of the passed in queries. For example:
var compoundQuery = Parse.Query.or(query1, query2, query3);
will create a compoundQuery that is an or of the query1, query2, and query3.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
var_args |
Parse.Query
|
<repeatable> |
The list of queries to OR. |
_addCondition()
Helper for condition queries
_andQuery(queries) → {Parse.Query}
Adds constraint that all of the passed in queries match.
Parameters:
Name | Type | Description |
---|---|---|
queries |
Array
|
_norQuery(queries) → {Parse.Query}
Adds constraint that none of the passed in queries match.
Parameters:
Name | Type | Description |
---|---|---|
queries |
Array
|
_orQuery(queries) → {Parse.Query}
Adds constraint that at least one of the passed in queries matches.
Parameters:
Name | Type | Description |
---|---|---|
queries |
Array
|
_regexStartWith()
Converts string for regular expression at the beginning
addAscending(key) → {Parse.Query}
Sorts the results in ascending order by the given key, but can also add secondary sort descriptors without overwriting _order.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
Array.<String>
|
String
|
The key to order by, which is a string of comma separated values, or an Array of keys, or multiple keys. |
addDescending(key) → {Parse.Query}
Sorts the results in descending order by the given key, but can also add secondary sort descriptors without overwriting _order.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
Array.<String>
|
String
|
The key to order by, which is a string of comma separated values, or an Array of keys, or multiple keys. |
aggregate(pipeline, options) → {Promise}
Executes an aggregate query and returns aggregate results
Parameters:
Name | Type | Description |
---|---|---|
pipeline |
Mixed
|
Array or Object of stages to process query |
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the query completes.
ascending(key) → {Parse.Query}
Sorts the results in ascending order by the given key.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
Array.<String>
|
String
|
The key to order by, which is a string of comma separated values, or an Array of keys, or multiple keys. |
containedBy(key, values) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be contained by the provided list of values. Get objects where all array elements match.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
values |
Array
|
The values that will match. |
containedIn(key, values) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be contained in the provided list of values.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
values |
Array
|
The values that will match. |
contains(key, substring) → {Parse.Query}
Adds a constraint for finding string values that contain a provided string. This may be slow for large datasets.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the string to match is stored in. |
substring |
String
|
The substring that the value must contain. |
containsAll(key, values) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to contain each one of the provided list of values.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. This key's value must be an array. |
values |
Array
|
The values that will match. |
containsAllStartingWith(key, values) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to contain each one of the provided list of values starting with given strings.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. This key's value must be an array. |
values |
Array.<String>
|
The string values that will match as starting string. |
count(options) → {Promise}
Counts the number of objects that match this query. Either options.success or options.error is called when the count completes.
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the count when the query completes.
descending(key) → {Parse.Query}
Sorts the results in descending order by the given key.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
Array.<String>
|
String
|
The key to order by, which is a string of comma separated values, or an Array of keys, or multiple keys. |
distinct(key, options) → {Promise}
Executes a distinct query and returns unique values
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
A field to find distinct values |
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the query completes.
doesNotExist(key) → {Parse.Query}
Adds a constraint for finding objects that do not contain a given key.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that should not exist |
doesNotMatchKeyInQuery(key, queryKey, query) → {Parse.Query}
Adds a constraint that requires that a key's value not match a value in an object returned by a different Parse.Query.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that contains the value that is being excluded. |
queryKey |
String
|
The key in the objects returned by the query to match against. |
query |
Parse.Query
|
The query to run. |
doesNotMatchQuery(key, query) → {Parse.Query}
Adds a constraint that requires that a key's value not matches a Parse.Query constraint.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the contains the object to match the query. |
query |
Parse.Query
|
The query that should not match. |
each(callback, options) → {Promise}
Iterates over each result of a query, calling a callback for each one. If the callback returns a promise, the iteration will not continue until that promise has been fulfilled. If the callback returns a rejected promise, then iteration will stop with that error. The items are processed in an unspecified order. The query may not have any sort order, and may not use limit or skip.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function
|
Callback that will be called with each result of the query. |
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that will be fulfilled once the iteration has completed.
endsWith(key, suffix) → {Parse.Query}
Adds a constraint for finding string values that end with a provided string. This will be slow for large datasets.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the string to match is stored in. |
suffix |
String
|
The substring that the value must end with. |
equalTo(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be equal to the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that the Parse.Object must contain. |
exists(key) → {Parse.Query}
Adds a constraint for finding objects that contain the given key.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that should exist. |
find(options) → {Promise}
Retrieves a list of ParseObjects that satisfy this query. Either options.success or options.error is called when the find completes.
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the results when the query completes.
first(options) → {Promise}
Retrieves at most one Parse.Object that satisfies this query.
Either options.success or options.error is called when it completes. success is passed the object if there is one. otherwise, undefined.
Parameters:
Name | Type | Description |
---|---|---|
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the object when the query completes.
fullText(key, value, options) → {Parse.Query}
Adds a constraint for finding string values that contain a provided string. This may be slow for large datasets. Requires Parse-Server > 2.5.0
In order to sort you must use select and ascending ($score is required)
query.fullText('field', 'term'); query.ascending('$score'); query.select('$score');
To retrieve the weight / rank
object->get('score');
You can define optionals by providing an object as a third parameter
query.fullText('field', 'term', { language: 'es', diacriticSensitive: true });
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key |
String
|
The key that the string to match is stored in. |
||||||||||||
value |
String
|
The string to search |
||||||||||||
options |
Object
|
(Optional)
|
get(objectId, options) → {Promise}
Constructs a Parse.Object whose id is already known by fetching data from
the server. Either options.success or options.error is called when the
find completes. Unlike the first
method, it never returns undefined.
Parameters:
Name | Type | Description |
---|---|---|
objectId |
String
|
The id of the object to be fetched. |
options |
Object
|
Valid options are:
|
Returns:
- Type:
-
Promise
A promise that is resolved with the result when the query completes.
greaterThan(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be greater than the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that provides an lower bound. |
greaterThanOrEqualTo(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be greater than or equal to the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that provides an lower bound. |
include(key) → {Parse.Query}
Includes nested Parse.Objects for the provided key. You can use dot notation to specify which fields in the included object are also fetched.
You can include all nested Parse.Objects by passing in '*'. Requires Parse Server 3.0.0+
query.include('*');
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
Array.<String>
|
The name(s) of the key(s) to include. |
lessThan(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be less than the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that provides an upper bound. |
lessThanOrEqualTo(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be less than or equal to the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that provides an upper bound. |
limit(n) → {Parse.Query}
Sets the limit of the number of results to return. The default limit is 100, with a maximum of 1000 results being returned at a time.
Parameters:
Name | Type | Description |
---|---|---|
n |
Number
|
the number of results to limit to. |
matches(key, regex) → {Parse.Query}
Adds a regular expression constraint for finding string values that match the provided regular expression. This may be slow for large datasets.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the string to match is stored in. |
regex |
RegExp
|
The regular expression pattern to match. |
matchesKeyInQuery(key, queryKey, query) → {Parse.Query}
Adds a constraint that requires that a key's value matches a value in an object returned by a different Parse.Query.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that contains the value that is being matched. |
queryKey |
String
|
The key in the objects returned by the query to match against. |
query |
Parse.Query
|
The query to run. |
matchesQuery(key, query) → {Parse.Query}
Adds a constraint that requires that a key's value matches a Parse.Query constraint.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the contains the object to match the query. |
query |
Parse.Query
|
The query that should match. |
near(key, point) → {Parse.Query}
Adds a proximity based constraint for finding objects with key point values near the point given.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the Parse.GeoPoint is stored in. |
point |
Parse.GeoPoint
|
The reference Parse.GeoPoint that is used. |
notContainedIn(key, values) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to not be contained in the provided list of values.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
values |
Array
|
The values that will not match. |
notEqualTo(key, value) → {Parse.Query}
Adds a constraint to the query that requires a particular key's value to be not equal to the provided value.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to check. |
value |
The value that must not be equalled. |
polygonContains(key, GeoPoint) → {Parse.Query}
Add a constraint to the query that requires a particular key's coordinates that contains a ParseGeoPoint
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to be constrained. |
GeoPoint |
Parse.GeoPoint
|
select(…keys) → {Parse.Query}
Restricts the fields of the returned Parse.Objects to include only the provided keys. If this is called multiple times, then all of the keys specified in each of the calls will be included.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
keys |
String
|
Array.<String>
|
<repeatable> |
The name(s) of the key(s) to include. |
skip(n) → {Parse.Query}
Sets the number of results to skip before returning any results. This is useful for pagination. Default is to skip zero results.
Parameters:
Name | Type | Description |
---|---|---|
n |
Number
|
the number of results to skip. |
startsWith(key, prefix) → {Parse.Query}
Adds a constraint for finding string values that start with a provided string. This query will use the backend index, so it will be fast even for large datasets.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the string to match is stored in. |
prefix |
String
|
The substring that the value must start with. |
subscribe() → {LiveQuerySubscription}
Subscribe this query to get liveQuery updates
Returns:
- Type:
-
LiveQuerySubscription
Returns the liveQuerySubscription, it's an event emitter which can be used to get liveQuery updates.
toJSON() → {Object}
Returns a JSON representation of this query.
Returns:
- Type:
-
Object
The JSON representation of the query.
withinGeoBox(key, southwest, northeast) → {Parse.Query}
Adds a constraint to the query that requires a particular key's coordinates be contained within a given rectangular geographic bounding box.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to be constrained. |
southwest |
Parse.GeoPoint
|
The lower-left inclusive corner of the box. |
northeast |
Parse.GeoPoint
|
The upper-right inclusive corner of the box. |
withinKilometers(key, point, maxDistance, sorted) → {Parse.Query}
Adds a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. Radius of earth used is 6371.0 kilometers.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the Parse.GeoPoint is stored in. |
point |
Parse.GeoPoint
|
The reference Parse.GeoPoint that is used. |
maxDistance |
Number
|
Maximum distance (in kilometers) of results to return. |
sorted |
Boolean
|
A Bool value that is true if results should be sorted by distance ascending, false is no sorting is required, defaults to true. |
withinMiles(key, point, maxDistance, sorted) → {Parse.Query}
Adds a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given. Radius of earth used is 3958.8 miles.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the Parse.GeoPoint is stored in. |
point |
Parse.GeoPoint
|
The reference Parse.GeoPoint that is used. |
maxDistance |
Number
|
Maximum distance (in miles) of results to return. |
sorted |
Boolean
|
A Bool value that is true if results should be sorted by distance ascending, false is no sorting is required, defaults to true. |
withinPolygon(key, array) → {Parse.Query}
Adds a constraint to the query that requires a particular key's coordinates be contained within and on the bounds of a given polygon. Supports closed and open (last point is connected to first) paths
Polygon must have at least 3 points
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key to be constrained. |
array |
Array
|
of geopoints |
withinRadians(key, point, maxDistance, sorted) → {Parse.Query}
Adds a proximity based constraint for finding objects with key point values near the point given and within the maximum distance given.
Parameters:
Name | Type | Description |
---|---|---|
key |
String
|
The key that the Parse.GeoPoint is stored in. |
point |
Parse.GeoPoint
|
The reference Parse.GeoPoint that is used. |
maxDistance |
Number
|
Maximum distance (in radians) of results to return. |
sorted |
Boolean
|
A Bool value that is true if results should be sorted by distance ascending, false is no sorting is required, defaults to true. |
withJSON(json) → {Parse.Query}
Return a query with conditions from json, can be useful to send query from server side to client Not static, all query conditions was set before calling this method will be deleted. For example on the server side we have var query = new Parse.Query("className"); query.equalTo(key: value); query.limit(100); ... (others queries) Create JSON representation of Query Object var jsonFromServer = query.fromJSON();
On client side getting query: var query = new Parse.Query("className"); query.fromJSON(jsonFromServer);
and continue to query... query.skip(100).find().then(...);
Parameters:
Name | Type | Description |
---|---|---|
json |
QueryJSON
|
from Parse.Query.toJSON() method |