Skip to content

Commit

Permalink
Document PostgreSQL process manager (#1746)
Browse files Browse the repository at this point in the history
* Document PostgreSQL process manager

* Update ogcapi-processes.rst

---------

Co-authored-by: Tom Kralidis <[email protected]>
  • Loading branch information
vprivat-ads and tomkralidis authored Jul 22, 2024
1 parent f55aa87 commit e2676bd
Showing 1 changed file with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions docs/source/data-publishing/ogcapi-processes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ can be requested by including the ``Prefer: respond-async`` HTTP header in the r
output_dir: /tmp/
MongoDB
--------------------
As an alternative to the default a manager employing `MongoDB`_ can be used.
The connection to an installed `MongoDB`_ instance must be provided in the configuration.
`MongoDB`_ uses the localhost and port 27017 by default. Jobs are stored in a collection named
job_manager_pygeoapi.
-------
As an alternative to the default, a manager employing `MongoDB`_ can be used.
The connection to a `MongoDB`_ instance must be provided in the configuration.
`MongoDB`_ uses ``localhost`` and port ``27017`` by default. Jobs are stored in a collection named
``job_manager_pygeoapi``.

.. code-block:: yaml
Expand All @@ -67,10 +67,33 @@ job_manager_pygeoapi.
output_dir: /tmp/
PostgreSQL
----------
As another alternative to the default, a manager employing `PostgreSQL`_ can be used.
The connection to a `PostgreSQL`_ database must be provided in the configuration.
`PostgreSQL`_ uses ``localhost`` and port ``5432`` by default. Jobs are stored in a table named ``jobs``.

.. code-block:: yaml
server:
manager:
name: PostgreSQL
connection:
host: localhost
port: 5432
database: test
user: postgres
password: ${POSTGRESQL_PASSWORD:-postgres}
# Alternative accepted connection definition:
# connection: postgresql://postgres:postgres@localhost:5432/test
# connection: postgresql://postgres:${POSTGRESQL_PASSWORD:-postgres}@localhost:5432/test
output_dir: /tmp
Putting it all together
-----------------------

To summarize how pygeoapi processes and managers work together::
To summarize how pygeoapi processes and managers work together:

* process plugins implement the core processing / workflow functionality
* manager plugins control and manage how processes are executed
Expand Down

0 comments on commit e2676bd

Please sign in to comment.