toolframe-sql-sqlite 0.4.0__py3-none-any.whl

toolframe_sql_sqlite/__init__.py

@@ -0,0 +1 @@
+"""Managed, owner-scoped business storage. No core database access."""

toolframe_sql_sqlite/plugin.py

@@ -0,0 +1,668 @@
+from __future__ import annotations
+
+import asyncio
+import json
+import re
+import sqlite3
+import time
+import uuid
+from dataclasses import dataclass
+from pathlib import Path
+
+from toolframe_sdk import (
+    AuthorizationSpec,
+    MethodSpec,
+    Plugin,
+    PluginDefinition,
+    PluginError,
+    ServiceSpec,
+    StoreSchema,
+    digest,
+)
+
+from .pool import ConnectionPool
+
+SQL_SERVICE = "toolframe.sql"
+ADMIN_SERVICE = "toolframe.sql.admin"
+
+
+def encoded(value):
+    return json.dumps(value, allow_nan=False, separators=(",", ":"))
+
+
+def guard(*, read_only=False):
+    def authorize(action, first, second, database, origin):
+        if action in (
+            sqlite3.SQLITE_ATTACH,
+            sqlite3.SQLITE_DETACH,
+            sqlite3.SQLITE_PRAGMA,
+            sqlite3.SQLITE_TRANSACTION,
+            sqlite3.SQLITE_SAVEPOINT,
+        ):
+            return sqlite3.SQLITE_DENY
+        if any(
+            str(value or "").lower().startswith("_toolframe_")
+            for value in (first, second)
+        ):
+            return sqlite3.SQLITE_DENY
+        if action == sqlite3.SQLITE_FUNCTION and str(second).lower() in (
+            "load_extension",
+            "readfile",
+            "writefile",
+        ):
+            return sqlite3.SQLITE_DENY
+        if read_only and action not in (
+            sqlite3.SQLITE_READ,
+            sqlite3.SQLITE_SELECT,
+            sqlite3.SQLITE_FUNCTION,
+            sqlite3.SQLITE_RECURSIVE,
+        ):
+            return sqlite3.SQLITE_DENY
+        return sqlite3.SQLITE_OK
+
+    return authorize
+
+
+DDL = {
+    getattr(sqlite3, name)
+    for name in (
+        "SQLITE_CREATE_INDEX",
+        "SQLITE_CREATE_TABLE",
+        "SQLITE_CREATE_TEMP_INDEX",
+        "SQLITE_CREATE_TEMP_TABLE",
+        "SQLITE_CREATE_TEMP_TRIGGER",
+        "SQLITE_CREATE_TEMP_VIEW",
+        "SQLITE_CREATE_TRIGGER",
+        "SQLITE_CREATE_VIEW",
+        "SQLITE_DROP_INDEX",
+        "SQLITE_DROP_TABLE",
+        "SQLITE_DROP_TEMP_INDEX",
+        "SQLITE_DROP_TEMP_TABLE",
+        "SQLITE_DROP_TEMP_TRIGGER",
+        "SQLITE_DROP_TEMP_VIEW",
+        "SQLITE_DROP_TRIGGER",
+        "SQLITE_DROP_VIEW",
+        "SQLITE_ALTER_TABLE",
+        "SQLITE_CREATE_VTABLE",
+        "SQLITE_DROP_VTABLE",
+        "SQLITE_REINDEX",
+        "SQLITE_ANALYZE",
+    )
+}
+
+
+def business_guard(*, read_only=False):
+    base = guard(read_only=read_only)
+    return lambda action, *args: (
+        sqlite3.SQLITE_DENY if action in DDL else base(action, *args)
+    )
+
+
+def statements(script):
+    pending = ""
+    for character in script:
+        pending += character
+        if character == ";" and sqlite3.complete_statement(pending):
+            yield pending
+            pending = ""
+    if pending.strip():
+        # SQLite accepts a final statement without a semicolon.
+        yield pending
+
+
+@dataclass
+class Transaction:
+    connection: sqlite3.Connection
+    owner: str
+    generation: str
+    root_id: str
+    deadline: float
+    mutation_id: str
+    pool: ConnectionPool
+    poisoned: bool = False
+
+
+class SqliteProvider(Plugin):
+    def __init__(self, context):
+        super().__init__(context)
+        self.directory = None
+        self.transactions: dict[str, Transaction] = {}
+        self.pools: dict[tuple[str, str, bool], ConnectionPool] = {}
+        self.waiting: dict[str, set[asyncio.Task]] = {}
+        self.pending_writers: dict[tuple[str, str, str, str], int] = {}
+        self.pending_transactions: set[tuple[str, str, str, str]] = set()
+        self.closed = False
+        self.sweeper = None
+
+    async def activate(self):
+        if not self.context.state_directory:
+            raise PluginError(
+                "storage_directory_missing",
+                "Core must allocate the storage provider directory",
+            )
+        self.directory = Path(self.context.state_directory)
+        self.directory.mkdir(parents=True, exist_ok=True)
+        self.sweeper = asyncio.create_task(self._expire())
+
+    async def _expire(self):
+        while True:
+            await asyncio.sleep(0.25)
+            for token, transaction in list(self.transactions.items()):
+                if transaction.deadline <= time.time():
+                    self._rollback(token)
+
+    async def dispose(self):
+        self.closed = True
+        for pool in self.pools.values():
+            pool.close()
+        if self.sweeper:
+            self.sweeper.cancel()
+            await asyncio.gather(self.sweeper, return_exceptions=True)
+        for token in list(self.transactions):
+            self._rollback(token)
+        await super().dispose()
+
+    def identity(self, *, admin=False, owner=None):
+        info = self.context.call_info
+        if admin:
+            if not info.get("management"):
+                raise PluginError("forbidden", "Storage administration is host-only")
+        else:
+            owner = info.get("owner")
+            if not info.get("owner_generation") or not info.get("root_id"):
+                raise PluginError(
+                    "identity_missing",
+                    "Storage calls need a host-issued root and owner generation",
+                )
+            if info.get("deadline", 0) <= time.time():
+                raise PluginError("deadline_exceeded", "Storage root has expired")
+        if not owner or not re.fullmatch(r"[a-z][a-z0-9-]{0,63}", owner):
+            raise PluginError(
+                "invalid_owner", "Storage owner must be a stable plugin ID"
+            )
+        if not info.get("application_id"):
+            raise PluginError("identity_missing", "Application identity is required")
+        return owner, info
+
+    def connect(self, owner, *, create=False):
+        path = self.directory / owner / "data.sqlite"
+        if not create and not path.is_file():
+            raise PluginError(
+                "store_missing", "Store must be initialized before business activation"
+            )
+        path.parent.mkdir(parents=True, exist_ok=True)
+        connection = sqlite3.connect(
+            path, isolation_level=None, timeout=0.05, cached_statements=0
+        )
+        try:
+            connection.row_factory = sqlite3.Row
+            connection.execute("PRAGMA foreign_keys=ON")
+            connection.execute("PRAGMA journal_mode=WAL")
+            connection.execute("PRAGMA busy_timeout=50")
+            if create:
+                connection.executescript("""
+                CREATE TABLE IF NOT EXISTS _toolframe_identity(owner TEXT PRIMARY KEY, application_id TEXT NOT NULL);
+                CREATE TABLE IF NOT EXISTS _toolframe_migrations(position INTEGER PRIMARY KEY, revision TEXT UNIQUE NOT NULL, checksum TEXT NOT NULL);
+                CREATE TABLE IF NOT EXISTS _toolframe_receipts(id TEXT PRIMARY KEY, fingerprint TEXT NOT NULL, result TEXT NOT NULL);
+            """)
+            identity = connection.execute(
+                "SELECT * FROM _toolframe_identity"
+            ).fetchone()
+            application_id = self.context.call_info["application_id"]
+            if identity and (
+                identity["owner"] != owner
+                or identity["application_id"] != application_id
+            ):
+                raise PluginError(
+                    "store_identity_mismatch",
+                    "Database belongs to a different application or plugin",
+                )
+            if identity is None:
+                if not create:
+                    raise PluginError(
+                        "store_identity_missing", "Store has no initialized identity"
+                    )
+                connection.execute(
+                    "INSERT INTO _toolframe_identity VALUES(?,?)",
+                    (owner, application_id),
+                )
+        except BaseException:
+            connection.close()
+            raise
+        return connection
+
+    def inspect(self, owner):
+        if not (self.directory / owner / "data.sqlite").exists():
+            return {"exists": False, "history": [], "revision": None}
+        connection = self.connect(owner)
+        try:
+            history = [
+                dict(row)
+                for row in connection.execute(
+                    "SELECT * FROM _toolframe_migrations ORDER BY position"
+                )
+            ]
+            return {
+                "exists": True,
+                "history": history,
+                "revision": history[-1]["revision"] if history else None,
+            }
+        finally:
+            connection.close()
+
+    def plan(self, owner, schema):
+        schema = StoreSchema.model_validate(schema)
+        history = self.inspect(owner)["history"]
+        for index, row in enumerate(history):
+            if (
+                index >= len(schema.migrations)
+                or row["revision"] != schema.migrations[index].revision
+                or row["checksum"] != schema.migrations[index].checksum
+            ):
+                raise PluginError(
+                    "schema_incompatible",
+                    "Migration history was changed, removed or downgraded",
+                )
+        pending = [item.model_dump() for item in schema.migrations[len(history) :]]
+        current = history[-1]["revision"] if history else None
+        value = {
+            "owner": owner,
+            "current": current,
+            "target": schema.revision,
+            "pending": pending,
+            "history": history,
+            "requires_apply": bool(history and pending),
+        }
+        value["plan_id"] = digest(value)
+        return value
+
+    def migrate(self, owner, schema, *, expected=None, initialize=False):
+        plan = self.plan(owner, schema)
+        if expected is not None and plan["plan_id"] != expected:
+            raise PluginError(
+                "stale_plan", "Store schema changed after migration planning"
+            )
+        if initialize and plan["requires_apply"]:
+            raise PluginError(
+                "migration_required",
+                "Existing data requires explicit migration apply",
+                plan,
+            )
+        if not plan["pending"]:
+            return {"revision": plan["target"], "committed": False}
+        if any(
+            transaction.owner == owner for transaction in self.transactions.values()
+        ):
+            raise PluginError(
+                "store_busy", "Drain all owner transactions before migration"
+            )
+        connection = self.connect(owner, create=True)
+        backup_path = None
+        try:
+            if plan["history"]:
+                backups = self.directory / owner / "backups"
+                backups.mkdir(exist_ok=True)
+                backup_path = backups / f"{int(time.time())}-{uuid.uuid4().hex}.sqlite"
+                backup = sqlite3.connect(backup_path)
+                try:
+                    connection.backup(backup)
+                finally:
+                    backup.close()
+            connection.execute("BEGIN IMMEDIATE")
+            position = len(plan["history"])
+            for migration in StoreSchema.model_validate(schema).migrations[position:]:
+                connection.set_authorizer(guard())
+                connection.set_progress_handler(
+                    lambda: (
+                        time.time()
+                        > self.context.call_info.get("deadline", float("inf"))
+                    ),
+                    1000,
+                )
+                for statement in statements(migration.sql):
+                    connection.execute(statement)
+                connection.set_authorizer(None)
+                connection.execute(
+                    "INSERT INTO _toolframe_migrations VALUES(?,?,?)",
+                    (position, migration.revision, migration.checksum),
+                )
+                position += 1
+            connection.commit()
+            return {
+                "revision": plan["target"],
+                "committed": True,
+                "backup": str(backup_path.relative_to(self.directory))
+                if backup_path
+                else None,
+            }
+        except sqlite3.Error as error:
+            connection.set_authorizer(None)
+            connection.rollback()
+            raise PluginError(
+                "migration_failed",
+                str(error),
+                {"backup": str(backup_path) if backup_path else None},
+            ) from error
+        finally:
+            connection.close()
+
+    def _rollback(self, token):
+        transaction = self.transactions.pop(token, None)
+        if transaction:
+            try:
+                transaction.connection.set_authorizer(None)
+                transaction.connection.set_progress_handler(None, 0)
+                transaction.connection.rollback()
+            finally:
+                transaction.pool.release(transaction.connection)
+
+    async def borrow(self, owner, info, *, write, begin=False):
+        if self.closed:
+            raise PluginError("storage_stopped", "Storage connections are closed")
+        if not (self.directory / owner / "data.sqlite").is_file():
+            raise PluginError(
+                "store_missing", "Store must be initialized before business activation"
+            )
+        writer = (
+            info["application_id"],
+            owner,
+            info["owner_generation"],
+            info["root_id"],
+        )
+        if write and (
+            writer in self.pending_transactions
+            or (begin and self.pending_writers.get(writer, 0))
+            or any(
+                (transaction.owner, transaction.generation, transaction.root_id)
+                == writer[1:]
+                for transaction in self.transactions.values()
+            )
+        ):
+            raise PluginError(
+                "nested_transaction",
+                "Await pending writes and use the transaction token for the same root/store",
+            )
+        key = (info["application_id"], owner, write)
+        pool = self.pools.get(key)
+        if pool is None:
+            pool = self.pools[key] = ConnectionPool(lambda: self.connect(owner))
+        task = asyncio.current_task()
+        root = info["root_id"]
+        self.waiting.setdefault(root, set()).add(task)
+        # Reserve admission before yielding: a queued begin must not end up
+        # holding the writer while another unscoped call from its root waits.
+        if write:
+            self.pending_writers[writer] = self.pending_writers.get(writer, 0) + 1
+            if begin:
+                self.pending_transactions.add(writer)
+        try:
+            return pool, await pool.acquire(info["deadline"])
+        finally:
+            if write:
+                self.pending_writers[writer] -= 1
+                if not self.pending_writers[writer]:
+                    del self.pending_writers[writer]
+                if begin:
+                    self.pending_transactions.discard(writer)
+            self.waiting[root].discard(task)
+            if not self.waiting[root]:
+                del self.waiting[root]
+
+    def _transaction(self, token, owner, info):
+        transaction = self.transactions.get(token)
+        if not transaction or (
+            transaction.owner,
+            transaction.generation,
+            transaction.root_id,
+        ) != (owner, info["owner_generation"], info["root_id"]):
+            raise PluginError(
+                "transaction_invalid",
+                "Transaction is not owned by this root and generation",
+            )
+        if transaction.deadline <= time.time():
+            self._rollback(token)
+            raise PluginError("transaction_expired", "Transaction deadline exceeded")
+        return transaction
+
+    def receipt(self, connection, identifier, fingerprint=None):
+        row = connection.execute(
+            "SELECT fingerprint, result FROM _toolframe_receipts WHERE id=?",
+            (identifier,),
+        ).fetchone()
+        if row and fingerprint is not None and row["fingerprint"] != fingerprint:
+            raise PluginError(
+                "mutation_conflict",
+                "Mutation ID already refers to different SQL/parameters",
+            )
+        return json.loads(row["result"]) if row else None
+
+    def mutation_id(self, params):
+        value = params.get("mutation_id")
+        if not isinstance(value, str) or not re.fullmatch(
+            r"[a-zA-Z0-9_.:-]{1,128}", value
+        ):
+            raise PluginError(
+                "mutation_id_invalid", "A bounded stable mutation ID is required"
+            )
+        return value
+
+    async def invoke(self, service, method, params):
+        if service == ADMIN_SERVICE:
+            if method == "cleanup_root":
+                if not self.context.call_info.get("management"):
+                    raise PluginError("forbidden", "Root cleanup is host-only")
+                for task in tuple(self.waiting.get(params["root_id"], ())):
+                    task.cancel()
+                for token, transaction in list(self.transactions.items()):
+                    if transaction.root_id == params["root_id"]:
+                        self._rollback(token)
+                return {}
+            owner, _ = self.identity(admin=True, owner=params.get("owner"))
+            if method == "inspect":
+                return self.inspect(owner)
+            if method == "plan":
+                return self.plan(owner, params["schema"])
+            if method == "ensure_store":
+                return self.migrate(owner, params["schema"], initialize=True)
+            if method == "apply":
+                return self.migrate(owner, params["schema"], expected=params["plan_id"])
+            raise PluginError("method_not_found", method)
+        if service != SQL_SERVICE:
+            raise PluginError("method_not_found", service)
+        owner, info = self.identity()
+        token = params.get("transaction")
+        transaction = self._transaction(token, owner, info) if token else None
+        if transaction and transaction.poisoned and method != "rollback":
+            raise PluginError(
+                "transaction_poisoned",
+                "A failed statement poisoned this transaction; roll it back",
+            )
+        if transaction:
+            pool, connection = transaction.pool, transaction.connection
+        else:
+            if method in ("commit", "rollback"):
+                raise PluginError(
+                    "transaction_required", "A transaction token is required"
+                )
+            if method not in (
+                "query",
+                "execute",
+                "execute_returning",
+                "begin",
+                "receipt",
+            ):
+                raise PluginError("method_not_found", method)
+            pool, connection = await self.borrow(
+                owner,
+                info,
+                write=method in ("begin", "execute", "execute_returning"),
+                begin=method == "begin",
+            )
+        keep = transaction is not None
+        cursor = None
+        try:
+            connection.set_authorizer(None)
+            connection.set_progress_handler(None, 0)
+            if method == "receipt":
+                return {"receipt": self.receipt(connection, self.mutation_id(params))}
+            if method == "begin":
+                mutation_id = self.mutation_id(params)
+                prior = self.receipt(connection, mutation_id, "transaction")
+                if prior:
+                    return prior
+                if transaction:
+                    raise PluginError(
+                        "nested_transaction", "Nested transactions are unsupported"
+                    )
+                connection.execute("BEGIN IMMEDIATE")
+                token = uuid.uuid4().hex
+                self.transactions[token] = Transaction(
+                    connection,
+                    owner,
+                    info["owner_generation"],
+                    info["root_id"],
+                    info["deadline"],
+                    mutation_id,
+                    pool,
+                )
+                keep = True
+                return {"transaction": token, "mutation_id": mutation_id}
+            if method == "rollback":
+                if not transaction:
+                    raise PluginError(
+                        "transaction_required", "Rollback needs a transaction"
+                    )
+                self._rollback(token)
+                return {"rolled_back": True}
+            if method == "commit":
+                if not transaction:
+                    raise PluginError(
+                        "transaction_required", "Commit needs a transaction"
+                    )
+                result = {"committed": True, "mutation_id": transaction.mutation_id}
+                connection.execute(
+                    "INSERT INTO _toolframe_receipts VALUES(?,?,?)",
+                    (transaction.mutation_id, "transaction", encoded(result)),
+                )
+                connection.commit()
+                self.transactions.pop(token)
+                pool.release(connection)
+                return result
+            if method not in ("query", "execute", "execute_returning"):
+                raise PluginError("method_not_found", method)
+            sql, parameters = params["sql"], params.get("parameters", [])
+            fingerprint = digest({"sql": sql, "parameters": parameters})
+            if method == "execute_returning":
+                fingerprint = digest(
+                    {"sql": sql, "parameters": parameters, "returning": True}
+                )
+            mutation_id = None
+            if method in ("execute", "execute_returning") and not transaction:
+                mutation_id = self.mutation_id(params)
+                prior = self.receipt(connection, mutation_id, fingerprint)
+                if prior is not None:
+                    return prior
+                connection.execute("BEGIN IMMEDIATE")
+            base_guard = business_guard(read_only=method == "query")
+            mutation_seen = False
+
+            def authorize(action, *arguments):
+                nonlocal mutation_seen
+                if action in (
+                    sqlite3.SQLITE_INSERT,
+                    sqlite3.SQLITE_UPDATE,
+                    sqlite3.SQLITE_DELETE,
+                ):
+                    mutation_seen = True
+                return base_guard(action, *arguments)
+
+            connection.set_authorizer(authorize)
+            connection.set_progress_handler(
+                lambda: time.time() > info["deadline"], 1000
+            )
+            cursor = connection.execute(sql, parameters)
+            if method in ("query", "execute_returning"):
+                if method == "execute_returning" and not mutation_seen:
+                    raise PluginError(
+                        "mutation_required", "Use query for read-only statements"
+                    )
+                if method == "execute_returning" and not cursor.description:
+                    raise PluginError(
+                        "result_required", "Mutation must include RETURNING"
+                    )
+                rows = cursor.fetchmany(10001)
+                if len(rows) > 10000:
+                    raise PluginError(
+                        "result_too_large",
+                        "Use LIMIT/pagination; query exceeds 10,000 rows",
+                    )
+                result = [dict(row) for row in rows]
+                if method == "execute_returning":
+                    result = {"rows": result, "rowcount": cursor.rowcount}
+            else:
+                if cursor.description:
+                    raise PluginError(
+                        "result_not_supported",
+                        "Use a transaction with query after mutation; execute cannot return rows",
+                    )
+                result = {"rowcount": cursor.rowcount, "lastrowid": cursor.lastrowid}
+            if len(encoded(result).encode()) > 900_000:
+                raise PluginError(
+                    "result_too_large",
+                    "Use pagination; query exceeds the RPC result budget",
+                )
+            connection.set_authorizer(None)
+            if mutation_id:
+                connection.execute(
+                    "INSERT INTO _toolframe_receipts VALUES(?,?,?)",
+                    (mutation_id, fingerprint, encoded(result)),
+                )
+                connection.commit()
+            return result
+        except (sqlite3.Error, PluginError, ValueError, TypeError) as error:
+            if transaction:
+                transaction.poisoned = True
+            else:
+                connection.set_authorizer(None)
+                connection.rollback()
+            if isinstance(error, PluginError):
+                raise
+            raise PluginError("sql_failed", str(error)) from error
+        finally:
+            if cursor is not None:
+                cursor.close()
+            if not keep:
+                pool.release(connection)
+
+
+plugin = PluginDefinition(
+    id="sql-sqlite",
+    kind="provider",
+    provider_kind="sql",
+    factory="toolframe_sql_sqlite.plugin:SqliteProvider",
+    authorization=AuthorizationSpec(),
+    services={
+        SQL_SERVICE: ServiceSpec(
+            methods={
+                name: MethodSpec(
+                    audience="internal", read_only=name in ("query", "receipt")
+                )
+                for name in (
+                    "query",
+                    "execute",
+                    "execute_returning",
+                    "begin",
+                    "commit",
+                    "rollback",
+                    "receipt",
+                )
+            }
+        ),
+        ADMIN_SERVICE: ServiceSpec(
+            methods={
+                name: MethodSpec(audience="internal")
+                for name in ("inspect", "ensure_store", "plan", "apply", "cleanup_root")
+            }
+        ),
+    },
+)

