Francesco Bartoli
bb4cd0bf69
Fix starlette event loop Fix starlette event loop Fix starlette event loop Fix starlette event loop Fix provider regression Make method public Make method public Move function to the helpers utility Add the CQL lifecycle for development Add CQL docs Fix flake8 Isolate import for starlette codepath
51 lines
1.2 KiB
ReStructuredText
51 lines
1.2 KiB
ReStructuredText
.. _cql:
|
|
|
|
CQL support
|
|
===========
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
The support to CQL is limited to `Simple CQL filter <https://portal.ogc.org/files/96288#cql-core>`_ and thus it allows to query with the
|
|
following predicates:
|
|
|
|
- comparison predicates
|
|
- spatial predicates
|
|
- temporal predicates
|
|
|
|
Formats
|
|
-------
|
|
|
|
At the moment pygeoapi supports only the CQL dialect with the JSON encoding `CQL-JSON <https://portal.ogc.org/files/96288#simple-cql-JSON>`_.
|
|
|
|
Providers
|
|
---------
|
|
|
|
As of now the available providers supported for CQL filtering are limited to only :ref:`Elasticsearch <Elasticsearch>`.
|
|
|
|
Queries
|
|
^^^^^^^
|
|
|
|
The following type of queries are supported right now:
|
|
|
|
- ``between`` predicate query
|
|
- Logical ``and`` query with ``between`` and ``eq`` expression
|
|
- Spatial query with ``bbox``
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
A ``between`` example for a specific property through an HTTP POST request:
|
|
|
|
.. code-block:: bash
|
|
|
|
curl --location --request POST 'http://localhost:5000/collections/nhsl_hazard_threat_all_indicators_s_bc/items?f=json&limit=50&filter-lang=cql-json' \
|
|
--header 'Content-Type: application/query-cql-json' \
|
|
--data-raw '{
|
|
"between": {
|
|
"value": { "property": "properties.MHn_Intensity" },
|
|
"lower": 0.59,
|
|
"upper": 0.60
|
|
}
|
|
}'
|