Command: databases

The databases command lists all databases in the configuration file along with their associated replica.

Usage#

litestream databases [arguments]

Arguments#

-config PATH
    Specifies the configuration file.
    Defaults to /etc/litestream.yml

-json
    Output raw JSON instead of human-readable text.

-no-expand-env
    Disables environment variable expansion in configuration file.

Output#

By default, the databases command prints an aligned, human-readable table with one row per database:

JSON output#

v0.5.12 With the -json flag, the databases command writes a JSON array to stdout with one object per database:

When no databases are configured, the command emits an empty JSON array ([]).

See the JSON Output Reference for the complete schema documentation.

Examples#

List all databases#

This example shows a single database /var/lib/db defined in the configuration file with a file replica:

$ litestream databases
path         replica
/var/lib/db  file

JSON output#

Use -json for machine-readable output suitable for scripting:

$ litestream databases -json
[
  {
    "path": "/var/lib/db",
    "replica": "file"
  }
]

See Also#

• JSON Output Reference — Schema for -json output
• Command: status — Report local replication status
• Configuration Reference — Complete configuration options