Skip to content

Add configurable spatial field name option #351

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

Open
minhajuddin2510 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Add configurable spatial field name option #351

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8638a0c
Use configurable spatial field name in dataset_dict
minhajuddin2510 Dec 29, 2025
5df5392
Refactor spatial query to use configurable field name
minhajuddin2510 Dec 29, 2025
4776da9
Document customization of Solr field name
minhajuddin2510 Dec 29, 2025
a3e1a59
Update spatial field name configuration retrieval
minhajuddin2510 Jan 23, 2026
eb14300
Update Solr field name configuration in documentation
minhajuddin2510 Jan 23, 2026
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
15 changes: 8 additions & 7 deletions ckanext/spatial/search/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,8 +192,8 @@ def index_dataset(self, dataset_dict):
return dataset_dict
wkt = shape.wkt

dataset_dict["spatial_geom"] = wkt

spatial_field_name = config.get("ckanext.spatial.field_name", "spatial_geom")
dataset_dict[spatial_field_name] = wkt
return dataset_dict

def search_params(self, bbox, search_params):
Expand All @@ -202,13 +202,14 @@ def search_params(self, bbox, search_params):

if not search_params.get("fq_list"):
search_params["fq_list"] = []

default_spatial_query = "{{!field f=spatial_geom}}Intersects(ENVELOPE({minx}, {maxx}, {maxy}, {miny}))"


spatial_field_name = config.get("ckanext.spatial.field_name", "spatial_geom")

default_spatial_query = "{{!field f={spatial_field}}}Intersects(ENVELOPE({minx}, {maxx}, {maxy}, {miny}))"
spatial_query = config.get("ckanext.spatial.solr_query", default_spatial_query)

search_params["fq_list"].append(
spatial_query.format(spatial_field="spatial_geom", **bbox)
spatial_query.format(spatial_field=spatial_field_name, **bbox)
)

return search_params
Expand Down
5 changes: 5 additions & 0 deletions doc/spatial-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,11 @@ images):
```
{{!field f=spatial_geom}}Intersects(ENVELOPE({minx}, {maxx}, {maxy}, {miny}))
```

You can also customize the Solr field name using:
```
ckanext.spatial.field_name = my_custom_geom_field
```

!!! Note
The old `postgis` search backend is no longer supported. You should
Expand Down