add support for ERDDAP Tabledap provider (#1214)

This commit is contained in:
Tom Kralidis
2023-04-25 11:39:55 -04:00
committed by GitHub
parent 6c71f90645
commit b7ee1203cd
5 changed files with 238 additions and 10 deletions
+1 -1
View File
@@ -116,7 +116,7 @@ release = version
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
+4 -1
View File
@@ -32,7 +32,8 @@ Reference
^^^^^^^^^^
The ``server`` section provides directives on binding and high level tuning.
Please find more information related to API design rules (the property at the bottom of the example below) :ref:`further down<API Design Rules>`.
For more information related to API design rules (the ``api_rules`` property in the example below) see :ref:`API Design Rules`.
.. code-block:: yaml
@@ -312,6 +313,8 @@ Examples:
curl https://example.org/collections/foo # user can access resource normally
.. _API Design Rules:
API Design Rules
----------------
@@ -21,6 +21,7 @@ parameters.
`CSV`_,✅/✅,results/hits,❌,❌,❌,✅,❌,❌,✅
`Elasticsearch`_,✅/✅,results/hits,✅,✅,✅,✅,✅,✅,✅
`ERDDAP Tabledap Service`_,❌/❌,results/hits,✅,✅,❌,❌,❌,❌
`ESRI Feature Service`_,✅/✅,results/hits,✅,✅,✅,✅,❌,❌,✅
`GeoJSON`_,✅/✅,results/hits,❌,❌,❌,✅,❌,❌,✅
`MongoDB`_,✅/❌,results,✅,✅,✅,✅,❌,❌,✅
@@ -397,14 +398,41 @@ relies on `sodapy <https://github.com/xmunoz/sodapy>`.
.. code-block:: yaml
providers:
- type: feature
name: Socrata
data: https://soda.demo.socrata.com/
resource_id: emdb-u46w
id_field: earthquake_id
geom_field: location
time_field: datetime # Optional time_field for datetime queries
token: my_token # Optional app token
- type: feature
name: Socrata
data: https://soda.demo.socrata.com/
resource_id: emdb-u46w
id_field: earthquake_id
geom_field: location
time_field: datetime # Optional time_field for datetime queries
token: my_token # Optional app token
.. _ERDDAP Tabledap Service:
ERDDAP Tabledap Service
^^^^^^^^^^^^^^^^^^^^^^^
.. note::
Requires Python package `requests`_
To publish from an ERDDAP `Tabledap`_ service, the following are required in your index:
.. code-block:: yaml
providers:
- type: feature
name: ERDDAPTabledap
data: http://osmc.noaa.gov/erddap/tabledap/OSMC_Points
id_field: PLATFORM_CODE
time_field: time
options:
filters: "&parameter=\"SLP\"&platform!=\"C-MAN%20WEATHER%20STATIONS\"&platform!=\"TIDE GAUGE STATIONS (GENERIC)\""
max_age_hours: 12
.. note::
If the ``datetime`` parameter is passed by the client, this overrides the ``options.max_age_hours`` setting.
Controlling the order of properties
-----------------------------------
@@ -471,3 +499,5 @@ Data access examples
.. _`Google Cloud SQL`: https://cloud.google.com/sql
.. _`OGC API - Features`: https://www.ogc.org/standards/ogcapi-features
.. _`Tabledap`: https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html
.. _`requests`: https://requests.readthedocs.io