toolframe_sql_sqlite/pool.py

@@ -0,0 +1,87 @@
+"""A reusable connection slot with cancellable, deadline-bound admission."""
+
+from __future__ import annotations
+
+import asyncio
+import contextlib
+import sqlite3
+import time
+from collections.abc import Callable
+
+from toolframe_sdk import PluginError
+
+
+class ConnectionPool:
+    """Keep one connection leased until the caller has finished its transaction.
+
+    Each store has separate reader and writer pools. SQLite statements still run
+    synchronously; waiting for a writer slot must yield so its holder can commit.
+    """
+
+    def __init__(self, connect: Callable[[], sqlite3.Connection]):
+        self.connect = connect
+        self.available: asyncio.Queue[sqlite3.Connection | None] = asyncio.Queue(1)
+        self.available.put_nowait(None)
+        self.waiters = 0
+        self.closed = False
+
+    async def acquire(self, deadline: float) -> sqlite3.Connection:
+        if self.closed:
+            raise PluginError("storage_stopped", "Storage connections are closed")
+        if deadline <= time.time():
+            raise PluginError("deadline_exceeded", "Storage root has expired")
+        if self.available.empty() and self.waiters >= 128:
+            raise PluginError(
+                "storage_busy", "Storage connection queue is full; no statement was run"
+            )
+        self.waiters += 1
+        try:
+            async with asyncio.timeout(deadline - time.time()):
+                connection = await self.available.get()
+        except TimeoutError as error:
+            raise PluginError(
+                "deadline_exceeded",
+                "Deadline exceeded waiting for a storage connection",
+            ) from error
+        except asyncio.QueueShutDown as error:
+            raise PluginError(
+                "storage_stopped", "Storage connections are closed"
+            ) from error
+        finally:
+            self.waiters -= 1
+        try:
+            # Recheck after admission: the waiting request may now be stale.
+            if deadline <= time.time():
+                raise PluginError("deadline_exceeded", "Storage root has expired")
+            return connection if connection is not None else self.connect()
+        except BaseException:
+            if connection is not None:
+                self.release(connection)
+            elif not self.closed:
+                self.available.put_nowait(None)
+            raise
+
+    def release(self, connection: sqlite3.Connection) -> None:
+        try:
+            connection.set_authorizer(None)
+            connection.set_progress_handler(None, 0)
+            if connection.in_transaction:
+                connection.rollback()
+        except sqlite3.Error:
+            # A failed reset must never leak transaction/guard state to a borrower.
+            with contextlib.suppress(sqlite3.Error):
+                connection.close()
+            connection = None
+        if self.closed:
+            if connection is not None:
+                connection.close()
+        else:
+            self.available.put_nowait(connection)
+
+    def close(self) -> None:
+        self.closed = True
+        while not self.available.empty():
+            connection = self.available.get_nowait()
+            if connection is not None:
+                connection.close()
+        self.available.shutdown(immediate=True)

