sqlspec 0.25.0__py3-none-any.whl → 0.27.0__py3-none-any.whl

sqlspec/adapters/psqlpy/litestar/store.py

@@ -0,0 +1,272 @@
+"""Psqlpy session store for Litestar integration."""
+
+from datetime import datetime, timedelta, timezone
+from typing import TYPE_CHECKING
+
+from sqlspec.extensions.litestar.store import BaseSQLSpecStore
+from sqlspec.utils.logging import get_logger
+
+if TYPE_CHECKING:
+    from sqlspec.adapters.psqlpy.config import PsqlpyConfig
+
+logger = get_logger("adapters.psqlpy.litestar.store")
+
+__all__ = ("PsqlpyStore",)
+
+
+class PsqlpyStore(BaseSQLSpecStore["PsqlpyConfig"]):
+    """PostgreSQL session store using Psqlpy driver.
+
+    Implements server-side session storage for Litestar using PostgreSQL
+    via the Psqlpy driver (Rust-based async driver). Provides efficient
+    session management with:
+    - Native async PostgreSQL operations via Rust
+    - UPSERT support using ON CONFLICT
+    - Automatic expiration handling
+    - Efficient cleanup of expired sessions
+
+    Args:
+        config: PsqlpyConfig instance.
+
+    Example:
+        from sqlspec.adapters.psqlpy import PsqlpyConfig
+        from sqlspec.adapters.psqlpy.litestar.store import PsqlpyStore
+
+        config = PsqlpyConfig(pool_config={"dsn": "postgresql://..."})
+        store = PsqlpyStore(config)
+        await store.create_table()
+    """
+
+    __slots__ = ()
+
+    def __init__(self, config: "PsqlpyConfig") -> None:
+        """Initialize Psqlpy session store.
+
+        Args:
+            config: PsqlpyConfig 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)
+        logger.debug("Created session table: %s", self._table_name)
+
+    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:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+
+            if not rows:
+                return None
+
+            row = rows[0]
+
+            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)
+        logger.debug("Deleted all sessions from table: %s", self._table_name)
+
+    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.
+            Uses fetch() instead of fetch_val() to handle zero-row case.
+        """
+        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:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+            return len(rows) > 0
+
+    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.
+
+        Notes:
+            Uses fetch() to handle the case where the 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:
+            query_result = await conn.fetch(sql, [key])
+            rows = query_result.result()
+
+            if not rows:
+                return None
+
+            expires_at = rows[0]["expires_at"]
+
+            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.
+            Uses RETURNING to get deleted row count since psqlpy QueryResult
+            doesn't expose command tags.
+            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
+        RETURNING session_id
+        """
+
+        async with self._config.provide_connection() as conn:
+            query_result = await conn.fetch(sql, [])
+            rows = query_result.result()
+            count = len(rows)
+            if count > 0:
+                logger.debug("Cleaned up %d expired sessions", count)
+            return count

sqlspec/adapters/psqlpy/type_converter.py

@@ -0,0 +1,102 @@
+"""PostgreSQL-specific type conversion for psqlpy adapter.
+
+Provides specialized type handling for PostgreSQL databases, including
+PostgreSQL-specific types like intervals and arrays while preserving
+backward compatibility.
+"""
+
+import re
+from functools import lru_cache
+from typing import Any, Final
+
+from sqlspec.core.type_conversion import BaseTypeConverter
+
+PG_SPECIFIC_REGEX: Final[re.Pattern[str]] = re.compile(
+    r"^(?:"
+    r"(?P<interval>(?:(?:\d+\s+(?:year|month|day|hour|minute|second)s?\s*)+)|(?:P(?:\d+Y)?(?:\d+M)?(?:\d+D)?(?:T(?:\d+H)?(?:\d+M)?(?:\d+(?:\.\d+)?S)?)?))|"
+    r"(?P<pg_array>\{(?:[^{}]+|\{[^{}]*\})*\})"
+    r")$",
+    re.IGNORECASE,
+)
+
+PG_SPECIAL_CHARS: Final[frozenset[str]] = frozenset({"{", "-", ":", "T", ".", "P", "[", "Y", "M", "D", "H", "S"})
+
+
+class PostgreSQLTypeConverter(BaseTypeConverter):
+    """PostgreSQL-specific type converter with interval and array support.
+
+    Extends the base BaseTypeConverter with PostgreSQL-specific functionality
+    while maintaining backward compatibility for interval and array types.
+    Includes per-instance LRU cache for improved performance.
+    """
+
+    __slots__ = ("_convert_cache",)
+
+    def __init__(self, cache_size: int = 5000) -> None:
+        """Initialize converter with per-instance conversion cache.
+
+        Args:
+            cache_size: Maximum number of string values to cache (default: 5000)
+        """
+        super().__init__()
+
+        @lru_cache(maxsize=cache_size)
+        def _cached_convert(value: str) -> Any:
+            if not value or not any(c in value for c in PG_SPECIAL_CHARS):
+                return value
+            detected_type = self.detect_type(value)
+            return self.convert_value(value, detected_type) if detected_type else value
+
+        self._convert_cache = _cached_convert
+
+    def convert_if_detected(self, value: Any) -> Any:
+        """Convert string if special type detected (cached).
+
+        Args:
+            value: Value to potentially convert
+
+        Returns:
+            Converted value or original value
+        """
+        if not isinstance(value, str):
+            return value
+        return self._convert_cache(value)
+
+    def detect_type(self, value: str) -> str | None:
+        """Detect types including PostgreSQL-specific types.
+
+        Args:
+            value: String value to analyze.
+
+        Returns:
+            Type name if detected, None otherwise.
+        """
+        detected_type = super().detect_type(value)
+        if detected_type:
+            return detected_type
+
+        match = PG_SPECIFIC_REGEX.match(value)
+        if match:
+            for group_name in ["interval", "pg_array"]:
+                if match.group(group_name):
+                    return group_name
+
+        return None
+
+    def convert_value(self, value: str, detected_type: str) -> Any:
+        """Convert value with PostgreSQL-specific handling.
+
+        Args:
+            value: String value to convert.
+            detected_type: Detected type name.
+
+        Returns:
+            Converted value or original string for PostgreSQL-specific types.
+        """
+        if detected_type in {"interval", "pg_array"}:
+            return value
+
+        return super().convert_value(value, detected_type)
+
+
+__all__ = ("PG_SPECIAL_CHARS", "PG_SPECIFIC_REGEX", "PostgreSQLTypeConverter")

sqlspec/adapters/psycopg/_type_handlers.py

@@ -0,0 +1,80 @@
+"""Psycopg pgvector type handlers for vector data type support.
+
+Provides automatic conversion between NumPy arrays and PostgreSQL vector types
+via pgvector-python library. Supports both sync and async connections.
+"""
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from sqlspec.typing import NUMPY_INSTALLED, PGVECTOR_INSTALLED
+
+if TYPE_CHECKING:
+    from psycopg import AsyncConnection, Connection
+
+__all__ = ("register_pgvector_async", "register_pgvector_sync")
+
+
+logger = logging.getLogger(__name__)
+
+
+def register_pgvector_sync(connection: "Connection[Any]") -> None:
+    """Register pgvector type handlers on psycopg sync connection.
+
+    Enables automatic conversion between NumPy arrays and PostgreSQL vector types
+    using the pgvector-python library.
+
+    Args:
+        connection: Psycopg sync connection.
+    """
+    if not PGVECTOR_INSTALLED:
+        logger.debug("pgvector not installed - skipping vector type handlers")
+        return
+
+    if not NUMPY_INSTALLED:
+        logger.debug("NumPy not installed - registering pgvector without NumPy support")
+
+    try:
+        import pgvector.psycopg
+
+        pgvector.psycopg.register_vector(connection)
+        logger.debug("Registered pgvector type handlers on psycopg sync connection")
+    except ValueError as error:
+        message = str(error).lower()
+        if "vector type not found" in message:
+            logger.debug("Skipping pgvector registration - extension not enabled in database")
+            return
+        logger.warning("Unexpected error during pgvector registration: %s", error)
+    except Exception:
+        logger.exception("Failed to register pgvector for psycopg sync")
+
+
+async def register_pgvector_async(connection: "AsyncConnection[Any]") -> None:
+    """Register pgvector type handlers on psycopg async connection.
+
+    Enables automatic conversion between NumPy arrays and PostgreSQL vector types
+    using the pgvector-python library.
+
+    Args:
+        connection: Psycopg async connection.
+    """
+    if not PGVECTOR_INSTALLED:
+        logger.debug("pgvector not installed - skipping vector type handlers")
+        return
+
+    if not NUMPY_INSTALLED:
+        logger.debug("NumPy not installed - registering pgvector without NumPy support")
+
+    try:
+        from pgvector.psycopg import register_vector_async
+
+        await register_vector_async(connection)
+        logger.debug("Registered pgvector type handlers on psycopg async connection")
+    except ValueError as error:
+        message = str(error).lower()
+        if "vector type not found" in message:
+            logger.debug("Skipping pgvector registration - extension not enabled in database")
+            return
+        logger.warning("Unexpected error during pgvector registration: %s", error)
+    except Exception:
+        logger.exception("Failed to register pgvector for psycopg async")

sqlspec/adapters/psycopg/_types.py

@@ -3,8 +3,9 @@ from typing import TYPE_CHECKING
 from psycopg.rows import DictRow as PsycopgDictRow
 
 if TYPE_CHECKING:
+    from typing import TypeAlias
+
     from psycopg import AsyncConnection, Connection
-    from typing_extensions import TypeAlias
 
     PsycopgSyncConnection: TypeAlias = Connection[PsycopgDictRow]
     PsycopgAsyncConnection: TypeAlias = AsyncConnection[PsycopgDictRow]

sqlspec/adapters/psycopg/adk/__init__.py

@@ -0,0 +1,5 @@
+"""Psycopg ADK store module."""
+
+from sqlspec.adapters.psycopg.adk.store import PsycopgAsyncADKStore, PsycopgSyncADKStore
+
+__all__ = ("PsycopgAsyncADKStore", "PsycopgSyncADKStore")