OS Manuals

/usr/bin/rqlited

The lightweight, distributed relational database built on SQLite

From rqlite 10.2.0-r1 (os), captured 2026-11-05 by running rqlited --help (exit 0). permalink

Also provided by 2 other package versions
rqlite is a lightweight, distributed relational database, which uses SQLite as its
storage engine. It provides an easy-to-use, fault-tolerant store for relational data.

Visit https://www.rqlite.io to learn more.

Usage: rqlited [flags] <data directory>
  -auth string
    	Path to authentication and authorization file. If not set, not enabled
  -auto-backup string
    	Path to automatic backup configuration file. If not set, not enabled
  -auto-optimize-int duration
    	Period between automatic 'PRAGMA optimize'. Set to 0h to disable (default 24h0m0s)
  -auto-restore string
    	Path to automatic restore configuration file. If not set, not enabled
  -auto-vacuum-int duration
    	Period between automatic VACUUMs. It not set, not enabled
  -bootstrap-expect int
    	Minimum number of nodes required for a bootstrap
  -bootstrap-expect-timeout duration
    	Maximum time for bootstrap process (default 2m0s)
  -cdc-config string
    	Set CDC HTTP endpoint, or path to CDC config file. If not set, CDC not enabled
  -cluster-connect-timeout duration
    	Timeout for initial connection to other nodes (default 30s)
  -compress-snap-transport
    	Enable compression when transferring snapshots between nodes
  -cpu-profile string
    	Path to file for CPU profiling information
  -db-max-ro-conns int
    	Maximum number of read-only connections to database (default 256)
  -disco-config string
    	Set discovery config, or path to cluster discovery config file
  -disco-key string
    	Key prefix for cluster discovery service (default "rqlite")
  -disco-mode string
    	Choose clustering discovery mode. If not set, no node discovery is performed
  -extensions-path string
    	Comma-delimited list of paths to directories, zipfiles, or tar.gz files containing SQLite extensions
  -fk
    	Enable SQLite foreign key constraints
  -http-addr string
    	HTTP server bind address. To enable HTTPS, set X.509 certificate and key (default "localhost:4001")
  -http-adv-addr string
    	Advertised HTTP address. If not set, same as HTTP server bind address
  -http-allow-origin string
    	Value to set for Access-Control-Allow-Origin HTTP header
  -http-ca-cert string
    	Path to X.509 CA certificate for HTTPS
  -http-cert string
    	Path to HTTPS X.509 certificate
  -http-key string
    	Path to HTTPS X.509 private key
  -http-verify-client
    	Enable mutual TLS for HTTPS
  -http-verify-common-name string
    	Required Common Name on client certificates. If not set, no Common Name required
  -join string
    	Comma-delimited list of nodes, in host:port form, through which a cluster can be joined
  -join-as string
    	Username in authentication file to join as. If not set, joins anonymously
  -join-attempts int
    	Number of join attempts to make (default 5)
  -join-interval duration
    	Period between join attempts (default 3s)
  -mem-profile string
    	Path to file for memory profiling information
  -node-ca-cert string
    	Path to X.509 CA certificate for node-to-node encryption
  -node-cert string
    	Path to X.509 certificate for node-to-node mutual authentication and encryption
  -node-id string
    	Unique ID for node. If not set, set to advertised Raft address
  -node-key string
    	Path to X.509 private key for node-to-node mutual authentication and encryption
  -node-no-verify
    	Skip verification of any presented certificate.
  -node-verify-client
    	Enable mutual TLS for node-to-node communication
  -node-verify-common-name string
    	Required Common Name on incoming peer certificates. If not set, no Common Name required
  -node-verify-server-name string
    	Hostname to verify on certificate returned by a node
  -raft-addr string
    	Raft communication bind address (default "localhost:4002")
  -raft-adv-addr string
    	Advertised Raft communication address. If not set, same as Raft bind address
  -raft-apply-timeout duration
    	Raft apply timeout (default 10s)
  -raft-cluster-remove-shutdown
    	Node removes itself from cluster on graceful shutdown
  -raft-commit-timeout duration
    	Raft commit timeout (default 50ms)
  -raft-election-timeout duration
    	Raft election timeout (default 1s)
  -raft-heartbeat-timeout duration
    	Raft heartbeat timeout (default 1s)
  -raft-leader-lease-timeout duration
    	Raft leader lease timeout. Use 0s for Raft default
  -raft-log-level string
    	Minimum log level for Raft module (default "WARN")
  -raft-non-voter
    	Configure as non-voting node
  -raft-reap-node-timeout duration
    	Time after which a non-reachable voting node will be reaped. If not set, no reaping takes place
  -raft-reap-read-only-node-timeout duration
    	Time after which a non-reachable non-voting node will be reaped. If not set, no reaping takes place
  -raft-remove-shutdown
    	Shutdown Raft if node removed from cluster
  -raft-shutdown-stepdown
    	If leader, stepdown before shutting down. Enabled by default (default true)
  -raft-snap uint
    	Number of outstanding log entries which triggers Raft snapshot (default 8192)
  -raft-snap-int duration
    	Snapshot threshold check interval (default 10s)
  -raft-snap-wal-size uint
    	SQLite WAL file size in bytes which triggers Raft snapshot. Set to 0 to disable (default 4194304)
  -trace-profile string
    	Path to file for trace profiling information
  -version
    	Show version information and exit
  -write-queue-batch-size int
    	Queued Writes queue batch size (default 128)
  -write-queue-capacity int
    	Queued Writes queue capacity (default 1024)
  -write-queue-timeout duration
    	Queued Writes queue timeout (default 50ms)
  -write-queue-tx
    	Use a transaction when processing a queued write
