Skip to content

Document changes to use_default_extent_for_getfeature #984

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

Merged
jmckenna merged 1 commit into from
Jan 15, 2025
Merged

Document changes to use_default_extent_for_getfeature #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 28 additions & 23 deletions en/ogc/ogc_api.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,29 +193,33 @@ Metadata
.. table::
:align: left

+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| Key | Level | Meaning |
+========================+=====================+=============================================================================================+
| onlineresource | Map | API root url, can't reuse WxS values |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| html_template_directory| Map | full path or relative (to mapfile) of html template directory |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| description | Map | service description, fall back to ows/wfs_abstract |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| links | Map, Layer | comma delimited list of link keys - references to other metadata |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| link_{key}_title | Map, Layer | link title |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| link_{key}_href | Map, Layer | link href (url) |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| html_tags | Map | comma delimited list of tag keys to expose to HTML templates - references to other metadata |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| tag_{key} | Map | value associated with the tag, added to JSON data in template.tags object |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| keywords | Layer | comma delimited list of keywords, fall back to ows/wfs_keywordlist |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
| max_limit | Map, Layer | map or layer-level maximum limit value (integer) |
+------------------------+---------------------+---------------------------------------------------------------------------------------------+
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| Key | Level | Meaning |
+======================================+=====================+=============================================================================================+
| onlineresource | Map | API root url, can't reuse WxS values |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| html_template_directory | Map | full path or relative (to mapfile) of html template directory |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| description | Map | service description, fall back to ows/wfs_abstract |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| links | Map, Layer | comma delimited list of link keys - references to other metadata |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| link_{key}_title | Map, Layer | link title |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| link_{key}_href | Map, Layer | link href (url) |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| html_tags | Map | comma delimited list of tag keys to expose to HTML templates - references to other metadata |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| tag_{key} | Map | value associated with the tag, added to JSON data in template.tags object |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| keywords | Layer | comma delimited list of keywords, fall back to ows/wfs_keywordlist |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| max_limit | Map, Layer | map or layer-level maximum limit value (integer) |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| use_default_extent_for_getfeature | Layer | (since 8.4) Use ``MAP`` ``EXTENT`` as a spatial filter if no bbox is in the request. |
| (optional) | | Setting to ``"false"`` can improve performance. |
| | | See also :ref:`wfs_use_default_extent_for_getfeature`. |
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+

Example OGC API Server Mapfile
******************************
Expand Down Expand Up @@ -280,6 +284,7 @@ Example OGC API Server Mapfile
"ows_abstract" "Oceans, NaturalEarth dataset, 2020"
"gml_include_items" "all" #REQUIRED
"gml_featureid" "ne_id" #REQUIRED
"oga_use_default_extent_for_getfeature" # Optional. Can improve performance.
END
TYPE POLYGON
STATUS ON
Expand Down
9 changes: 6 additions & 3 deletions en/ogc/wfs_server.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1365,13 +1365,16 @@ Layer Object
.. index::
triple: WFS; METADATA; wfs_use_default_extent_for_getfeature

.. _wfs_use_default_extent_for_getfeature:

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

Layer Metadata API
----------------------
Expand Down
Loading