xqo-sqlite 3.0.0__py3-none-any.whl

xqo_sqlite/__init__.py

@@ -0,0 +1,134 @@
+"""xqo-sqlite: the "sqlite" event store for xqo.
+
+    pip install xqo-sqlite
+    "storage": {"backend": "sqlite"}                                  # logs/events.db
+    "storage": {"backend": "sqlite", "path": "events.db", "busy_timeout_ms": 5000}
+
+One SQLite file with indexed events: task pages, deletes and history reads don't scan the log. One server process
+per data dir, like every xqo store. `xqo backup` writes a consistent copy through SQLite's online backup API.
+"""
+from __future__ import annotations
+
+import json
+import sqlite3
+import threading
+from pathlib import Path
+from typing import Iterable, Iterator
+
+from xqo.api import SEED_KINDS, EventStore, Plugin, register_store, store_path
+
+__version__ = "3.0.0"
+KEYS = {"backend", "path", "busy_timeout_ms"}
+
+
+class SqliteStore(EventStore):
+    """One SQLite file with indexed events: reads of one task tree, kinds and recent events don't scan the log.
+    WAL mode (readers never block the writer), busy_timeout (a second writer waits instead of failing),
+    synchronous=NORMAL (a crash loses at most the last commits, never the file), a quick_check when it opens."""
+    backend = "sqlite"
+    SCHEMA = """
+    CREATE TABLE IF NOT EXISTS events (
+        seq INTEGER PRIMARY KEY AUTOINCREMENT,
+        ts TEXT, kind TEXT, task_id TEXT, root_id TEXT, data TEXT NOT NULL);
+    CREATE INDEX IF NOT EXISTS events_root ON events(root_id);
+    CREATE INDEX IF NOT EXISTS events_task ON events(task_id);
+    CREATE INDEX IF NOT EXISTS events_kind ON events(kind);
+    """
+
+    def __init__(self, path: str | Path, busy_timeout_ms: int = 5000):
+        self.path = Path(path)
+        self.path.parent.mkdir(parents=True, exist_ok=True)
+        self._lock = threading.Lock()
+        try:
+            self.db = sqlite3.connect(str(self.path), timeout=busy_timeout_ms / 1000, check_same_thread=False,
+                                      isolation_level=None)
+            self.db.execute(f"PRAGMA busy_timeout={int(busy_timeout_ms)}")
+            self.db.execute("PRAGMA journal_mode=WAL")
+            self.db.execute("PRAGMA synchronous=NORMAL")
+            ok = self.db.execute("PRAGMA quick_check").fetchone()[0]
+            if ok != "ok":
+                raise ValueError(f"storage: {self.path} failed its integrity check ({ok}). Restore a backup, or "
+                                 f"recover the readable rows: sqlite3 {self.path} \".recover\" | sqlite3 fixed.db")
+            self.db.executescript(self.SCHEMA)
+        except sqlite3.DatabaseError as e:
+            raise ValueError(f"storage: can't open {self.path}: {e}") from None
+
+    def _rows(self, sql: str, args: tuple = ()) -> list[dict]:
+        with self._lock:
+            rows = self.db.execute(sql, args).fetchall()
+        return [json.loads(r[0]) for r in rows]
+
+    def append(self, d: dict) -> None:
+        with self._lock:
+            self.db.execute("INSERT INTO events(ts, kind, task_id, root_id, data) VALUES (?, ?, ?, ?, ?)",
+                            (d.get("ts"), d.get("kind"), d.get("task_id"), d.get("root_task_id"), json.dumps(d)))
+
+    def recent(self, limit: int) -> list[dict]:
+        return self._rows("SELECT data FROM (SELECT seq, data FROM events ORDER BY seq DESC LIMIT ?) ORDER BY seq",
+                          (int(limit),))
+
+    def seeds(self) -> list[dict]:
+        marks = ",".join("?" * len(SEED_KINDS))
+        return self._rows(f"SELECT data FROM events WHERE kind IN ({marks}) ORDER BY seq", SEED_KINDS)
+
+    def tree(self, root_id: str) -> list[dict]:
+        return self._rows("SELECT data FROM events WHERE root_id = ? OR task_id = ? ORDER BY seq", (root_id, root_id))
+
+    def by_kind_prefix(self, prefix: str) -> list[dict]:
+        esc = prefix.replace("\\", "\\\\").replace("%", "\\%").replace("_", "\\_")
+        return self._rows("SELECT data FROM events WHERE kind LIKE ? ESCAPE '\\' ORDER BY seq", (esc + "%",))
+
+    def purge(self, root_id: str, ids: set[str], keep_kinds: Iterable[str]) -> int:
+        keep = tuple(keep_kinds) or ("",)
+        tids = tuple(ids) or ("",)
+        with self._lock:
+            cur = self.db.execute(
+                f"DELETE FROM events WHERE kind NOT IN ({','.join('?' * len(keep))}) AND "
+                f"(root_id = ? OR task_id = ? OR task_id IN ({','.join('?' * len(tids))}))",
+                (*keep, root_id, root_id, *tids))
+            return cur.rowcount
+
+    def iter_all(self) -> Iterator[dict]:
+        yield from self._rows("SELECT data FROM events ORDER BY seq")
+
+    def count(self) -> int:
+        with self._lock:
+            return self.db.execute("SELECT COUNT(*) FROM events").fetchone()[0]
+
+    def backup_files(self, scratch: Path) -> dict[str, Path]:
+        """A consistent copy through SQLite's online backup API (never a raw copy of a live database)."""
+        scratch.mkdir(parents=True, exist_ok=True)
+        dst = scratch / self.path.name
+        dst.unlink(missing_ok=True)
+        out = sqlite3.connect(str(dst))
+        try:
+            with self._lock:
+                self.db.backup(out)
+        finally:
+            out.close()
+        return {self.path.name: dst}
+
+    def describe(self) -> dict:
+        return {"backend": self.backend, "path": str(self.path), "events": self.count()}
+
+    def close(self) -> None:
+        with self._lock:
+            self.db.close()
+
+
+
+def _factory(cfg: dict, logs: Path) -> SqliteStore:
+    unknown = set(cfg) - KEYS
+    if unknown:
+        raise ValueError(f"storage: unknown setting(s) {', '.join(sorted(unknown))} for sqlite; "
+                         f"known: {', '.join(sorted(KEYS))}")
+    return SqliteStore(store_path(cfg, logs, "events.db"), int(cfg.get("busy_timeout_ms", 5000)))
+
+
+class SqlitePlugin(Plugin):
+    name = "sqlite"
+    description = "SQLite storage backend for the event log"
+
+    @classmethod
+    def register(cls) -> None:
+        register_store("sqlite", _factory)

