INTPYTHON-835 Add support for GIS lookups #448
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,23 @@ | ||
| from django.contrib.gis.db.models.lookups import DistanceLookupFromFunction, GISLookup | ||
| from django.db import NotSupportedError | ||
|
|
||
| from django_mongodb_backend.query_utils import process_lhs, process_rhs | ||
|
|
||
|
|
||
| def gis_lookup(self, compiler, connection, as_expr=False): | ||
timgraham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if as_expr: | ||
| raise NotSupportedError("MongoDB does not support GIS lookups as expressions.") | ||
|
Collaborator
There was a problem hiding this comment. Consider this example: qs = Place.objects.annotate(
location_status=Case(
When(
area__contains=point,
then=Value("inside"),
),
default=Value("outside"),
output_field=CharField(),
)
)I wonder if the error message should be different. After, in a separate PR, those case could be handled in two steps (like group by does) Maybe: GIS operators cannot be composed? |
||
| lhs_mql = process_lhs(self, compiler, connection, as_expr=as_expr) | ||
| rhs_mql = process_rhs(self, compiler, connection, as_expr=as_expr) | ||
| if "subquery" in rhs_mql or "subquery" in lhs_mql: | ||
| raise NotSupportedError("MongoDB does not support GIS lookups with subqueries.") | ||
|
Collaborator
There was a problem hiding this comment. Do you have an example of this case? |
||
| try: | ||
| rhs_op = self.get_rhs_op(connection, rhs_mql) | ||
| except KeyError as e: | ||
| raise NotSupportedError(f"MongoDB does not support the '{self.lookup_name}' lookup.") from e | ||
| return rhs_op.as_mql(lhs_mql, rhs_mql, self.rhs_params) | ||
|
|
||
|
|
||
| def register_lookups(): | ||
| GISLookup.as_mql = gis_lookup | ||
| DistanceLookupFromFunction.as_mql = gis_lookup | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| from django.db import NotSupportedError | ||
|
|
||
|
|
||
| class Operator: | ||
| def as_sql(self, connection, lookup, template_params, sql_params): | ||
| # Return some dummy value to prevent str(queryset.query) from crashing. | ||
| # The output of as_sql() is meaningless for this no-SQL backend. | ||
| return self.name, [] | ||
|
|
||
|
|
||
| class Contains(Operator): | ||
| name = "contains" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| value_type = value["type"] | ||
| if value_type != "Point": | ||
| raise NotSupportedError( | ||
| "MongoDB does not support contains on non-Point query geometries." | ||
| ) | ||
| return { | ||
| field: { | ||
| "$geoIntersects": { | ||
| "$geometry": { | ||
| "type": value_type, | ||
| "coordinates": value["coordinates"], | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| class Disjoint(Operator): | ||
| name = "disjoint" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| return { | ||
| field: { | ||
| "$not": { | ||
| "$geoIntersects": { | ||
| "$geometry": { | ||
| "type": value["type"], | ||
| "coordinates": value["coordinates"], | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| class DistanceBase(Operator): | ||
| name = "distance_base" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| distance = params[0].m if hasattr(params[0], "m") else params[0] | ||
| if self.name == "distance_gt" or self.name == "distance_gte": | ||
| cmd = { | ||
| field: { | ||
| "$not": { | ||
| "$geoWithin": { | ||
| "$centerSphere": [ | ||
| value["coordinates"], | ||
| distance / 6378100, # radius of earth in meters | ||
| ], | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+55
to
+67
Contributor
There was a problem hiding this comment. Can this just be moved to
Contributor
Author
There was a problem hiding this comment. Can you be more specific? Having it here lets us reduce the code duplication.
Collaborator
There was a problem hiding this comment. I could see a refactor like this: [Incidentally, is gt vs. gte accounted for elsewhere?) diff --git a/django_mongodb_backend/gis/operators.py b/django_mongodb_backend/gis/operators.py
index cc24473..3824de5 100644
--- a/django_mongodb_backend/gis/operators.py
+++ b/django_mongodb_backend/gis/operators.py
@@ -52,22 +52,28 @@ class DistanceBase(Operator):
def as_mql(self, field, value, params=None):
distance = params[0].m if hasattr(params[0], "m") else params[0]
- if self.name == "distance_gt" or self.name == "distance_gte":
- cmd = {
- field: {
- "$not": {
- "$geoWithin": {
- "$centerSphere": [
- value["coordinates"],
- distance / 6378100, # radius of earth in meters
- ],
- }
- }
+ return self.get_mql(field, value, distance):
+
+ def get_mql(self, field, value, distance):
+ return {
+ field: {
+ "$geoWithin": {
+ "$centerSphere": [
+ value["coordinates"],
+ distance / 6378100, # radius of earth in meters
+ ],
}
}
+ return self.get_mql(field, value, distance):
+
+ def get_mql(self, field, value, distance):
+ return {
+ field: {
+ "$geoWithin": {
+ "$centerSphere": [
+ value["coordinates"],
+ distance / 6378100, # radius of earth in meters
+ ],
}
}
- else:
- cmd = {
- field: {
+ }
+
+
+class DistanceGT(DistanceBase):
+ name = "distance_gt"
+
+ def get_mql(self, field, value, distance):
+ return {
+ field: {
+ "$not": {
"$geoWithin": {
"$centerSphere": [
value["coordinates"],
@@ -76,14 +82,9 @@ class DistanceBase(Operator):
}
}
}
- return cmd
-
-
-class DistanceGT(DistanceBase):
- name = "distance_gt"
-
+ }
-class DistanceGTE(DistanceBase):
+class DistanceGTE(DistanceGT):
name = "distance_gte"
|
||
| else: | ||
| cmd = { | ||
| field: { | ||
| "$geoWithin": { | ||
| "$centerSphere": [ | ||
| value["coordinates"], | ||
| distance / 6378100, # radius of earth in meters | ||
| ], | ||
| } | ||
| } | ||
| } | ||
| return cmd | ||
|
|
||
|
|
||
| class DistanceGT(DistanceBase): | ||
| name = "distance_gt" | ||
|
|
||
|
|
||
| class DistanceGTE(DistanceBase): | ||
| name = "distance_gte" | ||
|
|
||
|
|
||
| class DistanceLT(DistanceBase): | ||
| name = "distance_lt" | ||
|
|
||
|
|
||
| class DistanceLTE(DistanceBase): | ||
| name = "distance_lte" | ||
|
|
||
|
|
||
| class DWithin(Operator): | ||
| name = "dwithin" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| return {field: {"$geoWithin": {"$centerSphere": [value["coordinates"], params[0]]}}} | ||
|
|
||
|
|
||
| class Intersects(Operator): | ||
| name = "intersects" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| return { | ||
| field: { | ||
| "$geoIntersects": { | ||
| "$geometry": { | ||
| "type": value["type"], | ||
| "coordinates": value["coordinates"], | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| class Within(Operator): | ||
| name = "within" | ||
|
|
||
| def as_mql(self, field, value, params=None): | ||
| return { | ||
| field: { | ||
| "$geoWithin": { | ||
| "$geometry": { | ||
| "type": value["type"], | ||
| "coordinates": value["coordinates"], | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| [ | ||
| { | ||
| "pk": "000000000000000000000001", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Houston", | ||
| "point": "POINT (-95.363151 29.763374)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000002", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Dallas", | ||
| "point": "POINT (-96.801611 32.782057)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000003", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Oklahoma City", | ||
| "point": "POINT (-97.521157 34.464642)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000004", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Wellington", | ||
| "point": "POINT (174.783117 -41.315268)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000005", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Pueblo", | ||
| "point": "POINT (-104.609252 38.255001)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000006", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Lawrence", | ||
| "point": "POINT (-95.235060 38.971823)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000007", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Chicago", | ||
| "point": "POINT (-87.650175 41.850385)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000008", | ||
| "model": "gis_tests_.city", | ||
| "fields": { | ||
| "name": "Victoria", | ||
| "point": "POINT (-123.305196 48.462611)" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000001", | ||
| "model": "gis_tests_.zipcode", | ||
| "fields" : { | ||
| "code" : "77002", | ||
| "poly" : "POLYGON ((-95.365015 29.772327, -95.362415 29.772327, -95.360915 29.771827, -95.354615 29.771827, -95.351515 29.772527, -95.350915 29.765327, -95.351015 29.762436, -95.350115 29.760328, -95.347515 29.758528, -95.352315 29.753928, -95.356415 29.756328, -95.358215 29.754028, -95.360215 29.756328, -95.363415 29.757128, -95.364014 29.75638, -95.363415 29.753928, -95.360015 29.751828, -95.361815 29.749528, -95.362715 29.750028, -95.367516 29.744128, -95.369316 29.745128, -95.373916 29.744128, -95.380116 29.738028, -95.387916 29.727929, -95.388516 29.729629, -95.387916 29.732129, -95.382916 29.737428, -95.376616 29.742228, -95.372616 29.747228, -95.378601 29.750846, -95.378616 29.752028, -95.378616 29.754428, -95.376016 29.754528, -95.374616 29.759828, -95.373616 29.761128, -95.371916 29.763928, -95.372316 29.768727, -95.365884 29.76791, -95.366015 29.767127, -95.358715 29.765327, -95.358615 29.766327, -95.359115 29.767227, -95.360215 29.767027, -95.362783 29.768267, -95.365315 29.770527, -95.365015 29.772327))" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000002", | ||
| "model": "gis_tests_.zipcode", | ||
| "fields" : { | ||
| "code" : "77005", | ||
| "poly" : "POLYGON ((-95.447918 29.727275, -95.428017 29.728729, -95.421117 29.729029, -95.418617 29.727629, -95.418517 29.726429, -95.402117 29.726629, -95.402117 29.725729, -95.395316 29.725729, -95.391916 29.726229, -95.389716 29.725829, -95.396517 29.715429, -95.397517 29.715929, -95.400917 29.711429, -95.411417 29.715029, -95.418417 29.714729, -95.418317 29.70623, -95.440818 29.70593, -95.445018 29.70683, -95.446618 29.70763, -95.447418 29.71003, -95.447918 29.727275))" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000003", | ||
| "model": "gis_tests_.zipcode", | ||
| "fields" : { | ||
| "code" : "77025", | ||
| "poly" : "POLYGON ((-95.418317 29.70623, -95.414717 29.706129, -95.414617 29.70533, -95.418217 29.70533, -95.419817 29.69533, -95.419484 29.694196, -95.417166 29.690901, -95.414517 29.69433, -95.413317 29.69263, -95.412617 29.68973, -95.412817 29.68753, -95.414087 29.685055, -95.419165 29.685428, -95.421617 29.68513, -95.425717 29.67983, -95.425017 29.67923, -95.424517 29.67763, -95.427418 29.67763, -95.438018 29.664631, -95.436713 29.664411, -95.440118 29.662231, -95.439218 29.661031, -95.437718 29.660131, -95.435718 29.659731, -95.431818 29.660331, -95.441418 29.656631, -95.441318 29.656331, -95.441818 29.656131, -95.441718 29.659031, -95.441118 29.661031, -95.446718 29.656431, -95.446518 29.673431, -95.446918 29.69013, -95.447418 29.71003, -95.446618 29.70763, -95.445018 29.70683, -95.440818 29.70593, -95.418317 29.70623))" | ||
| } | ||
| }, | ||
| { | ||
| "pk": "000000000000000000000004", | ||
| "model": "gis_tests_.zipcode", | ||
| "fields" : { | ||
| "code" : "77401", | ||
| "poly" : "POLYGON ((-95.447918 29.727275, -95.447418 29.71003, -95.446918 29.69013, -95.454318 29.68893, -95.475819 29.68903, -95.475819 29.69113, -95.484419 29.69103, -95.484519 29.69903, -95.480419 29.70133, -95.480419 29.69833, -95.474119 29.69833, -95.474119 29.70453, -95.472719 29.71283, -95.468019 29.71293, -95.468219 29.720229, -95.464018 29.720229, -95.464118 29.724529, -95.463018 29.725929, -95.459818 29.726129, -95.459918 29.720329, -95.451418 29.720429, -95.451775 29.726303, -95.451318 29.727029, -95.447918 29.727275))" | ||
| } | ||
| } | ||
| ] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.