Skip to main content

config

Show and manage the server's configuration file and the CLI's connection profiles.

lynxdb config [subcommand] [flags]

Without a subcommand, config prints every setting with its value and where the value came from: default, config file, env var or a flag.

  No config file found (using defaults)

Server
listen: localhost:3100 (default)
data_dir: /home/alice/.local/share/lynxdb (default)
retention: 7d (default)
log_level: info (default)

Storage
storage.partition: 1d (default)
storage.flush_interval: 0s (default)
storage.time_fields: _time,timestamp,@timestamp,time,ts (default)
...

Config file​

When --config is not given, the first file found wins:

  1. LYNXDB_CONFIG
  2. ./lynxdb.yaml
  3. $XDG_CONFIG_HOME/lynxdb/config.yaml, or ~/.config/lynxdb/config.yaml
  4. ~/.lynxdb/config.yaml
  5. /etc/lynxdb/config.yaml

With no file, built-in defaults apply. The commands that write a file (init, set, edit, reset) use --config, or else $XDG_CONFIG_HOME/lynxdb/config.yaml (~/.config/lynxdb/config.yaml).

Settings resolve in this order, highest first: lynxdb server flags, LYNXDB_* environment variables, the config file, defaults. Configuration lists every key and Environment variables their variable names.

Override flags​

config and config validate accept these flags to preview what the same lynxdb server flags would change:

FlagOverrides
--addrlisten
--data-dirdata_dir
--log-levellog_level
lynxdb config --data-dir /var/lib/lynxdb --log-level debug

config init​

lynxdb config init [--system]

Writes a commented template with every setting and its default. --system writes /etc/lynxdb/config.yaml. The command refuses to overwrite an existing file.

config validate​

lynxdb config validate

Loads and validates the config file, warns about unknown keys, and lists the values that differ from the defaults.

  ⚠  unknown config key "storage.partiton" in /etc/lynxdb/config.yaml
Did you mean "storage.partition"?
✔ Config file /etc/lynxdb/config.yaml is valid.

config get​

lynxdb config get <key>

Prints one value and its origin. Keys tab-complete.

lynxdb config get retention
lynxdb config get storage.partition
lynxdb config get listen --format json

With no config file, config get storage.partition prints 1d (default), and with --format json:

{"key":"storage.partition","value":"1d","source":"default"}

config set​

lynxdb config set <key> <value> [--dry-run]

Writes one value to the config file, creating the file when it does not exist. --dry-run shows the current and the new value without writing.

lynxdb config set retention 30d
lynxdb config set storage.partition 1h
lynxdb config set log_level debug --dry-run

A running server picks up the settings that a reload applies on config reload; the others need a restart.

config edit​

lynxdb config edit

Opens the config file in $EDITOR (or $VISUAL), creating it from the template first when it does not exist.

config path​

lynxdb config path

Prints the path init, set, edit and reset write to.

config reset​

lynxdb config reset [--dry-run]

Overwrites the config file with the default template after you type reset to confirm. --dry-run shows what would be reset.

config reload​

lynxdb config reload

Sends SIGHUP to the running server. The CLI finds the server's PID in <data_dir>/lynxdb.pid, so it reads the same config to locate the data directory. server lists the settings a reload applies.

config add-profile​

lynxdb config add-profile <name> --url <url> [--token <token>]

A connection profile stores a server URL and an optional API key in the config file, under profiles. Running it again with the same name updates the profile. add-profile and remove-profile write the config file back with every effective setting, so the file lists each key afterwards.

FlagDefaultDescription
--urlrequiredServer URL
--tokenAPI key
lynxdb config add-profile prod --url https://logs.example.com --token "$PROD_KEY"
lynxdb config add-profile dev --url http://dev-logs.example.com:3100

Select a profile with --profile (-p), LYNXDB_PROFILE or profile: in .lynxdbrc. --server takes precedence over the profile's URL.

lynxdb query 'source=main level=ERROR | stats count() by host' --profile prod
lynxdb status -p dev
LYNXDB_PROFILE=prod lynxdb jobs --status running

config list-profiles​

lynxdb config list-profiles

Lists profiles with their URL and whether they hold a key.

config remove-profile​

lynxdb config remove-profile <name>

See also​