sqldb: init

This implements a basic driver for using Postgres, SQLite or MySQL as storage engine for nostr-database. Uses async Diesel as driver and Diesel migrations to set up the schema.

Pull-Request: #835
Pull-Request: #855
Signed-off-by: Yuki Kishimoto <[email protected]>

Author: tompro

Cargo.lock

@@ -8,6 +8,7 @@ members = [
     "database/nostr-indexeddb",
     "database/nostr-lmdb",
     "database/nostr-ndb",
+    "database/nostr-sqldb",
 
     # Gossip
     "gossip/nostr-gossip",

Cargo.toml

@@ -39,6 +39,9 @@ buildargs=(
     "-p nostr-gossip-memory"
     "-p nostr-gossip-test-suite"
     "-p nostr-lmdb"
+    "-p nostr-sqldb --no-default-features --features postgres"    # PostgreSQL
+    "-p nostr-sqldb --no-default-features --features mysql"       # MySQL
+    "-p nostr-sqldb --no-default-features --features sqlite"      # SQLite
     "-p nostr-indexeddb --target wasm32-unknown-unknown"
     "-p nostr-ndb"
     "-p nostr-keyring"

contrib/scripts/check-crates.sh

@@ -0,0 +1,45 @@
+[package]
+name = "nostr-sqldb"
+version = "0.42.0"
+edition = "2021"
+description = "SQL storage backend for Nostr apps"
+authors.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+readme = "README.md"
+rust-version.workspace = true
+keywords = ["nostr", "database", "postgres", "mysql", "sqlite"]
+
+[features]
+default = ["postgres"]
+postgres = [
+  "diesel/postgres",
+  "diesel-async/postgres",
+  "diesel_migrations/postgres",
+]
+mysql = ["diesel/mysql", "diesel-async/mysql", "diesel_migrations/mysql"]
+sqlite = [
+  "diesel/sqlite",
+  "diesel-async/sqlite",
+  "diesel_migrations/sqlite",
+  "diesel/returning_clauses_for_sqlite_3_35",
+]
+
+[dependencies]
+deadpool = { version = "0.12", features = ["managed", "rt_tokio_1"] }
+diesel = { version = "2.2", features = ["serde_json"] }
+diesel-async = { version = "0.5", features = ["deadpool"] }
+diesel_migrations = "2.2"
+nostr = { workspace = true, features = ["std"] }
+nostr-database = { workspace = true, features = ["flatbuf"] }
+tracing.workspace = true
+
+[dev-dependencies]
+nostr-relay-builder.workspace = true
+tokio.workspace = true
+tracing-subscriber.workspace = true
+
+[[example]]
+name = "postgres-relay"
+required-features = ["postgres"]

database/nostr-sqldb/Cargo.toml

@@ -0,0 +1,25 @@
+# Nostr SQL database backend
+
+SQL storage backend for nostr apps working with Postgres, SQLite and MySQL.
+
+## Crate Feature Flags
+
+The following crate feature flags are available:
+
+| Feature     | Default | Description                   |
+|-------------|:-------:|-------------------------------|
+| `postgres`  |   Yes   | Enable support for PostgreSQL |
+| `mysql`     |   No    | Enable support for MySQL      |
+| `sqlite`    |   No    | Enable support for SQLite     |
+
+## State
+
+**This library is in an ALPHA state**, things that are implemented generally work but the API will change in breaking ways.
+
+## Donations
+
+`rust-nostr` is free and open-source. This means we do not earn any revenue by selling it. Instead, we rely on your financial support. If you actively use any of the `rust-nostr` libs/software/services, then please [donate](https://rust-nostr.org/donate).
+
+## License
+
+This project is distributed under the MIT software license - see the [LICENSE](../../LICENSE) file for details

database/nostr-sqldb/README.md

@@ -0,0 +1,31 @@
+// Copyright (c) 2025 Protom
+// Distributed under the MIT software license
+
+use std::time::Duration;
+
+use nostr_database::prelude::*;
+use nostr_relay_builder::prelude::*;
+use nostr_sqldb::NostrPostgres;
+
+// Your database URL
+const DB_URL: &str = "postgres://postgres:password@localhost:5432";
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    tracing_subscriber::fmt::init();
+
+    // Create a nostr db instance and run pending db migrations if any
+    let db = NostrPostgres::new(DB_URL).await?;
+
+    // Add db to builder
+    let builder = RelayBuilder::default().database(db);
+
+    // Create local relay
+    let relay = LocalRelay::run(builder).await?;
+    println!("Url: {}", relay.url());
+
+    // Keep up the program
+    loop {
+        tokio::time::sleep(Duration::from_secs(60)).await;
+    }
+}

database/nostr-sqldb/examples/postgres-relay.rs

@@ -0,0 +1,3 @@
+-- This file should undo anything in `up.sql`
+DROP TABLE IF EXISTS event_tags;
+DROP TABLE IF EXISTS events;

database/nostr-sqldb/migrations/.keep

@@ -0,0 +1,26 @@
+-- The actual event data
+CREATE TABLE IF NOT EXISTS events (
+    id BLOB(32) PRIMARY KEY NOT NULL,
+    pubkey BLOB(32) NOT NULL,
+    created_at BIGINT NOT NULL,
+    kind BIGINT NOT NULL,
+    payload BLOB NOT NULL,
+    deleted BOOLEAN NOT NULL
+);
+
+-- Direct indexes
+CREATE INDEX event_pubkey ON events (pubkey);
+CREATE INDEX event_date ON events (created_at);
+CREATE INDEX event_kind ON events (kind);
+CREATE INDEX event_deleted ON events (deleted);
+
+-- The tag index, the primary will give us the index automatically
+CREATE TABLE IF NOT EXISTS event_tags (
+    tag VARCHAR(64) NOT NULL,
+    tag_value VARCHAR(512) NOT NULL,
+    event_id BLOB(32) NOT NULL
+    REFERENCES events (id)
+    ON DELETE CASCADE
+    ON UPDATE CASCADE,
+    PRIMARY KEY (tag, tag_value, event_id)
+);