docs(graphile-postgis): deep spatial-relations docs; lead with client-side GeoJSON problem#995
Merged
pyramation merged 2 commits intomainfrom Apr 18, 2026
Merged
Conversation
…ient-side GeoJSON problem
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
2 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Documentation-only rewrite of
graphile/graphile-postgis/README.mdto go deep on the@spatialRelationsmart-tag feature and lead with why it exists.## Spatial relations via smart tagssection with:where: { county: { some: … } }query.whereshape — ORM and GraphQL examples,some/every/nonesemantics,st_dwithin+distance, composition withand/or/not.@spatialRelationSkipIndexCheckopt-out),geometryvsgeography, and FAQ.where; the word "filter" only appears where it literally names the PostGraphile-generated connection argument.graphql/orm-test/__tests__/postgis-spatial-relations.test.ts) and its seed SQL.No code changes to the plugin, tests, or any other package.
Review & Testing Checklist for Human
graphile/graphile-postgis/src/plugins/spatial-relations.ts— especially therelationNameregex, the existence / exact spelling of the@spatialRelationSkipIndexCheckopt-out tag, and thedistance: Float!field shape.COMMENT ON COLUMNbody (i.e. the plugin actually parses newline-separated@spatialRelationlines the way shown).st_bbox_intersects→&¬e against the plugin's code generator.Notes
devin/<ts>-…tofeat/postgis-spatial-relations-deep-docsper the repo's branch-naming convention.Link to Devin session: https://app.devin.ai/sessions/059b0c2e4594474aa107e3f83f83fe0f
Requested by: @pyramation