Skip to content

Add js geoquery sorted parameter #529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 13, 2018
Merged

Add js geoquery sorted parameter #529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b64f00c
added mongoDB performance caveat when using near and sorting constraint
mtrezza Jun 13, 2018
a3fa330
added examples for sorted parameter
mtrezza Jun 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions _includes/js/geopoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,40 @@ query.find({

At this point `placesObjects` will be an array of objects ordered by distance (nearest to farthest) from `userGeoPoint`. Note that if an additional `ascending()`/`descending()` order-by constraint is applied, it will take precedence over the distance ordering.

To limit the results using distance, check out `withinMiles`, `withinKilometers`, and `withinRadians`.
To limit the results using distance, check out `withinMiles`, `withinKilometers`, and `withinRadians`. Use the `sorted` parameter to sort the results by distance ascending.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use the sorted parameter to sort the results by distance ascending.

suggestion: By default, the results will come back sorted by their distance and you can disable it with the sorted parameter.


<pre><code class="javascript">
var location = new Parse.GeoPoint(37.708813, -122.526398);
var distance = 5;
var sorted = true;

var query = new Parse.Query(PizzaPlaceObject);
query.withinKilometers("location", location, distance, sorted);
query.find({
success: function(pizzaPlacesInSF) {
// Pizza places within 5km sorted by distance
...
}
});
</code></pre>

If you add an additional sorting constraint set the `sorting` parameter to `false` for better query performance.

<pre><code class="javascript">
var location = new Parse.GeoPoint(37.708813, -122.526398);
var distance = 5;
var sorted = false;

var query = new Parse.Query(PizzaPlaceObject);
query.withinKilometers("location", location, distance, sorted);
query.descending("rating");
query.find({
success: function(pizzaPlacesInSF) {
// Pizza places within 5km sorted by rating
...
}
});
</code></pre>

It's also possible to query for the set of objects that are contained within a particular area. To find the objects in a rectangular bounding box, add the `withinGeoBox` restriction to your `Parse.Query`.

Expand Down Expand Up @@ -95,4 +128,5 @@ At the moment there are a couple of things to watch out for:

1. Each Parse.Object class may only have one key with a Parse.GeoPoint object.
2. Using the `near` constraint will also limit results to within 100 miles.
3. Points should not equal or exceed the extreme ends of the ranges. Latitude should not be -90.0 or 90.0. Longitude should not be -180.0 or 180.0. Attempting to set latitude or longitude out of bounds will cause an error.
3. Using the `near` constraint combined with an `ascending` or `descending` constraint is not recommended due to performance. This is because `$near` sorts objects by distance and an additional sort constraint re-orders the matching objects, effectively overriding the sort operation already performed.
4. Points should not equal or exceed the extreme ends of the ranges. Latitude should not be -90.0 or 90.0. Longitude should not be -180.0 or 180.0. Attempting to set latitude or longitude out of bounds will cause an error.