README
¶
rqlite is a relational database which combines SQLite's simplicity with the power of a robust, fault-tolerant, distributed system. It's designed for easy deployment and lightweight operation, offering a developer-friendly and operator-centric solution for Linux, macOS, and Windows, as well as various CPU platforms.
Check out the rqlite FAQ.
Why run rqlite?
rqlite is your solution for a rock-solid, fault-tolerant, relational database with effortless installation, deployment, and operation. It's ideal as a lightweight, distributed relational data store for both developers and operators. Think Consul or etcd, but with relational modeling available.
You can use rqlite to store your important data reliably, ensuring it's always available. If you're interested in understanding how distributed systems actually work, it's a good example to study. A lot of thought has gone into its design, separating storage, consensus, and API clearly.
Key features
- Easy Deployment: Up and running in seconds, with no separate SQLite installation.
- Developer-Friendly: Straightforward HTTP API, CLI, and client libraries.
- Fully Replicated: SQL database with full-text search and JSON support.
- Large data set support: rqlite works well, even when managing multi-GB data sets.
- Dynamic Clustering: Integrates with Kubernetes, Consul, etcd, and DNS for automatic clustering.
- Robust Security: Extensive encryption and TLS support.
- Flexible Consistency: Customize read/write performance and durability.
- Scalable Reads: Read-only nodes for enhanced scalability.
- Transactions: Supports a form of transactions.
- Easy Backups: Hot backups, including automatic backups to AWS S3 and MinIO, as well as restore directly from SQLite.
Quick Start
Get up and running quickly with our Quick Start guide.
Pronunciation
Common pronunciations of rqlite include "R Q lite" and "ree-qwell-lite".
Documentation
¶
Overview ¶
Package rqlite is a lightweight, distributed relational database built on SQLite. rqlite uses Raft to achieve consensus across the cluster of SQLite databases. It ensures that every change made to the database is made to a majority of underlying SQLite files, or none at all.
rqlite gives you the functionality of a rock solid, fault-tolerant, replicated relational database, but with very easy installation, deployment, and operation. With it you've got a lightweight and reliable distributed store for relational data. You could use rqlite as part of a larger system, as a central store for some critical relational data, without having to run a heavier solution like MySQL.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth is a lightweight credential store.
|
Package auth is a lightweight credential store. |
|
Package cluster supports intracluster control messaging.
|
Package cluster supports intracluster control messaging. |
|
rqlite
Command rqlite is the command-line interface for rqlite.
|
Command rqlite is the command-line interface for rqlite. |
|
rqlited
Command rqlited is the rqlite server.
|
Command rqlited is the rqlite server. |
|
Package db exposes a lightweight abstraction over the SQLite code.
|
Package db exposes a lightweight abstraction over the SQLite code. |
|
Package http provides the HTTP server for accessing the distributed database.
|
Package http provides the HTTP server for accessing the distributed database. |
|
Package store provides a distributed SQLite instance.
|
Package store provides a distributed SQLite instance. |
|
Package system supports running end-to-end type testing of rqlite
|
Package system supports running end-to-end type testing of rqlite |
|
Package tcp provides the internode communication network layer.
|
Package tcp provides the internode communication network layer. |
|
pool
Package pool implements a pool of net.Conn interfaces to manage and reuse them.
|
Package pool implements a pool of net.Conn interfaces to manage and reuse them. |