Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions en/development/rfc/ms-rfc-52.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _rfc52:

MS RFC 52: One-pass query processing
======================================================================

Expand Down
39 changes: 35 additions & 4 deletions en/ogc/ogc_api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,6 @@ Metadata
+--------------------------------------+---------------------+---------------------------------------------------------------------------------------------+
| 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 @@ -520,6 +516,26 @@ Web Object Metadata
The extra parameters are available in HTML templates for the OGC Features API as ``{{ template.extra_params }}``.
The templates supplied in the MapServer repository append this value to all URLs by default.

.. index::
triple: OGCAPI; METADATA; oga_features_cache_count

**oga_features_cache_count**

.. versionadded:: 8.8.0

- *Description:* (Optional) (or ``ows_features_cache_count``)
Number of features to cache. See :ref:`wfs_features_cache_count` for details.

.. index::
triple: OGCAPI; METADATA; oga_features_cache_size

**oga_features_cache_size**

.. versionadded:: 8.8.0

- *Description:* (Optional) (or ``ows_features_cache_size``)
Size of cache in bytes. See :ref:`wfs_features_cache_size` for details.

.. index::
triple: OGCAPI; METADATA; ows_schemas_location

Expand All @@ -532,3 +548,18 @@ Web Object Metadata
the family of OGC API JSON Schema files are located. This must be a valid URL
where the actual .yaml files are located if you want your OpenAPI description
to be valid. Default is *http://schemas.opengis.net*

.. index::
triple: OGCAPI; METADATA; oga_use_default_extent_for_getfeature

Layer Object Metadata
---------------------

**oga_use_default_extent_for_getfeature**

.. versionadded:: 8.4.0

- *Description:* (Optional) (or ``ows_use_default_extent_for_getfeature``)
Use ``MAP`` ``EXTENT`` as a spatial filter if no bbox is in the request.
Setting to ``"false"`` can improve performance. See WFS equivalent
at :ref:`wfs_use_default_extent_for_getfeature`.
48 changes: 36 additions & 12 deletions en/ogc/wfs_server.txt
Original file line number Diff line number Diff line change
Expand Up @@ -811,24 +811,48 @@ Web Object Metadata
.. index::
triple: WFS; METADATA; wfs_features_cache_count

.. _wfs_features_cache_count:

**wfs_features_cache_count**
(Optional, since MapServer 7.2) Maximum number of features retrieved during
the first query pass that should be cached, so as not to be asked again to
the datasource. This might be set to the same value as wfs_maxfeatures, but
not necessarily. If wfs_features_cache_size is also set, the most limiting
will be honoured.
Note: this is an advanced setting.
(Optional; available since MapServer 7.2) Maximum number of features
retrieved during the first query pass that may be cached in memory.
When set, features are stored so they do not need to be requested again
from the datasource when generating the output.

This value may be set to the same value as ``wfs_maxfeatures``, but this
is not required.

If :ref:`wfs_features_cache_size` (which provides additional details) is
also set, the more restrictive limit (size or count) will be honoured.

Note: This is an advanced setting.

``ows_features_cache_count`` can also be used (since MapServer 8.8).

.. index::
triple: WFS; METADATA; wfs_features_cache_size

.. _wfs_features_cache_size:

**wfs_features_cache_size**
(Optional, since MapServer 7.2) Maximum amount of RAM allowed to cache
features during the first query pass, so as not to be asked again to
the datasource when generating the GML or OGR output.
If wfs_features_cache_count is also set, the most limiting will be honoured.
By default the value is in bytes, unless the " MB" suffix is specified.
Note: this is an advanced setting.
(Optional; available since MapServer 7.2) Maximum amount of RAM (in bytes)
that may be used to cache features during the first query pass. When set,
features retrieved from the datasource are stored in memory so they do not
need to be requested again when generating the GML or OGR output.

This setting has no effect for :ref:`oci` or :ref:`input_postgis`, but can be
used by :ref:`mssql`, some :ref:`ogr` drivers, and any other datasources
that do not support :ref:`rfc52`.

If ``wfs_features_cache_count`` is also set, the more restrictive (smaller)
value will be honoured.

The default unit is bytes. A value in megabytes may be specified by adding
the " MB" suffix (for example, ``"10 MB"``).

Note: This is an advanced setting.

``ows_features_cache_size`` can also be used (since MapServer 8.8).

.. index::
triple: WFS; METADATA; wfs_fees
Expand Down