toolframe_sql_sqlite-0.4.0.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.5
+Name: toolframe-sql-sqlite
+Version: 0.4.0
+Summary: Isolated managed SQLite stores for Toolframe plugins
+Project-URL: Homepage, https://github.com/toolframe/toolframe-sql-sqlite
+Project-URL: Repository, https://github.com/toolframe/toolframe-sql-sqlite
+Project-URL: Documentation, https://github.com/toolframe/toolframe-sql-sqlite#readme
+Project-URL: Issues, https://github.com/toolframe/toolframe-sql-sqlite/issues
+Author-email: byfb <62798989+byfb@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.14
+Requires-Dist: toolframe-sdk==0.4.0
+Description-Content-Type: text/markdown
+
+# Toolframe SQLite provider
+
+`sql-sqlite` owns `data/plugins/<plugin-id>/data.sqlite`, separately from core's
+management database. Plugins use `RuntimeContext.sql()` and parameterized SQL;
+the host supplies application, owner, generation, root and deadline identity.
+No file path or raw connection is returned. This is lifecycle/data ownership
+isolation for trusted local plugins, not an operating-system sandbox.
+
+Install the provider into a running application before enabling plugins that
+require managed SQL:
+
+```sh
+toolframe --home APP plugin add pypi:toolframe-sql-sqlite==0.4.0 --enable
+```
+
+Normal SQL supports queries, mutations, indexes declared in migrations, and
+same-store transactions. Runtime DDL, transaction control, attachment, PRAGMAs
+and provider metadata access are denied by SQLite's authorizer. Transactions are
+bound to one root/generation and roll back on expiry, root loss or disposal. A
+statement failure poisons a transaction. Mutation IDs and same-database receipts
+allow callers to resolve an unknown acknowledgement without repeating a write.
+
+Each application/owner store lazily pools one writer connection and one separate
+reader connection. A transaction retains the writer until commit, rollback,
+expiry or root cleanup; standalone mutations use the same writer. Other writes
+wait asynchronously instead of opening competing write connections, leaving the
+holder free to finish its next RPC. Committed-state reads and other owners can
+proceed while a transaction is open. Return all writes within a transaction through
+its transaction client/token; a second unscoped writer from the same root/store
+is rejected as `nested_transaction` instead of waiting on itself.
+A queued transaction also reserves its root/store: await an earlier write before
+beginning a transaction, and await `begin` before issuing its token-bound writes.
+
+Each connection slot permits at most 128 waiting calls. Admission obeys the
+host-issued root deadline and cancellation; a full queue returns `storage_busy`
+before that call runs SQL. Connections are reset before reuse and closed on
+provider disposal. This coordinates one provider process, not arbitrary external
+SQLite writers. SQL execution is still synchronous and external lock contention
+retains SQLite's 50ms busy timeout. Pooling does not provide business idempotency
+or make long-running SQL nonblocking.
+
+Empty stores initialize automatically. Existing schema changes require a core
+migration plan and explicit apply. Apply checks the plan/history, uses SQLite's
+backup API, executes all pending migrations and history in one transaction, and
+rolls back failures. Nontransactional statements are rejected. Committed schema
+changes are never automatically reverted; backups require an explicit operator
+repair workflow. Disabling/uninstalling a plugin retains its database.
+
+The `toolframe.sql.admin` service is host-only. Business plugins declare a
+requirement on `toolframe.sql` version 1. Cross-plugin data access uses the
+owning plugin's business service. There are no cross-database transactions.
+
+Development: `uv sync --group dev`, `uv run pytest -q`, `uv build --no-sources`.
+The sibling SDK UV source is a development convenience; wheels depend only on the
+published SDK contract.
+
+For isolated local validation, GitHub Actions and manual TestPyPI/PyPI publishing,
+see [CI and publishing](docs/ci.md).
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+
+Version 0.3 adds `execute_returning` for mutations with a `RETURNING` clause. It
+returns `rows` and `rowcount`, including within transactions and durable mutation
+receipts. Existing SQLite SQL, migration checksums and `execute` results are
+preserved; PostgreSQL variants in migration declarations do not change SQLite
+history.
+
+For development hooks and contribution rules, see [Contributing](CONTRIBUTING.md).

