docs: Document GiST and SP-GiST geography indexes#661
Open
charlesarchibong wants to merge 2 commits into
Open
Conversation
Document the gist/spgist index types for geography fields, the gist default, and the type/mixing restrictions, mirroring the spatial index support added in serverpod#5392. Also correct the spatial filter operator name (dwithin -> distanceWithin) to match the API, and note the fixed SRID (Geography.defaultSrid) and SQLite limitations on geography fields.
Include the verbatim code-generation error strings for invalid geography index types and for mixing geography with non-geography fields, so the behaviour matches what serverpod#5392 emits.
| A spatial index accelerates all spatial operations (`intersects`, `distanceWithin`, `distance`, `contains`, `within`). For tables with many rows and frequent spatial queries, adding one is strongly recommended. | ||
| ::: | ||
|
|
||
| Geography fields only support the `gist` and `spgist` index types. Specifying any other type fails code generation with `The "type" property must be one of: gist, spgist.` An index may cover several geography columns, but geography and non-geography fields cannot be mixed in the same index — doing so fails with `Mixing geography and non-geography fields in the same index is not allowed.` |
Contributor
There was a problem hiding this comment.
Nice catch on the dwithin → distanceWithin fix, and the error strings match the source. One small thing: we keep em dashes out of the docs. Splitting this into two sentences fixes it (and reads a touch cleaner):
Suggested change
| Geography fields only support the `gist` and `spgist` index types. Specifying any other type fails code generation with `The "type" property must be one of: gist, spgist.` An index may cover several geography columns, but geography and non-geography fields cannot be mixed in the same index — doing so fails with `Mixing geography and non-geography fields in the same index is not allowed.` | |
| Geography fields only support the `gist` and `spgist` index types. Specifying any other type fails code generation with `The "type" property must be one of: gist, spgist.` An index may cover several geography columns, but it cannot mix geography and non-geography fields. Doing so fails with `Mixing geography and non-geography fields in the same index is not allowed.` |
developerjamiu
added
the
documentation
developerjamiu
requested changes
Jun 29, 2026
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
2 participants
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.
Documents the new PostGIS geography support, mainly the GiST and SP-GiST spatial index work from serverpod/serverpod#5392, and fixes a couple of things in the existing geography docs while I was in there.
What's in here:
gistandspgisttypes,gistas the default when no type is given, the type restriction and the no-mixing rule, with the exact code-generation error strings quoted. Added anspgistexample and a note that SP-GiST needs a recent PostGIS.dwithin, but the real API isdistanceWithin. Checked against the serverpod source.Geography.defaultSrid, no per-column SRID yet) plus a SQLite limitation note (stored as EWKT text, spatial ops throw at query time).