sqlspec 0.47.0__cp314-cp314-win_amd64.whl

sqlspec/adapters/asyncpg/events/backend.py

@@ -0,0 +1,210 @@
+# pyright: reportPrivateUsage=false
+"""Native and hybrid PostgreSQL backends for EventChannel."""
+
+import logging
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING, Any, cast
+
+from sqlspec.adapters.asyncpg.events._hub import AsyncpgListenerHub
+from sqlspec.core import SQL
+from sqlspec.exceptions import ImproperConfigurationError
+from sqlspec.extensions.events import (
+    AsyncTableEventQueue,
+    EventMessage,
+    build_queue_backend,
+    decode_notify_payload,
+    encode_notify_payload,
+)
+from sqlspec.utils.logging import get_logger, log_with_context
+from sqlspec.utils.serializers import from_json, to_json
+from sqlspec.utils.uuids import uuid4
+
+if TYPE_CHECKING:
+    from sqlspec.adapters.asyncpg.config import AsyncpgConfig
+
+logger = get_logger("sqlspec.events.postgres")
+
+__all__ = ("AsyncpgEventsBackend", "AsyncpgHybridEventsBackend", "create_event_backend")
+
+
+def _extract_event_id(payload: "str | None") -> "str | None":
+    if not payload:
+        return None
+    raw = from_json(payload)
+    if isinstance(raw, dict):
+        event_id = raw.get("event_id")
+        return event_id if isinstance(event_id, str) else None
+    return None
+
+
+class AsyncpgHybridEventsBackend:
+    """Hybrid backend combining durable queue with LISTEN/NOTIFY wakeups."""
+
+    __slots__ = ("_config", "_hub", "_queue", "_runtime")
+
+    supports_sync = False
+    supports_async = True
+    backend_name = "listen_notify_durable"
+
+    def __init__(self, config: "AsyncpgConfig", queue: "AsyncTableEventQueue") -> None:
+        if not config.is_async:
+            msg = "Asyncpg hybrid backend requires an async adapter"
+            raise ImproperConfigurationError(msg)
+        self._config = config
+        self._runtime = config.get_observability_runtime()
+        self._queue = queue
+        self._hub: AsyncpgListenerHub | None = None
+        log_with_context(
+            logger,
+            logging.DEBUG,
+            "event.listen",
+            adapter_name="asyncpg",
+            backend_name=self.backend_name,
+            mode="async",
+            status="backend_ready",
+        )
+
+    async def publish(self, channel: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None" = None) -> str:
+        event_id = uuid4().hex
+        await self._publish_durable(channel, event_id, payload, metadata)
+        self._runtime.increment_metric("events.publish.native")
+        return event_id
+
+    async def dequeue(self, channel: str, poll_interval: float) -> EventMessage | None:
+        hub = self._ensure_hub()
+        payload = await hub.dequeue(channel, poll_interval)
+        if payload is None:
+            return await self._queue.dequeue(channel)
+        event_id = _extract_event_id(payload)
+        if event_id is not None:
+            event = await self._queue.dequeue_by_event_id(event_id)
+            if event is not None:
+                return event
+        return await self._queue.dequeue(channel)
+
+    async def ack(self, event_id: str) -> None:
+        await self._queue.ack(event_id)
+        self._runtime.increment_metric("events.ack")
+
+    async def nack(self, event_id: str) -> None:
+        await self._queue.nack(event_id)
+        self._runtime.increment_metric("events.nack")
+
+    async def shutdown(self) -> None:
+        hub = self._hub
+        if hub is not None:
+            self._hub = None
+            await hub.shutdown()
+
+    def _ensure_hub(self) -> AsyncpgListenerHub:
+        if self._hub is None:
+            self._hub = AsyncpgListenerHub(self._config)
+        return self._hub
+
+    async def _publish_durable(
+        self, channel: str, event_id: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None"
+    ) -> None:
+        now = datetime.now(timezone.utc)
+        async with self._config.provide_session() as driver:
+            await driver.execute(
+                SQL(
+                    self._queue._upsert_sql,
+                    {
+                        "event_id": event_id,
+                        "channel": channel,
+                        "payload_json": to_json(payload),
+                        "metadata_json": to_json(metadata) if metadata else None,
+                        "status": "pending",
+                        "available_at": now,
+                        "lease_expires_at": None,
+                        "attempts": 0,
+                        "created_at": now,
+                    },
+                    statement_config=self._queue._statement_config,
+                )
+            )
+            await driver.execute(SQL("SELECT pg_notify($1, $2)", channel, to_json({"event_id": event_id})))
+            await driver.commit()
+
+
+class AsyncpgEventsBackend:
+    """Native LISTEN/NOTIFY backend backed by a persistent listener hub."""
+
+    __slots__ = ("_config", "_hub", "_runtime")
+
+    supports_sync = False
+    supports_async = True
+    backend_name = "listen_notify"
+
+    def __init__(self, config: "AsyncpgConfig") -> None:
+        if not config.is_async:
+            msg = "AsyncpgEventsBackend requires an async adapter"
+            raise ImproperConfigurationError(msg)
+        self._config = config
+        self._runtime = config.get_observability_runtime()
+        self._hub: AsyncpgListenerHub | None = None
+        log_with_context(
+            logger,
+            logging.DEBUG,
+            "event.listen",
+            adapter_name="asyncpg",
+            backend_name=self.backend_name,
+            mode="async",
+            status="backend_ready",
+        )
+
+    async def publish(self, channel: str, payload: "dict[str, Any]", metadata: "dict[str, Any] | None" = None) -> str:
+        event_id = uuid4().hex
+        async with self._config.provide_session() as driver:
+            await driver.execute(
+                SQL("SELECT pg_notify($1, $2)", channel, encode_notify_payload(event_id, payload, metadata))
+            )
+            await driver.commit()
+        self._runtime.increment_metric("events.publish.native")
+        return event_id
+
+    async def dequeue(self, channel: str, poll_interval: float) -> EventMessage | None:
+        hub = self._ensure_hub()
+        payload = await hub.dequeue(channel, poll_interval)
+        if payload is None:
+            return None
+        return decode_notify_payload(channel, payload)
+
+    async def ack(self, _event_id: str) -> None:
+        self._runtime.increment_metric("events.ack")
+
+    async def nack(self, _event_id: str) -> None:
+        """Return an event to the queue (no-op for native LISTEN/NOTIFY)."""
+
+    async def shutdown(self) -> None:
+        hub = self._hub
+        if hub is not None:
+            self._hub = None
+            await hub.shutdown()
+
+    def _ensure_hub(self) -> AsyncpgListenerHub:
+        if self._hub is None:
+            self._hub = AsyncpgListenerHub(self._config)
+        return self._hub
+
+
+def create_event_backend(
+    config: "AsyncpgConfig", backend_name: str, extension_settings: "dict[str, Any]"
+) -> AsyncpgEventsBackend | AsyncpgHybridEventsBackend | None:
+    """Factory used by EventChannel to create the native backend."""
+    match backend_name:
+        case "listen_notify":
+            try:
+                return AsyncpgEventsBackend(config)
+            except ImproperConfigurationError:
+                return None
+        case "listen_notify_durable":
+            queue_backend = cast(
+                "AsyncTableEventQueue", build_queue_backend(config, extension_settings, adapter_name="asyncpg")
+            )
+            try:
+                return AsyncpgHybridEventsBackend(config, queue_backend)
+            except ImproperConfigurationError:
+                return None
+        case _:
+            return None

sqlspec/adapters/asyncpg/events/store.py

@@ -0,0 +1,40 @@
+"""AsyncPG event queue store for PostgreSQL JSONB storage."""
+
+from sqlspec.adapters.asyncpg.config import AsyncpgConfig
+from sqlspec.extensions.events import BaseEventQueueStore
+
+__all__ = ("AsyncpgEventQueueStore",)
+
+
+class AsyncpgEventQueueStore(BaseEventQueueStore[AsyncpgConfig]):
+    """PostgreSQL event queue store with JSONB columns.
+
+    Uses PostgreSQL-native JSONB for efficient JSON storage and querying.
+    TIMESTAMPTZ ensures proper timezone handling.
+
+    Args:
+        config: AsyncpgConfig with extension_config["events"] settings.
+
+    Notes:
+        Configuration is read from config.extension_config["events"]:
+        - queue_table: Table name (default: "sqlspec_event_queue")
+
+    Example:
+        from sqlspec.adapters.asyncpg import AsyncpgConfig
+        from sqlspec.adapters.asyncpg.events import AsyncpgEventQueueStore
+
+        config = AsyncpgConfig(connection_config={"dsn": "postgresql://..."})
+        store = AsyncpgEventQueueStore(config)
+        for stmt in store.create_statements():
+            await driver.execute_script(stmt)
+    """
+
+    __slots__ = ()
+
+    def _column_types(self) -> "tuple[str, str, str]":
+        """Return PostgreSQL-native column types.
+
+        Returns:
+            Tuple of (payload_type, metadata_type, timestamp_type).
+        """
+        return "JSONB", "JSONB", "TIMESTAMPTZ"

sqlspec/adapters/asyncpg/litestar/__init__.py

@@ -0,0 +1,5 @@
+"""Litestar integration for AsyncPG adapter."""
+
+from sqlspec.adapters.asyncpg.litestar.store import AsyncpgStore
+
+__all__ = ("AsyncpgStore",)

sqlspec/adapters/asyncpg/litestar/store.py

@@ -0,0 +1,251 @@
+"""AsyncPG session store for Litestar integration."""
+
+from datetime import datetime, timedelta, timezone
+from typing import TYPE_CHECKING
+
+from sqlspec.extensions.litestar.store import BaseSQLSpecStore
+
+if TYPE_CHECKING:
+    from sqlspec.adapters.asyncpg.config import AsyncpgConfig
+
+
+__all__ = ("AsyncpgStore",)
+
+
+class AsyncpgStore(BaseSQLSpecStore["AsyncpgConfig"]):
+    """PostgreSQL session store using AsyncPG driver.
+
+    Implements server-side session storage for Litestar using PostgreSQL
+    via the AsyncPG driver. Provides efficient session management with:
+    - Native async PostgreSQL operations
+    - UPSERT support using ON CONFLICT
+    - Automatic expiration handling
+    - Efficient cleanup of expired sessions
+
+    Args:
+        config: AsyncpgConfig instance with extension_config["litestar"] settings.
+
+    Example:
+        from sqlspec.adapters.asyncpg import AsyncpgConfig
+        from sqlspec.adapters.asyncpg.litestar.store import AsyncpgStore
+
+        config = AsyncpgConfig(
+            connection_config={"dsn": "postgresql://..."},
+            extension_config={"litestar": {"session_table": "my_sessions"}}
+        )
+        store = AsyncpgStore(config)
+        await store.create_table()
+    """
+
+    __slots__ = ()
+
+    def __init__(self, config: "AsyncpgConfig") -> None:
+        """Initialize AsyncPG session store.
+
+        Args:
+            config: AsyncpgConfig instance.
+
+        Notes:
+            Table name is read from config.extension_config["litestar"]["session_table"].
+        """
+        super().__init__(config)
+
+    def _get_create_table_sql(self) -> str:
+        """Get PostgreSQL CREATE TABLE SQL with optimized schema.
+
+        Returns:
+            SQL statement to create the sessions table with proper indexes.
+
+        Notes:
+            - Uses TIMESTAMPTZ for timezone-aware expiration timestamps
+            - Partial index WHERE expires_at IS NOT NULL reduces index size/maintenance
+            - FILLFACTOR 80 leaves space for HOT updates, reducing table bloat
+            - Audit columns (created_at, updated_at) help with debugging
+            - Table name is internally controlled, not user input (S608 suppressed)
+        """
+        return f"""
+        CREATE TABLE IF NOT EXISTS {self._table_name} (
+            session_id TEXT PRIMARY KEY,
+            data BYTEA NOT NULL,
+            expires_at TIMESTAMPTZ,
+            created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+            updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
+        ) WITH (fillfactor = 80);
+
+        CREATE INDEX IF NOT EXISTS idx_{self._table_name}_expires_at
+        ON {self._table_name}(expires_at) WHERE expires_at IS NOT NULL;
+
+        ALTER TABLE {self._table_name} SET (
+            autovacuum_vacuum_scale_factor = 0.05,
+            autovacuum_analyze_scale_factor = 0.02
+        );
+        """
+
+    def _get_drop_table_sql(self) -> "list[str]":
+        """Get PostgreSQL DROP TABLE SQL statements.
+
+        Returns:
+            List of SQL statements to drop indexes and table.
+        """
+        return [f"DROP INDEX IF EXISTS idx_{self._table_name}_expires_at", f"DROP TABLE IF EXISTS {self._table_name}"]
+
+    async def create_table(self) -> None:
+        """Create the session table if it doesn't exist."""
+        sql = self._get_create_table_sql()
+        async with self._config.provide_session() as driver:
+            await driver.execute_script(sql)
+        self._log_table_created()
+
+    async def get(self, key: str, renew_for: "int | timedelta | None" = None) -> "bytes | None":
+        """Get a session value by key.
+
+        Args:
+            key: Session ID to retrieve.
+            renew_for: If given, renew the expiry time for this duration.
+
+        Returns:
+            Session data as bytes if found and not expired, None otherwise.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP instead of NOW() for SQL standard compliance.
+            The query planner can use the partial index for expires_at > CURRENT_TIMESTAMP.
+        """
+        sql = f"""
+        SELECT data, expires_at FROM {self._table_name}
+        WHERE session_id = $1
+        AND (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)
+        """
+
+        async with self._config.provide_connection() as conn:
+            row = await conn.fetchrow(sql, key)
+
+            if row is None:
+                return None
+
+            if renew_for is not None and row["expires_at"] is not None:
+                new_expires_at = self._calculate_expires_at(renew_for)
+                if new_expires_at is not None:
+                    update_sql = f"""
+                    UPDATE {self._table_name}
+                    SET expires_at = $1, updated_at = CURRENT_TIMESTAMP
+                    WHERE session_id = $2
+                    """
+                    await conn.execute(update_sql, new_expires_at, key)
+
+            return bytes(row["data"])
+
+    async def set(self, key: str, value: "str | bytes", expires_in: "int | timedelta | None" = None) -> None:
+        """Store a session value.
+
+        Args:
+            key: Session ID.
+            value: Session data.
+            expires_in: Time until expiration.
+
+        Notes:
+            Uses EXCLUDED to reference the proposed insert values in ON CONFLICT.
+            Updates updated_at timestamp on every write for audit trail.
+        """
+        data = self._value_to_bytes(value)
+        expires_at = self._calculate_expires_at(expires_in)
+
+        sql = f"""
+        INSERT INTO {self._table_name} (session_id, data, expires_at)
+        VALUES ($1, $2, $3)
+        ON CONFLICT (session_id)
+        DO UPDATE SET
+            data = EXCLUDED.data,
+            expires_at = EXCLUDED.expires_at,
+            updated_at = CURRENT_TIMESTAMP
+        """
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql, key, data, expires_at)
+
+    async def delete(self, key: str) -> None:
+        """Delete a session by key.
+
+        Args:
+            key: Session ID to delete.
+        """
+        sql = f"DELETE FROM {self._table_name} WHERE session_id = $1"
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql, key)
+
+    async def delete_all(self) -> None:
+        """Delete all sessions from the store."""
+        sql = f"DELETE FROM {self._table_name}"
+
+        async with self._config.provide_connection() as conn:
+            await conn.execute(sql)
+        self._log_delete_all()
+
+    async def exists(self, key: str) -> bool:
+        """Check if a session key exists and is not expired.
+
+        Args:
+            key: Session ID to check.
+
+        Returns:
+            True if the session exists and is not expired.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for consistency with get() method.
+        """
+        sql = f"""
+        SELECT 1 FROM {self._table_name}
+        WHERE session_id = $1
+        AND (expires_at IS NULL OR expires_at > CURRENT_TIMESTAMP)
+        """
+
+        async with self._config.provide_connection() as conn:
+            result = await conn.fetchval(sql, key)
+            return result is not None
+
+    async def expires_in(self, key: str) -> "int | None":
+        """Get the time in seconds until the session expires.
+
+        Args:
+            key: Session ID to check.
+
+        Returns:
+            Seconds until expiration, or None if no expiry or key doesn't exist.
+        """
+        sql = f"""
+        SELECT expires_at FROM {self._table_name}
+        WHERE session_id = $1
+        """
+
+        async with self._config.provide_connection() as conn:
+            expires_at = await conn.fetchval(sql, key)
+
+            if expires_at is None:
+                return None
+
+            now = datetime.now(timezone.utc)
+            if expires_at <= now:
+                return 0
+
+            delta = expires_at - now
+            return int(delta.total_seconds())
+
+    async def delete_expired(self) -> int:
+        """Delete all expired sessions.
+
+        Returns:
+            Number of sessions deleted.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for consistency.
+            For very large tables (10M+ rows), consider batching deletes
+            to avoid holding locks too long.
+        """
+        sql = f"DELETE FROM {self._table_name} WHERE expires_at <= CURRENT_TIMESTAMP"
+
+        async with self._config.provide_connection() as conn:
+            result = await conn.execute(sql)
+            count = int(result.split()[-1])
+            if count > 0:
+                self._log_delete_expired(count)
+            return count

