From e8f79666bf960dbc5047c38f030e40868ff36df9 Mon Sep 17 00:00:00 2001 From: Hector Jacinto Murillo Date: Wed, 30 Sep 2026 14:47:22 +0200 Subject: [PATCH 1/2] doc: add info on setup_db in API tutorial --- docs/tutorials/cosmotech-api.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/tutorials/cosmotech-api.md b/docs/tutorials/cosmotech-api.md index 11721307..c89ba65e 100644 --- a/docs/tutorials/cosmotech-api.md +++ b/docs/tutorials/cosmotech-api.md @@ -255,6 +255,14 @@ Output channels are defined in the centralized Configuration under the `[[output - Root Configuration Inheritance: Configuration is simplified by sub-channels being able to automatically load default values from the root configuration. This reduces repetition in the TOML file and makes it easier for DevOps to manage credentials and connections centrally. +- Output DB management setting up: A `setup_db` option (since version 2.4.0) allows to able/disable the output DB management setup at writing. +The DB management setting up is activated when the configuration key `setup_db` is set to `True` in the CoAL configuration file at root level. +To keep compatibility with the previous version 2.3.1, the `setup_db` option is set by default to `True`. +The option can be set to `False` once the DB is all setup. +For context, in CoAL, all channels set up a way to make a data rollout (old data is replace by new data). +For the PostgreSQL channel this is done by using a metadata table and setting up foreignkey constraints and indexes on output tables. +By default, this setup/check runs with every new output rollout to the channel, potentially leading to a heavy usage of the database. + **CLI (csm-data) Integration** Developers trigger output operations using simplified CLI commands from `csm-data`: From 799d5f46ed961bad73879aa63b94ce95a59c0598 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laurent=20Al=C3=A9p=C3=A9e?= Date: Wed, 30 Sep 2026 16:10:52 +0200 Subject: [PATCH 2/2] Update PostgreSQL setup_db option documentation Clarified the `setup_db` option for PostgreSQL database management and its default behavior in the configuration. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- docs/tutorials/cosmotech-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/cosmotech-api.md b/docs/tutorials/cosmotech-api.md index c89ba65e..7db46157 100644 --- a/docs/tutorials/cosmotech-api.md +++ b/docs/tutorials/cosmotech-api.md @@ -255,7 +255,7 @@ Output channels are defined in the centralized Configuration under the `[[output - Root Configuration Inheritance: Configuration is simplified by sub-channels being able to automatically load default values from the root configuration. This reduces repetition in the TOML file and makes it easier for DevOps to manage credentials and connections centrally. -- Output DB management setting up: A `setup_db` option (since version 2.4.0) allows to able/disable the output DB management setup at writing. +- PostgreSQL database setup: The `setup_db` option (available since version 2.4.0) enables or disables database setup when writing output. The DB management setting up is activated when the configuration key `setup_db` is set to `True` in the CoAL configuration file at root level. To keep compatibility with the previous version 2.3.1, the `setup_db` option is set by default to `True`. The option can be set to `False` once the DB is all setup.