Skip to content

Commit b0f9765

Browse files
author
MapServer deploybot
committed
update with results of commit MapServer/MapServer-documentation@f8dfc8f 
1 parent 040ecb6 commit b0f9765

File tree

7 files changed

+50
-33
lines changed

7 files changed

+50
-33
lines changed

‎_sources/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

‎_sources/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
----------------------

‎mapscript/mapscript-api/stub/mapscript.shapeObj.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h3>Navigation</h3>
128128
<h1>mapscript.shapeObj<a class="headerlink" href="#mapscript-shapeobj" title="Link to this heading"></a></h1>
129129
<dl class="py class">
130130
<dt class="sig sig-object py" id="mapscript.shapeObj">
131-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mapscript.</span></span><span class="sig-name descname"><span class="pre">shapeObj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">&lt;MagicMock</span> <span class="pre">id='139944054979024'&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mapscript.shapeObj" title="Link to this definition"></a></dt>
131+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mapscript.</span></span><span class="sig-name descname"><span class="pre">shapeObj</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">&lt;MagicMock</span> <span class="pre">id='140427245074848'&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mapscript.shapeObj" title="Link to this definition"></a></dt>
132132
<dd><p>Each feature of a layer’s data is a <a class="reference internal" href="#mapscript.shapeObj" title="mapscript.shapeObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">shapeObj</span></code></a>. Each part of the shape is
133133
a closed <a class="reference internal" href="mapscript.lineObj.html#mapscript.lineObj" title="mapscript.lineObj"><code class="xref py py-class docutils literal notranslate"><span class="pre">lineObj</span></code></a>.</p>
134134
<p class="rubric">Overview</p>
@@ -186,7 +186,7 @@ <h1>mapscript.shapeObj<a class="headerlink" href="#mapscript-shapeobj" title="Li
186186

187187
<dl class="py method">
188188
<dt class="sig sig-object py" id="mapscript.shapeObj.__init__">
189-
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">&lt;MagicMock</span> <span class="pre">id='139944054979024'&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#shapeObj.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.shapeObj.__init__" title="Link to this definition"></a></dt>
189+
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">&lt;MagicMock</span> <span class="pre">id='140427245074848'&gt;</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/mapscript/mapscript.html#shapeObj.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mapscript.shapeObj.__init__" title="Link to this definition"></a></dt>
190190
<dd><p>Return a new shapeObj of the specified type. See the type attribute.
191191
No attribute values created by default.
192192
initValues should be explicitly called to create the required number of values.

‎objects.inv‎

35 Bytes
Binary file not shown.

‎ogc/ogc_api.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,13 @@ <h3><a class="toc-backref" href="#table-of-contents" role="doc-backlink">Setup a
384384
<td><p>Map, Layer</p></td>
385385
<td><p>map or layer-level maximum limit value (integer)</p></td>
386386
</tr>
387+
<tr class="row-even"><td><p>use_default_extent_for_getfeature
388+
(optional)</p></td>
389+
<td><p>Layer</p></td>
390+
<td><p>(since 8.4) Use <code class="docutils literal notranslate"><span class="pre">MAP</span></code> <code class="docutils literal notranslate"><span class="pre">EXTENT</span></code> as a spatial filter if no bbox is in the request.
391+
Setting to <code class="docutils literal notranslate"><span class="pre">&quot;false&quot;</span></code> can improve performance.
392+
See also <a class="reference internal" href="wfs_server.html#wfs-use-default-extent-for-getfeature"><span class="std std-ref">wfs_use_default_extent_for_getfeature</span></a>.</p></td>
393+
</tr>
387394
</tbody>
388395
</table>
389396
</section>
@@ -447,6 +454,7 @@ <h4>Example OGC API Server Mapfile<a class="headerlink" href="#example-ogc-api-s
447454
<span class="s">&quot;ows_abstract&quot;</span> <span class="s">&quot;Oceans, NaturalEarth dataset, 2020&quot;</span>
448455
<span class="s">&quot;gml_include_items&quot;</span> <span class="s">&quot;all&quot;</span> <span class="c">#REQUIRED</span>
449456
<span class="s">&quot;gml_featureid&quot;</span> <span class="s">&quot;ne_id&quot;</span> <span class="c">#REQUIRED</span>
457+
<span class="s">&quot;oga_use_default_extent_for_getfeature&quot;</span> <span class="c"># Optional. Can improve performance.</span>
450458
<span class="k">END</span>
451459
<span class="k">TYPE</span> <span class="nb">POLYGON</span>
452460
<span class="k">STATUS</span> <span class="nb">ON</span>

‎ogc/wfs_server.html‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1244,13 +1244,14 @@ <h2><a class="toc-backref" href="#contents" role="doc-backlink">Reference Sectio
12441244
<dt><strong>wfs_title</strong></dt><dd><p>Same as wfs_title in the Web Object.</p>
12451245
</dd>
12461246
</dl>
1247-
<dl class="simple" id="index-75">
1247+
<span id="index-75"></span><dl class="simple" id="wfs-use-default-extent-for-getfeature">
12481248
<dt><strong>wfs_use_default_extent_for_getfeature</strong></dt><dd><p>(Optional, since MapServer 7.0.4) Whether the MAP.EXTENT should be used in
12491249
request to datasources in the absence of other spatial filter. This is the
12501250
default behaviour, but this might affect performance in some use cases. In
1251-
those cases, setting this item to “false” will avoid he default spatial filter to
1252-
be appended to the request. This is only implemented for OGR datasources (since 7.0.4)
1253-
and MSSQL2008 connections (since 7.6)</p>
1251+
those cases, setting this item to “false” will avoid the default spatial filter to
1252+
be appended to the request. This is only implemented for OGR datasources (since 7.0.4),
1253+
MSSQL2008 (since 7.6), and PostGIS connections (since 8.4).
1254+
Use <strong>ows_use_default_extent_for_getfeature</strong> to set for both WFS and <a class="reference internal" href="ogc_api.html#ogcapi"><span class="std std-ref">OGC API : Features</span></a>.</p>
12541255
</dd>
12551256
</dl>
12561257
</section>

‎searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)