Skip to content

Commit f8dfc8f

Browse files
github-actions[bot]geographika
github-actions[bot]
and
geographika
authored
Document changes to use_default_extent_for_getfeature (#995)
Co-authored-by: sethg <sethg@geographika.co.uk>
1 parent e9b8c12 commit f8dfc8f

File tree

2 files changed

+34
-26
lines changed

2 files changed

+34
-26
lines changed

‎en/ogc/ogc_api.txt‎

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -193,29 +193,33 @@ Metadata
193193
.. table::
194194
:align: left
195195

196-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
197-
| Key | Level | Meaning |
198-
+========================+=====================+=============================================================================================+
199-
| onlineresource | Map | API root url, can't reuse WxS values |
200-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
201-
| html_template_directory| Map | full path or relative (to mapfile) of html template directory |
202-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
203-
| description | Map | service description, fall back to ows/wfs_abstract |
204-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
205-
| links | Map, Layer | comma delimited list of link keys - references to other metadata |
206-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
207-
| link_{key}_title | Map, Layer | link title |
208-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
209-
| link_{key}_href | Map, Layer | link href (url) |
210-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
211-
| html_tags | Map | comma delimited list of tag keys to expose to HTML templates - references to other metadata |
212-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
213-
| tag_{key} | Map | value associated with the tag, added to JSON data in template.tags object |
214-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
215-
| keywords | Layer | comma delimited list of keywords, fall back to ows/wfs_keywordlist |
216-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
217-
| max_limit | Map, Layer | map or layer-level maximum limit value (integer) |
218-
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
196+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
197+
| Key | Level | Meaning |
198+
+======================================+=====================+=============================================================================================+
199+
| onlineresource | Map | API root url, can't reuse WxS values |
200+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
201+
| html_template_directory | Map | full path or relative (to mapfile) of html template directory |
202+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
203+
| description | Map | service description, fall back to ows/wfs_abstract |
204+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
205+
| links | Map, Layer | comma delimited list of link keys - references to other metadata |
206+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
207+
| link_{key}_title | Map, Layer | link title |
208+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
209+
| link_{key}_href | Map, Layer | link href (url) |
210+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
211+
| html_tags | Map | comma delimited list of tag keys to expose to HTML templates - references to other metadata |
212+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
213+
| tag_{key} | Map | value associated with the tag, added to JSON data in template.tags object |
214+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
215+
| keywords | Layer | comma delimited list of keywords, fall back to ows/wfs_keywordlist |
216+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
217+
| max_limit | Map, Layer | map or layer-level maximum limit value (integer) |
218+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
219+
| use_default_extent_for_getfeature | Layer | (since 8.4) Use ``MAP`` ``EXTENT`` as a spatial filter if no bbox is in the request. |
220+
| (optional) | | Setting to ``"false"`` can improve performance. |
221+
| | | See also :ref:`wfs_use_default_extent_for_getfeature`. |
222+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
219223

220224
Example OGC API Server Mapfile
221225
******************************
@@ -280,6 +284,7 @@ Example OGC API Server Mapfile
280284
"ows_abstract" "Oceans, NaturalEarth dataset, 2020"
281285
"gml_include_items" "all" #REQUIRED
282286
"gml_featureid" "ne_id" #REQUIRED
287+
"oga_use_default_extent_for_getfeature" # Optional. Can improve performance.
283288
END
284289
TYPE POLYGON
285290
STATUS ON

‎en/ogc/wfs_server.txt‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1365,13 +1365,16 @@ Layer Object
13651365
.. index::
13661366
triple: WFS; METADATA; wfs_use_default_extent_for_getfeature
13671367

1368+
.. _wfs_use_default_extent_for_getfeature:
1369+
13681370
**wfs_use_default_extent_for_getfeature**
13691371
(Optional, since MapServer 7.0.4) Whether the MAP.EXTENT should be used in
13701372
request to datasources in the absence of other spatial filter. This is the
13711373
default behaviour, but this might affect performance in some use cases. In
1372-
those cases, setting this item to "false" will avoid he default spatial filter to
1373-
be appended to the request. This is only implemented for OGR datasources (since 7.0.4)
1374-
and MSSQL2008 connections (since 7.6)
1374+
those cases, setting this item to "false" will avoid the default spatial filter to
1375+
be appended to the request. This is only implemented for OGR datasources (since 7.0.4),
1376+
MSSQL2008 (since 7.6), and PostGIS connections (since 8.4).
1377+
Use **ows_use_default_extent_for_getfeature** to set for both WFS and :ref:`ogcapi`.
13751378

13761379
Layer Metadata API
13771380
----------------------

0 commit comments

Comments
 (0)