OS Manuals

/usr/bin/timescaledb-tune

A tool for tuning TimescaleDB for better performance by adjusting settings to match your system's CPU and memory resources.

From timescaledb-tune 0.19.0-r12 (os), captured 2026-11-05 by running timescaledb-tune --help (exit 0). permalink

Usage of /usr/bin/timescaledb-tune:
  -color
    	Use color in output (works best on dark terminals) (default true)
  -conf-path string
    	Path to postgresql.conf. If blank, heuristics will be used to find it
  -cpus uint
    	Number of CPU cores to base recommendations on. Default is equal to number of cores
  -dry-run
    	Whether to just show the changes without overwriting the configuration file
  -max-bg-workers int
    	Max number of background workers (default 16)
  -max-conns uint
    	Max number of connections for the database. Default is equal to our best recommendation
  -memory string
    	Amount of memory to base recommendations on in the PostgreSQL format <int value><units>, e.g., 4GB. Default is to use all memory
  -out-path string
    	Path to write the new configuration file. If blank, will use the same file that is read from
  -pg-config string
    	Path to the pg_config binary (default "pg_config")
  -pg-version string
    	Major version of PostgreSQL to base recommendations on. Default is determined via pg_config. Valid values: 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9.6
  -profile string
    	a specific "mode" for tailoring recommendations to a special workload type. If blank or unspecified, a default is used unless the TSTUNE_PROFILE environment variable is set. Valid values: "promscale"
  -quiet
    	Show only the total recommendations at the end
  -restore
    	Whether to restore a previously made conf file backup
  -version
    	Show the version of this tool
  -wal-disk-size string
    	Size of the disk where the WAL resides, in PostgreSQL format <int value><units>, e.g., 4GB. Using this flag helps tune WAL behavior.
  -yes
    	Answer 'yes' to every prompt
Options (16)
OptionDescriptionSource
-colorUse color in output (works best on dark terminals) (default true)help
-conf-path stringPath to postgresql.conf.help
-cpus uintNumber of CPU cores to base recommendations on.help
-dry-runWhether to just show the changes without overwriting the configuration filehelp
-max-bg-workers intMax number of background workers (default 16)help
-max-conns uintMax number of connections for the database.help
-memory stringAmount of memory to base recommendations on in the PostgreSQL format <int value><units>, e.g., 4GB.help
-out-path stringPath to write the new configuration file.help
-pg-config stringPath to the pg_config binary (default "pg_config")help
-pg-version stringMajor version of PostgreSQL to base recommendations on.help
-profile stringa specific "mode" for tailoring recommendations to a special workload type.help
-quietShow only the total recommendations at the endhelp
-restoreWhether to restore a previously made conf file backuphelp
-versionShow the version of this toolhelp
-wal-disk-size stringSize of the disk where the WAL resides, in PostgreSQL format <int value><units>, e.g., 4GB.help
-yesAnswer 'yes' to every prompthelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.