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. If 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-as string
Username in authentication file to perform internode CDC operations. If not set, performs CDC operations anonymously
-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
-query-log string
Set to 'stderr' to log every SQL statement, or to path of query-log config file. If not set, query logging not enabled
-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 read replica (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 5s)
-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-retry int
How many times to retry a queued write (default 1)
-write-queue-timeout duration
Queued Writes queue timeout (default 50ms)
-write-queue-tx
Use a transaction when processing a queued write
Options (64)
| Option | Description | Source |
|---|---|---|
-auth string | Path to authentication and authorization file. | help |
-auto-backup string | Path to automatic backup configuration file. | help |
-auto-optimize-int duration | Period between automatic 'PRAGMA optimize'. | help |
-auto-restore string | Path to automatic restore configuration file. | help |
-auto-vacuum-int duration | Period between automatic VACUUMs. | help |
-bootstrap-expect int | Minimum number of nodes required for a bootstrap | help |
-bootstrap-expect-timeout duration | Maximum time for bootstrap process (default 2m0s) | help |
-cdc-as string | Username in authentication file to perform internode CDC operations. | help |
-cdc-config string | Set CDC HTTP endpoint, or path to CDC config file. | help |
-cluster-connect-timeout duration | Timeout for initial connection to other nodes (default 30s) | help |
-compress-snap-transport | Enable compression when transferring snapshots between nodes | help |
-cpu-profile string | Path to file for CPU profiling information | help |
-db-max-ro-conns int | Maximum number of read-only connections to database (default 256) | help |
-disco-config string | Set discovery config, or path to cluster discovery config file | help |
-disco-key string | Key prefix for cluster discovery service (default "rqlite") | help |
-disco-mode string | Choose clustering discovery mode. | help |
-extensions-path string | Comma-delimited list of paths to directories, zipfiles, or tar.gz files containing SQLite extensions | help |
-fk | Enable SQLite foreign key constraints | help |
-http-addr string | HTTP server bind address. | help |
-http-adv-addr string | Advertised HTTP address. | help |
-http-allow-origin string | Value to set for Access-Control-Allow-Origin HTTP header | help |
-http-ca-cert string | Path to X.509 CA certificate for HTTPS | help |
-http-cert string | Path to HTTPS X.509 certificate | help |
-http-key string | Path to HTTPS X.509 private key | help |
-http-verify-client | Enable mutual TLS for HTTPS | help |
-http-verify-common-name string | Required Common Name on client certificates. | help |
-join string | Comma-delimited list of nodes, in host:port form, through which a cluster can be joined | help |
-join-as string | Username in authentication file to join as. | help |
-join-attempts int | Number of join attempts to make (default 5) | help |
-join-interval duration | Period between join attempts (default 3s) | help |
-mem-profile string | Path to file for memory profiling information | help |
-node-ca-cert string | Path to X.509 CA certificate for node-to-node encryption | help |
-node-cert string | Path to X.509 certificate for node-to-node mutual authentication and encryption | help |
-node-id string | Unique ID for node. | help |
-node-key string | Path to X.509 private key for node-to-node mutual authentication and encryption | help |
-node-no-verify | Skip verification of any presented certificate | help |
-node-verify-client | Enable mutual TLS for node-to-node communication | help |
-node-verify-common-name string | Required Common Name on incoming peer certificates. | help |
-node-verify-server-name string | Hostname to verify on certificate returned by a node | help |
-query-log string | Set to 'stderr' to log every SQL statement, or to path of query-log config file. | help |
-raft-addr string | Raft communication bind address (default "localhost:4002") | help |
-raft-adv-addr string | Advertised Raft communication address. | help |
-raft-apply-timeout duration | Raft apply timeout (default 10s) | help |
-raft-cluster-remove-shutdown | Node removes itself from cluster on graceful shutdown | help |
-raft-commit-timeout duration | Raft commit timeout (default 50ms) | help |
-raft-election-timeout duration | Raft election timeout (default 1s) | help |
-raft-heartbeat-timeout duration | Raft heartbeat timeout (default 1s) | help |
-raft-leader-lease-timeout duration | Raft leader lease timeout. | help |
-raft-log-level string | Minimum log level for Raft module (default "WARN") | help |
-raft-non-voter | Configure as non-voting node | help |
-raft-reap-node-timeout duration | Time after which a non-reachable voting node will be reaped. | help |
-raft-reap-read-only-node-timeout duration | Time after which a non-reachable read replica (non-voting) node will be reaped. | help |
-raft-remove-shutdown | Shutdown Raft if node removed from cluster | help |
-raft-shutdown-stepdown | If leader, stepdown before shutting down. | help |
-raft-snap uint | Number of outstanding log entries which triggers Raft snapshot (default 8192) | help |
-raft-snap-int duration | Snapshot threshold check interval (default 5s) | help |
-raft-snap-wal-size uint | SQLite WAL file size in bytes which triggers Raft snapshot. | help |
-trace-profile string | Path to file for trace profiling information | help |
-version | Show version information and exit | help |
-write-queue-batch-size int | Queued Writes queue batch size (default 128) | help |
-write-queue-capacity int | Queued Writes queue capacity (default 1024) | help |
-write-queue-retry int | How many times to retry a queued write (default 1) | help |
-write-queue-timeout duration | Queued Writes queue timeout (default 50ms) | help |
-write-queue-tx | Use a transaction when processing a queued write | help |