Add Geo Filtering #704
Add Geo Filtering #704
Conversation
|
@abrookins @slorello89 I would greatly appreciate a review on this! We are looking to implement this in our app ASAP. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds geo filtering capabilities to the Redis OM library, enabling spatial queries on coordinate fields using Redis's FT.SEARCH with geo filters. The implementation uses pydantic-extra-types' Coordinate type with custom validators and serializers to handle Redis's coordinate format requirements.
Key Changes:
- Adds
Coordinatestype andGeoFilterclass for spatial queries with radius-based filtering - Implements automatic GEO field indexing for Coordinate-typed fields
- Extends query resolution to support geo filter operations
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds pydantic-extra-types dependency and bumps version |
| aredis_om/model/types.py | Defines Coordinates type with Redis format handling and GeoFilter class |
| aredis_om/model/model.py | Implements geo field detection, indexing, and query resolution |
| aredis_om/init.py | Exports new Coordinates and GeoFilter types |
| tests/test_json_model.py | Adds comprehensive test coverage for geo filtering with JsonModel |
| tests/test_hash_model.py | Adds comprehensive test coverage for geo filtering with HashModel |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
- Add comprehensive docstrings to GeoFilter class with usage examples - Add coordinate validation (longitude: -180 to 180, latitude: -90 to 90) - Add radius validation (must be positive) - Add from_coordinates() convenience class method - Improve error messages with actual invalid values - Add return type hints for better type safety - Add clarifying comments in tests about distance calculations These improvements address GitHub Copilot suggestions and enhance the robustness and usability of the geographic filtering feature.
bsbodden
force-pushed
the
add-geofilter
branch
from
82472c4 to
b2f37a5
Compare
I appreciate the additions @bsbodden ! |
This PR adds the ability to use
FT.SEARCHwith a Geo Filter to filter objects based on a specific Radius.To store the coordinates, I used the
pydantic-extra-typesCoordinatetype. This did not align with how Redis expected the coordinates to be stored so I added a validator and a serializer to account for that.When generating the index, I have it checking for the type to see whether it should be indexed as a GEO field. Any fields that want to search using radius must have the field typed as a
Coordinatestype and haveindex=Truein theFieldobject.When searching, it also checks for the field type to know that it needs to use a
GeoFilterto search. If the search value is not aGeoFilterobject, it will raise an error. I have it just working with theEQoperator but we could technically have it work against any operator. I don't really see any other use case for any other operators.