Skip to content

doc: add info on setup_db in API tutorial #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lalepee merged 2 commits into from
Sep 30, 2026
Merged

doc: add info on setup_db in API tutorial #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8f7966
doc: add info on setup_db in API tutorial
HectorJM2018Cosmo Sep 30, 2026
799d5f4
Update PostgreSQL setup_db option documentation
lalepee Sep 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/tutorials/cosmotech-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- 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.
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`:

Expand Down
Loading