OS Manuals

/usr/bin/spqr-router

Stateless Postgres Query Router

From spqr 3.2.2-r0 (os), captured 2026-11-10 by running spqr-router --help (exit 0). permalink

spqr-router

Usage:
  spqr-router [command]

Available Commands:
  help        Help about any command
  run         run router
  test-config Load, validate and print the given config file

Flags:
      --admin-port admin_console_port                     overload for admin_console_port option in router config
      --advisory-lock-behaviour advisory_lock_behaviour   overload for advisory_lock_behaviour option in router config
  -c, --config string                                     path to router config file (default "/etc/spqr/router.yaml")
      --console daemonize                                 run as a console app or not. Opposite of daemonize
      --coordinator-config string                         path to coordinator config file (default "/etc/spqr/coordinator.yaml")
      --cpu-profile                                       profile cpu or not
  -d, --daemonize console                                 run as a daemon or not. Opposite of console
      --default-route-behaviour default_route_behaviour   overload for default_route_behaviour option in router config
      --display_greeting                                  enables SPQR console greeting (default true)
  -e, --enhanced_multishard_processing                    enables SPQR query processing engine V2
      --gomaxprocs int                                    GOMAXPROCS value
      --grpc-port grpc_api_port                           overload for grpc_api_port option in router config
  -h, --help                                              help for spqr-router
  -l, --log-level log_level                               overload for log_level option in router config
      --logger-config string                              path to logger config file
      --mem-profile                                       profile mem or not
      --memqdb-backup-path memqdb_backup_path             overload for memqdb_backup_path option in router config
      --pgproto-debug pgproto_debug                       overload for pgproto_debug option in router config
  -P, --pretty-log                                        enables pretty logging
  -p, --profile-file string                               path to profile file (default "/etc/spqr/router.prof")
      --qdb-impl string                                   which implementation of QDB to use (default "etcd")
      --router-port router_port                           overload for router_port option in router config
      --router-ro-port router_ro_port                     overload for router_ro_port option in router config
      --show-notice-messages show_notice_messages         overload for show_notice_messages option in router config
      --use_coordinator_init                              do use coordinator based metadata initialization
  -v, --version                                           version for spqr-router
      --with-coordinator                                  start spqr coordinator in separate goroutine

Use "spqr-router [command] --help" for more information about a command.
Options (27)
OptionDescriptionSource
--admin-port admin_console_portoverload for admin_console_port option in router confighelp
--advisory-lock-behaviour advisory_lock_behaviouroverload for advisory_lock_behaviour option in router confighelp
-c, --config stringpath to router config file (default "/etc/spqr/router.yaml")help
--console daemonizerun as a console app or not.help
--coordinator-config stringpath to coordinator config file (default "/etc/spqr/coordinator.yaml")help
--cpu-profileprofile cpu or nothelp
-d, --daemonize consolerun as a daemon or not.help
--default-route-behaviour default_route_behaviouroverload for default_route_behaviour option in router confighelp
--display_greetingenables SPQR console greeting (default true)help
-e, --enhanced_multishard_processingenables SPQR query processing engine V2help
--gomaxprocs intGOMAXPROCS valuehelp
--grpc-port grpc_api_portoverload for grpc_api_port option in router confighelp
-h, --helphelp for spqr-routerhelp
-l, --log-level log_leveloverload for log_level option in router confighelp
--logger-config stringpath to logger config filehelp
--mem-profileprofile mem or nothelp
--memqdb-backup-path memqdb_backup_pathoverload for memqdb_backup_path option in router confighelp
--pgproto-debug pgproto_debugoverload for pgproto_debug option in router confighelp
-P, --pretty-logenables pretty logginghelp
-p, --profile-file stringpath to profile file (default "/etc/spqr/router.prof")help
--qdb-impl stringwhich implementation of QDB to use (default "etcd")help
--router-port router_portoverload for router_port option in router confighelp
--router-ro-port router_ro_portoverload for router_ro_port option in router confighelp
--show-notice-messages show_notice_messagesoverload for show_notice_messages option in router confighelp
--use_coordinator_initdo use coordinator based metadata initializationhelp
-v, --versionversion for spqr-routerhelp
--with-coordinatorstart spqr coordinator in separate goroutinehelp

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