https://github.com/litesql/ha
Highly available leaderless SQLite cluster powered by embedded NATS JetStream server
https://github.com/litesql/ha
go golang high-availability nats pg-wire sqlite
Last synced: 1 day ago
JSON representation
Highly available leaderless SQLite cluster powered by embedded NATS JetStream server
- Host: GitHub
- URL: https://github.com/litesql/ha
- Owner: litesql
- License: apache-2.0
- Created: 2025-09-20T16:18:19.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-11-07T22:35:22.000Z (14 days ago)
- Last Synced: 2025-11-08T00:18:19.723Z (14 days ago)
- Topics: go, golang, high-availability, nats, pg-wire, sqlite
- Language: Go
- Homepage: https://litesql.github.io/ha/
- Size: 975 KB
- Stars: 41
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-sqlite - litesql/ha - High Available SQLite cluster (Misc / Desktop)
README
# ha
[](https://opensource.org/licenses/Apache-2.0)
[](https://liberapay.com/walterwanderley/donate)
[](https://liberapay.com/walterwanderley/donate)
[](https://liberapay.com/walterwanderley/donate)
## Highly available leaderless SQLite cluster
Powered by an embedded NATS JetStream server.
## Features
- 🔌 Connect via HTTP API or PostgreSQL Wire Protocol
- 🔁 Replicate data using embedded or external NATS server
- 📝 Create live local **read/write** replicas with [go-ha database/sql driver](https://github.com/litesql/go-ha)
- 📚 Create live local read replicas with [ha-sync SQLite extension](https://github.com/litesql/ha-sync)
- 🔄 Supports Change Data Capture (CDC)
- ⚙️ Configure custom strategies for resolving replication data conflicts
- 📖 Full documentation: [https://litesql.github.io/ha/](https://litesql.github.io/ha/)
## 🚀 Getting Started
Download and install the [latest release](https://github.com/litesql/ha/releases/latest)
### 1. Start the first **ha** instance
```sh
mkdir db1
ha -n node1 "file:db1/mydatabase.db?_journal=WAL&_busy_timeout=5000"
```
This command launches:
- An embedded NATS server on port 4222
- A PostgreSQL Wire Protocol server on port 5432
- An HTTP API server on port 8080
### 2. Start a second **ha** instance
```sh
mkdir db2
ha -n node2 -p 8081 --nats-port 0 --pg-port 5433 --replication-url nats://localhost:4222 "file:db2/mydatabase.db?_journal=WAL&_busy_timeout=5000"
```
This command starts:
- A PostgreSQL Wire Protocol server on port 5433
- An HTTP API server on port 8081.
It connects to the previously launched embedded NATS server for replication.
### 3. Connect using a PostgreSQL client
```sh
PGPASSWORD=ha psql -h localhost -U ha
```
Create and populate a table:
```sql
CREATE TABLE users(ID INTEGER PRIMARY KEY, name TEXT);
INSERT INTO users(name) VALUES('HA user');
```
### 4. Verify replication on the second instance
```sh
PGPASSWORD=ha psql -h localhost -U ha -p 5433
```
```sql
SELECT * FROM users;
ID | name
----+---------
1 | HA user
```
### 5. Please refer to the complete documentation for the HTTP API
[HTTP API](https://litesql.github.io/ha/#5)
## 🛠️ License & Contributions
This project is open-source. Contributions, issues, and feature requests are welcome via [GitHub](https://github.com/litesql/ha).