toolframe_sql_sqlite-0.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+toolframe_sql_sqlite/__init__.py,sha256=OletQvo8Mnhk6l51nNE15-yutIAY8WjwFtfVkuHBhkk,71
+toolframe_sql_sqlite/plugin.py,sha256=ziSvp1VNI6tF_cY1CzukrgbQTyTOiYFdC7wQZ52uyy0,25768
+toolframe_sql_sqlite/pool.py,sha256=Kho4Evaqp3-zce0t-rjBFPmBykz_09G427KTZ1blrTA,3286
+toolframe_sql_sqlite-0.4.0.dist-info/METADATA,sha256=0HaMenCPQ1511d9vlpPtn3VLIEg5_xlwGoupHmfozes,4662
+toolframe_sql_sqlite-0.4.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+toolframe_sql_sqlite-0.4.0.dist-info/entry_points.txt,sha256=BOXIWBwsSFUrESoZ8BkhEElEQvTlM-EYuS-AhjxofCU,68
+toolframe_sql_sqlite-0.4.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+toolframe_sql_sqlite-0.4.0.dist-info/licenses/NOTICE,sha256=sAPT0OAmPkE2Imb4BU15aQdz7Wcv9g3XE9x8AOrMjjo,41
+toolframe_sql_sqlite-0.4.0.dist-info/RECORD,,

toolframe_sql_sqlite-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

toolframe_sql_sqlite-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[toolframe.plugins]
+sql-sqlite = toolframe_sql_sqlite.plugin:plugin

toolframe_sql_sqlite-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

toolframe_sql_sqlite-0.4.0.dist-info/licenses/NOTICE

@@ -0,0 +1,2 @@
+toolframe-sql-sqlite
+Copyright 2026 byfb