Options (61)
OptionDescriptionSource
-auth stringPath to authentication and authorization file.help
-auto-backup stringPath to automatic backup configuration file.help
-auto-optimize-int durationPeriod between automatic 'PRAGMA optimize'.help
-auto-restore stringPath to automatic restore configuration file.help
-auto-vacuum-int durationPeriod between automatic VACUUMs.help
-bootstrap-expect intMinimum number of nodes required for a bootstraphelp
-bootstrap-expect-timeout durationMaximum time for bootstrap process (default 2m0s)help
-cdc-config stringSet CDC HTTP endpoint, or path to CDC config file.help
-cluster-connect-timeout durationTimeout for initial connection to other nodes (default 30s)help
-compress-snap-transportEnable compression when transferring snapshots between nodeshelp
-cpu-profile stringPath to file for CPU profiling informationhelp
-db-max-ro-conns intMaximum number of read-only connections to database (default 256)help
-disco-config stringSet discovery config, or path to cluster discovery config filehelp
-disco-key stringKey prefix for cluster discovery service (default "rqlite")help
-disco-mode stringChoose clustering discovery mode.help
-extensions-path stringComma-delimited list of paths to directories, zipfiles, or tar.gz files containing SQLite extensionshelp
-fkEnable SQLite foreign key constraintshelp
-http-addr stringHTTP server bind address.help
-http-adv-addr stringAdvertised HTTP address.help
-http-allow-origin stringValue to set for Access-Control-Allow-Origin HTTP headerhelp
-http-ca-cert stringPath to X.509 CA certificate for HTTPShelp
-http-cert stringPath to HTTPS X.509 certificatehelp
-http-key stringPath to HTTPS X.509 private keyhelp
-http-verify-clientEnable mutual TLS for HTTPShelp
-http-verify-common-name stringRequired Common Name on client certificates.help
-join stringComma-delimited list of nodes, in host:port form, through which a cluster can be joinedhelp
-join-as stringUsername in authentication file to join as.help
-join-attempts intNumber of join attempts to make (default 5)help
-join-interval durationPeriod between join attempts (default 3s)help
-mem-profile stringPath to file for memory profiling informationhelp
-node-ca-cert stringPath to X.509 CA certificate for node-to-node encryptionhelp
-node-cert stringPath to X.509 certificate for node-to-node mutual authentication and encryptionhelp
-node-id stringUnique ID for node.help
-node-key stringPath to X.509 private key for node-to-node mutual authentication and encryptionhelp
-node-no-verifySkip verification of any presented certificate.help
-node-verify-clientEnable mutual TLS for node-to-node communicationhelp
-node-verify-common-name stringRequired Common Name on incoming peer certificates.help
-node-verify-server-name stringHostname to verify on certificate returned by a nodehelp
-raft-addr stringRaft communication bind address (default "localhost:4002")help
-raft-adv-addr stringAdvertised Raft communication address.help
-raft-apply-timeout durationRaft apply timeout (default 10s)help
-raft-cluster-remove-shutdownNode removes itself from cluster on graceful shutdownhelp
-raft-commit-timeout durationRaft commit timeout (default 50ms)help
-raft-election-timeout durationRaft election timeout (default 1s)help
-raft-heartbeat-timeout durationRaft heartbeat timeout (default 1s)help
-raft-leader-lease-timeout durationRaft leader lease timeout.help
-raft-log-level stringMinimum log level for Raft module (default "WARN")help
-raft-non-voterConfigure as non-voting nodehelp
-raft-reap-node-timeout durationTime after which a non-reachable voting node will be reaped.help
-raft-reap-read-only-node-timeout durationTime after which a non-reachable non-voting node will be reaped.help
-raft-remove-shutdownShutdown Raft if node removed from clusterhelp
-raft-shutdown-stepdownIf leader, stepdown before shutting down.help
-raft-snap uintNumber of outstanding log entries which triggers Raft snapshot (default 8192)help
-raft-snap-int durationSnapshot threshold check interval (default 10s)help
-raft-snap-wal-size uintSQLite WAL file size in bytes which triggers Raft snapshot.help
-trace-profile stringPath to file for trace profiling informationhelp
-versionShow version information and exithelp
-write-queue-batch-size intQueued Writes queue batch size (default 128)help
-write-queue-capacity intQueued Writes queue capacity (default 1024)help
-write-queue-timeout durationQueued Writes queue timeout (default 50ms)help
-write-queue-txUse a transaction when processing a queued writehelp

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