sqlspec/adapters/bigquery/__init__.py

@@ -0,0 +1,15 @@
+from sqlspec.adapters.bigquery._typing import BigQueryConnection, BigQueryCursor
+from sqlspec.adapters.bigquery.config import BigQueryConfig, BigQueryConnectionParams, BigQueryDriverFeatures
+from sqlspec.adapters.bigquery.core import default_statement_config
+from sqlspec.adapters.bigquery.driver import BigQueryDriver, BigQueryExceptionHandler
+
+__all__ = (
+    "BigQueryConfig",
+    "BigQueryConnection",
+    "BigQueryConnectionParams",
+    "BigQueryCursor",
+    "BigQueryDriver",
+    "BigQueryDriverFeatures",
+    "BigQueryExceptionHandler",
+    "default_statement_config",
+)

sqlspec/adapters/bigquery/_typing.py

@@ -0,0 +1,108 @@
+"""BigQuery adapter type definitions.
+
+This module contains type aliases and classes that are excluded from mypyc
+compilation to avoid ABI boundary issues.
+"""
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from google.cloud.bigquery import ArrayQueryParameter, Client, QueryJob, ScalarQueryParameter
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from types import TracebackType
+    from typing import TypeAlias
+
+    from sqlspec.adapters.bigquery.driver import BigQueryDriver
+    from sqlspec.core import StatementConfig
+
+    BigQueryConnection: TypeAlias = Client
+    BigQueryParam: TypeAlias = ArrayQueryParameter | ScalarQueryParameter
+
+if not TYPE_CHECKING:
+    BigQueryConnection = Client
+    BigQueryParam = ArrayQueryParameter | ScalarQueryParameter
+
+
+class BigQueryCursor:
+    """BigQuery cursor with resource management."""
+
+    __slots__ = ("connection", "job")
+
+    def __init__(self, connection: "BigQueryConnection") -> None:
+        self.connection = connection
+        self.job: QueryJob | None = None
+
+    def __enter__(self) -> "BigQueryConnection":
+        return self.connection
+
+    def __exit__(self, *_: Any) -> None:
+        """Clean up cursor resources including active QueryJobs."""
+        if self.job is not None:
+            try:
+                # Cancel the job if it's still running to free up resources
+                if self.job.state in {"PENDING", "RUNNING"}:
+                    self.job.cancel()
+                # Clear the job reference
+                self.job = None
+            except Exception:
+                logging.getLogger(__name__).exception("Failed to cancel BigQuery job during cursor cleanup")
+
+
+class BigQuerySessionContext:
+    """Sync context manager for BigQuery sessions.
+
+    This class is intentionally excluded from mypyc compilation to avoid ABI
+    boundary issues. It receives callables from uncompiled config classes and
+    instantiates compiled Driver objects, acting as a bridge between compiled
+    and uncompiled code.
+
+    Uses callable-based connection management to decouple from config implementation.
+    """
+
+    __slots__ = (
+        "_acquire_connection",
+        "_connection",
+        "_driver",
+        "_driver_features",
+        "_prepare_driver",
+        "_release_connection",
+        "_statement_config",
+    )
+
+    def __init__(
+        self,
+        acquire_connection: "Callable[[], Any]",
+        release_connection: "Callable[[Any], Any]",
+        statement_config: "StatementConfig",
+        driver_features: "dict[str, Any]",
+        prepare_driver: "Callable[[BigQueryDriver], BigQueryDriver]",
+    ) -> None:
+        self._acquire_connection = acquire_connection
+        self._release_connection = release_connection
+        self._statement_config = statement_config
+        self._driver_features = driver_features
+        self._prepare_driver = prepare_driver
+        self._connection: Any = None
+        self._driver: BigQueryDriver | None = None
+
+    def __enter__(self) -> "BigQueryDriver":
+        from sqlspec.adapters.bigquery.driver import BigQueryDriver
+
+        self._connection = self._acquire_connection()
+        self._driver = BigQueryDriver(
+            connection=self._connection, statement_config=self._statement_config, driver_features=self._driver_features
+        )
+        return self._prepare_driver(self._driver)
+
+    def __exit__(
+        self, exc_type: "type[BaseException] | None", exc_val: "BaseException | None", exc_tb: "TracebackType | None"
+    ) -> "bool | None":
+        if self._connection is not None:
+            self._release_connection(self._connection)
+            self._connection = None
+        return None
+
+
+__all__ = ("BigQueryConnection", "BigQueryCursor", "BigQueryParam", "BigQuerySessionContext")