ODB configuration

The SQLite database that stores the configuration of a Zato environment.

The ODB (operational database) stores the configuration of a Zato environment - servers, services, channels, security definitions and other objects. Each environment has its own ODB and it runs on SQLite.

Where the database lives

The ODB is one SQLite file inside the environment's directory. The zato quickstart command creates it as zato.db at the top level of the environment, next to the server1 and web-admin directories, and the --odb-path option sets a different location:

zato quickstart ~/env/qs-1 --odb-path /opt/zato/data/zato.db

The server and the Dashboard of the environment read the same file. The server.conf of each server records the path in its [odb] stanza, and web-admin.conf records it as DATABASE_NAME.

Containers

The container creates the ODB inside itself at each start and restores the configuration from the project's enmasse YAML. Objects created in the Dashboard and not exported to enmasse are lost when the container restarts, so the enmasse YAML in Git, not the ODB, is where the configuration of an environment is kept. Backup describes what this means for backups and restores.

See also

PageWhat it covers
BackupWhat to back up when the configuration lives in Git
EnmasseThe YAML export that recreates the ODB contents at each start
Audit logThe separate database that records API traffic

Learn more