xqo_sqlite-3.0.0.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: xqo-sqlite
+Version: 3.0.0
+Summary: SQLite event store for xqo
+Author: dudikkocak
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dudikkocak/xqo
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xqo<4,>=3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-timeout>=2.3; extra == "dev"
+Dynamic: license-file
+
+# xqo-sqlite
+
+The `sqlite` event store for [xqo](https://github.com/dudikkocak/xqo): one SQLite file with indexed events, so task
+pages, deletes and history reads don't scan the log.
+
+```bash
+pip install xqo-sqlite
+```
+
+```json
+"storage": {"backend": "sqlite"}
+```
+
+| Key | Default | |
+|---|---|---|
+| `path` | `events.db` | relative to the data dir's `logs/` folder |
+| `busy_timeout_ms` | `5000` | how long a second writer waits instead of failing |
+
+WAL mode (readers never block the writer), `synchronous=NORMAL` (a crash loses at most the last commits, never the
+file), and a quick integrity check when it opens. `xqo backup` writes a consistent copy with SQLite's online
+backup API. `XQO_STORAGE=sqlite` picks it for one run. Switching backends starts an empty store: events are not
+copied between stores.

xqo_sqlite-3.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+xqo_sqlite/__init__.py,sha256=_MdOP18rcJgqBj-jNkWOrNJRbh70HXSlVY32V-yj7Zs,5881
+xqo_sqlite-3.0.0.dist-info/licenses/LICENSE,sha256=PHtf4TI2P6oulwhOKBF8SgeOkDLp9YnLdq46mw6506s,1067
+xqo_sqlite-3.0.0.dist-info/METADATA,sha256=NNOWvSpoqMrV_CYn_Q48t94oXVmwiQLyS5ECK8LYyjk,1250
+xqo_sqlite-3.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+xqo_sqlite-3.0.0.dist-info/entry_points.txt,sha256=eqW5PJKdd3q5cORmJkMyw9xOIZhqgE3rdVK3dhLRHUU,47
+xqo_sqlite-3.0.0.dist-info/top_level.txt,sha256=iZ71a3h6KknBc-cE9KkwOP0WvqF1XbCVnZu6WWhqTtQ,11
+xqo_sqlite-3.0.0.dist-info/RECORD,,

xqo_sqlite-3.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

xqo_sqlite-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[xqo.plugins]
+sqlite = xqo_sqlite:SqlitePlugin

xqo_sqlite-3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dudikkocak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

xqo_sqlite-3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+xqo_sqlite