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

sqlspec/adapters/psqlpy/adk/store.py

@@ -0,0 +1,482 @@
+"""Psqlpy ADK store for Google Agent Development Kit session/event storage."""
+
+from typing import TYPE_CHECKING, Any, Final
+
+import psqlpy.exceptions
+
+from sqlspec.extensions.adk import BaseAsyncADKStore, EventRecord, SessionRecord
+from sqlspec.utils.logging import get_logger
+
+if TYPE_CHECKING:
+    from datetime import datetime
+
+    from sqlspec.adapters.psqlpy.config import PsqlpyConfig
+
+logger = get_logger("adapters.psqlpy.adk.store")
+
+__all__ = ("PsqlpyADKStore",)
+
+POSTGRES_TABLE_NOT_FOUND_SQLSTATE: Final = "42P01"
+
+
+class PsqlpyADKStore(BaseAsyncADKStore["PsqlpyConfig"]):
+    """PostgreSQL ADK store using Psqlpy driver.
+
+    Implements session and event storage for Google Agent Development Kit
+    using PostgreSQL via the high-performance Rust-based psqlpy driver.
+
+    Provides:
+    - Session state management with JSONB storage
+    - Event history tracking with BYTEA-serialized actions
+    - Microsecond-precision timestamps with TIMESTAMPTZ
+    - Foreign key constraints with cascade delete
+    - Efficient upserts using ON CONFLICT
+    - GIN indexes for JSONB queries
+    - HOT updates with FILLFACTOR 80
+
+    Args:
+        config: PsqlpyConfig with extension_config["adk"] settings.
+
+    Example:
+        from sqlspec.adapters.psqlpy import PsqlpyConfig
+        from sqlspec.adapters.psqlpy.adk import PsqlpyADKStore
+
+        config = PsqlpyConfig(
+            pool_config={"dsn": "postgresql://..."},
+            extension_config={
+                "adk": {
+                    "session_table": "my_sessions",
+                    "events_table": "my_events",
+                    "owner_id_column": "tenant_id INTEGER NOT NULL REFERENCES tenants(id) ON DELETE CASCADE"
+                }
+            }
+        )
+        store = PsqlpyADKStore(config)
+        await store.create_tables()
+
+    Notes:
+        - PostgreSQL JSONB type used for state (more efficient than JSON)
+        - Psqlpy automatically converts Python dicts to/from JSONB
+        - TIMESTAMPTZ provides timezone-aware microsecond precision
+        - BYTEA for pre-serialized actions from Google ADK
+        - GIN index on state for JSONB queries (partial index)
+        - FILLFACTOR 80 leaves space for HOT updates
+        - Uses PostgreSQL numeric parameter style ($1, $2, $3)
+        - Configuration is read from config.extension_config["adk"]
+    """
+
+    __slots__ = ()
+
+    def __init__(self, config: "PsqlpyConfig") -> None:
+        """Initialize Psqlpy ADK store.
+
+        Args:
+            config: PsqlpyConfig instance.
+
+        Notes:
+            Configuration is read from config.extension_config["adk"]:
+            - session_table: Sessions table name (default: "adk_sessions")
+            - events_table: Events table name (default: "adk_events")
+            - owner_id_column: Optional owner FK column DDL (default: None)
+        """
+        super().__init__(config)
+
+    def _get_create_sessions_table_sql(self) -> str:
+        """Get PostgreSQL CREATE TABLE SQL for sessions.
+
+        Returns:
+            SQL statement to create adk_sessions table with indexes.
+
+        Notes:
+            - VARCHAR(128) for IDs and names (sufficient for UUIDs and app names)
+            - JSONB type for state storage with default empty object
+            - TIMESTAMPTZ with microsecond precision
+            - FILLFACTOR 80 for HOT updates (reduces table bloat)
+            - Composite index on (app_name, user_id) for listing
+            - Index on update_time DESC for recent session queries
+            - Partial GIN index on state for JSONB queries (only non-empty)
+            - Optional owner ID column for multi-tenancy or user references
+        """
+        owner_id_line = ""
+        if self._owner_id_column_ddl:
+            owner_id_line = f",\n            {self._owner_id_column_ddl}"
+
+        return f"""
+        CREATE TABLE IF NOT EXISTS {self._session_table} (
+            id VARCHAR(128) PRIMARY KEY,
+            app_name VARCHAR(128) NOT NULL,
+            user_id VARCHAR(128) NOT NULL{owner_id_line},
+            state JSONB NOT NULL DEFAULT '{{}}'::jsonb,
+            create_time TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+            update_time TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
+        ) WITH (fillfactor = 80);
+
+        CREATE INDEX IF NOT EXISTS idx_{self._session_table}_app_user
+            ON {self._session_table}(app_name, user_id);
+
+        CREATE INDEX IF NOT EXISTS idx_{self._session_table}_update_time
+            ON {self._session_table}(update_time DESC);
+
+        CREATE INDEX IF NOT EXISTS idx_{self._session_table}_state
+            ON {self._session_table} USING GIN (state)
+            WHERE state != '{{}}'::jsonb;
+        """
+
+    def _get_create_events_table_sql(self) -> str:
+        """Get PostgreSQL CREATE TABLE SQL for events.
+
+        Returns:
+            SQL statement to create adk_events table with indexes.
+
+        Notes:
+            - VARCHAR sizes: id(128), session_id(128), invocation_id(256), author(256),
+              branch(256), error_code(256), error_message(1024)
+            - BYTEA for pre-serialized actions (no size limit)
+            - JSONB for content, grounding_metadata, custom_metadata, long_running_tool_ids_json
+            - BOOLEAN for partial, turn_complete, interrupted
+            - Foreign key to sessions with CASCADE delete
+            - Index on (session_id, timestamp ASC) for ordered event retrieval
+        """
+        return f"""
+        CREATE TABLE IF NOT EXISTS {self._events_table} (
+            id VARCHAR(128) PRIMARY KEY,
+            session_id VARCHAR(128) NOT NULL,
+            app_name VARCHAR(128) NOT NULL,
+            user_id VARCHAR(128) NOT NULL,
+            invocation_id VARCHAR(256),
+            author VARCHAR(256),
+            actions BYTEA,
+            long_running_tool_ids_json JSONB,
+            branch VARCHAR(256),
+            timestamp TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+            content JSONB,
+            grounding_metadata JSONB,
+            custom_metadata JSONB,
+            partial BOOLEAN,
+            turn_complete BOOLEAN,
+            interrupted BOOLEAN,
+            error_code VARCHAR(256),
+            error_message VARCHAR(1024),
+            FOREIGN KEY (session_id) REFERENCES {self._session_table}(id) ON DELETE CASCADE
+        );
+
+        CREATE INDEX IF NOT EXISTS idx_{self._events_table}_session
+            ON {self._events_table}(session_id, timestamp ASC);
+        """
+
+    def _get_drop_tables_sql(self) -> "list[str]":
+        """Get PostgreSQL DROP TABLE SQL statements.
+
+        Returns:
+            List of SQL statements to drop tables and indexes.
+
+        Notes:
+            Order matters: drop events table (child) before sessions (parent).
+            PostgreSQL automatically drops indexes when dropping tables.
+        """
+        return [f"DROP TABLE IF EXISTS {self._events_table}", f"DROP TABLE IF EXISTS {self._session_table}"]
+
+    async def create_tables(self) -> None:
+        """Create both sessions and events tables if they don't exist.
+
+        Notes:
+            Psqlpy doesn't support multiple statements in a single execute.
+            Splits SQL statements and executes them separately.
+            Creates sessions table first, then events table (FK dependency).
+        """
+        async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+            sessions_sql = self._get_create_sessions_table_sql()
+            for statement in sessions_sql.split(";"):
+                statement = statement.strip()
+                if statement:
+                    await conn.execute(statement, [])
+
+            events_sql = self._get_create_events_table_sql()
+            for statement in events_sql.split(";"):
+                statement = statement.strip()
+                if statement:
+                    await conn.execute(statement, [])
+        logger.debug("Created ADK tables: %s, %s", self._session_table, self._events_table)
+
+    async def create_session(
+        self, session_id: str, app_name: str, user_id: str, state: "dict[str, Any]", owner_id: "Any | None" = None
+    ) -> SessionRecord:
+        """Create a new session.
+
+        Args:
+            session_id: Unique session identifier.
+            app_name: Application name.
+            user_id: User identifier.
+            state: Initial session state.
+            owner_id: Optional owner ID value for owner_id_column (if configured).
+
+        Returns:
+            Created session record.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for create_time and update_time.
+            State is passed as dict and psqlpy converts to JSONB automatically.
+            If owner_id_column is configured, owner_id value must be provided.
+        """
+        async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+            if self._owner_id_column_name:
+                sql = f"""
+                INSERT INTO {self._session_table}
+                (id, app_name, user_id, {self._owner_id_column_name}, state, create_time, update_time)
+                VALUES ($1, $2, $3, $4, $5, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
+                """
+                await conn.execute(sql, [session_id, app_name, user_id, owner_id, state])
+            else:
+                sql = f"""
+                INSERT INTO {self._session_table} (id, app_name, user_id, state, create_time, update_time)
+                VALUES ($1, $2, $3, $4, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP)
+                """
+                await conn.execute(sql, [session_id, app_name, user_id, state])
+
+        return await self.get_session(session_id)  # type: ignore[return-value]
+
+    async def get_session(self, session_id: str) -> "SessionRecord | None":
+        """Get session by ID.
+
+        Args:
+            session_id: Session identifier.
+
+        Returns:
+            Session record or None if not found.
+
+        Notes:
+            PostgreSQL returns datetime objects for TIMESTAMPTZ columns.
+            JSONB is automatically parsed by psqlpy to Python dicts.
+            Returns None if table doesn't exist (catches database errors).
+        """
+        sql = f"""
+        SELECT id, app_name, user_id, state, create_time, update_time
+        FROM {self._session_table}
+        WHERE id = $1
+        """
+
+        try:
+            async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+                result = await conn.fetch(sql, [session_id])
+                rows: list[dict[str, Any]] = result.result() if result else []
+
+                if not rows:
+                    return None
+
+                row = rows[0]
+                return SessionRecord(
+                    id=row["id"],
+                    app_name=row["app_name"],
+                    user_id=row["user_id"],
+                    state=row["state"],
+                    create_time=row["create_time"],
+                    update_time=row["update_time"],
+                )
+        except psqlpy.exceptions.DatabaseError as e:
+            error_msg = str(e).lower()
+            if "does not exist" in error_msg or "relation" in error_msg:
+                return None
+            raise
+
+    async def update_session_state(self, session_id: str, state: "dict[str, Any]") -> None:
+        """Update session state.
+
+        Args:
+            session_id: Session identifier.
+            state: New state dictionary (replaces existing state).
+
+        Notes:
+            This replaces the entire state dictionary.
+            Uses CURRENT_TIMESTAMP for update_time.
+            Psqlpy automatically converts dict to JSONB.
+        """
+        sql = f"""
+        UPDATE {self._session_table}
+        SET state = $1, update_time = CURRENT_TIMESTAMP
+        WHERE id = $2
+        """
+
+        async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+            await conn.execute(sql, [state, session_id])
+
+    async def delete_session(self, session_id: str) -> None:
+        """Delete session and all associated events (cascade).
+
+        Args:
+            session_id: Session identifier.
+
+        Notes:
+            Foreign key constraint ensures events are cascade-deleted.
+        """
+        sql = f"DELETE FROM {self._session_table} WHERE id = $1"
+
+        async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+            await conn.execute(sql, [session_id])
+
+    async def list_sessions(self, app_name: str, user_id: str) -> "list[SessionRecord]":
+        """List all sessions for a user in an app.
+
+        Args:
+            app_name: Application name.
+            user_id: User identifier.
+
+        Returns:
+            List of session records ordered by update_time DESC.
+
+        Notes:
+            Uses composite index on (app_name, user_id).
+            Returns empty list if table doesn't exist.
+        """
+        sql = f"""
+        SELECT id, app_name, user_id, state, create_time, update_time
+        FROM {self._session_table}
+        WHERE app_name = $1 AND user_id = $2
+        ORDER BY update_time DESC
+        """
+
+        try:
+            async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+                result = await conn.fetch(sql, [app_name, user_id])
+                rows: list[dict[str, Any]] = result.result() if result else []
+
+                return [
+                    SessionRecord(
+                        id=row["id"],
+                        app_name=row["app_name"],
+                        user_id=row["user_id"],
+                        state=row["state"],
+                        create_time=row["create_time"],
+                        update_time=row["update_time"],
+                    )
+                    for row in rows
+                ]
+        except psqlpy.exceptions.DatabaseError as e:
+            error_msg = str(e).lower()
+            if "does not exist" in error_msg or "relation" in error_msg:
+                return []
+            raise
+
+    async def append_event(self, event_record: EventRecord) -> None:
+        """Append an event to a session.
+
+        Args:
+            event_record: Event record to store.
+
+        Notes:
+            Uses CURRENT_TIMESTAMP for timestamp if not provided.
+            JSONB fields are passed as dicts and psqlpy converts automatically.
+            BYTEA actions field stores pre-serialized data from Google ADK.
+        """
+        content_json = event_record.get("content")
+        grounding_metadata_json = event_record.get("grounding_metadata")
+        custom_metadata_json = event_record.get("custom_metadata")
+
+        sql = f"""
+        INSERT INTO {self._events_table} (
+            id, session_id, app_name, user_id, invocation_id, author, actions,
+            long_running_tool_ids_json, branch, timestamp, content,
+            grounding_metadata, custom_metadata, partial, turn_complete,
+            interrupted, error_code, error_message
+        ) VALUES (
+            $1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18
+        )
+        """
+
+        async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+            await conn.execute(
+                sql,
+                [
+                    event_record["id"],
+                    event_record["session_id"],
+                    event_record["app_name"],
+                    event_record["user_id"],
+                    event_record.get("invocation_id"),
+                    event_record.get("author"),
+                    event_record.get("actions"),
+                    event_record.get("long_running_tool_ids_json"),
+                    event_record.get("branch"),
+                    event_record["timestamp"],
+                    content_json,
+                    grounding_metadata_json,
+                    custom_metadata_json,
+                    event_record.get("partial"),
+                    event_record.get("turn_complete"),
+                    event_record.get("interrupted"),
+                    event_record.get("error_code"),
+                    event_record.get("error_message"),
+                ],
+            )
+
+    async def get_events(
+        self, session_id: str, after_timestamp: "datetime | None" = None, limit: "int | None" = None
+    ) -> "list[EventRecord]":
+        """Get events for a session.
+
+        Args:
+            session_id: Session identifier.
+            after_timestamp: Only return events after this time.
+            limit: Maximum number of events to return.
+
+        Returns:
+            List of event records ordered by timestamp ASC.
+
+        Notes:
+            Uses index on (session_id, timestamp ASC).
+            Parses JSONB fields and converts BYTEA actions to bytes.
+            Returns empty list if table doesn't exist.
+        """
+        where_clauses = ["session_id = $1"]
+        params: list[Any] = [session_id]
+
+        if after_timestamp is not None:
+            where_clauses.append(f"timestamp > ${len(params) + 1}")
+            params.append(after_timestamp)
+
+        where_clause = " AND ".join(where_clauses)
+        limit_clause = f" LIMIT ${len(params) + 1}" if limit else ""
+        if limit:
+            params.append(limit)
+
+        sql = f"""
+        SELECT id, session_id, app_name, user_id, invocation_id, author, actions,
+               long_running_tool_ids_json, branch, timestamp, content,
+               grounding_metadata, custom_metadata, partial, turn_complete,
+               interrupted, error_code, error_message
+        FROM {self._events_table}
+        WHERE {where_clause}
+        ORDER BY timestamp ASC{limit_clause}
+        """
+
+        try:
+            async with self._config.provide_connection() as conn:  # pyright: ignore[reportAttributeAccessIssue]
+                result = await conn.fetch(sql, params)
+                rows: list[dict[str, Any]] = result.result() if result else []
+
+                return [
+                    EventRecord(
+                        id=row["id"],
+                        session_id=row["session_id"],
+                        app_name=row["app_name"],
+                        user_id=row["user_id"],
+                        invocation_id=row["invocation_id"],
+                        author=row["author"],
+                        actions=bytes(row["actions"]) if row["actions"] else b"",
+                        long_running_tool_ids_json=row["long_running_tool_ids_json"],
+                        branch=row["branch"],
+                        timestamp=row["timestamp"],
+                        content=row["content"],
+                        grounding_metadata=row["grounding_metadata"],
+                        custom_metadata=row["custom_metadata"],
+                        partial=row["partial"],
+                        turn_complete=row["turn_complete"],
+                        interrupted=row["interrupted"],
+                        error_code=row["error_code"],
+                        error_message=row["error_message"],
+                    )
+                    for row in rows
+                ]
+        except psqlpy.exceptions.DatabaseError as e:
+            error_msg = str(e).lower()
+            if "does not exist" in error_msg or "relation" in error_msg:
+                return []
+            raise

sqlspec/adapters/psqlpy/config.py

@@ -3,7 +3,7 @@
 import logging
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
-from typing import TYPE_CHECKING, Any, ClassVar, Optional, TypedDict, Union
+from typing import TYPE_CHECKING, Any, ClassVar, TypedDict
 
 from psqlpy import ConnectionPool
 from typing_extensions import NotRequired
@@ -12,6 +12,7 @@ from sqlspec.adapters.psqlpy._types import PsqlpyConnection
 from sqlspec.adapters.psqlpy.driver import PsqlpyCursor, PsqlpyDriver, psqlpy_statement_config
 from sqlspec.config import AsyncDatabaseConfig
 from sqlspec.core.statement import StatementConfig
+from sqlspec.typing import PGVECTOR_INSTALLED
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -20,7 +21,7 @@ if TYPE_CHECKING:
 logger = logging.getLogger("sqlspec.adapters.psqlpy")
 
 
-class PsqlpyConnectionParams(TypedDict, total=False):
+class PsqlpyConnectionParams(TypedDict):
     """Psqlpy connection parameters."""
 
     dsn: NotRequired[str]
@@ -62,7 +63,7 @@ class PsqlpyConnectionParams(TypedDict, total=False):
     load_balance_hosts: NotRequired[str]
 
 
-class PsqlpyPoolParams(PsqlpyConnectionParams, total=False):
+class PsqlpyPoolParams(PsqlpyConnectionParams):
     """Psqlpy pool parameters."""
 
     hosts: NotRequired[list[str]]
@@ -73,7 +74,19 @@ class PsqlpyPoolParams(PsqlpyConnectionParams, total=False):
     extra: NotRequired[dict[str, Any]]
 
 
-__all__ = ("PsqlpyConfig", "PsqlpyConnectionParams", "PsqlpyCursor", "PsqlpyPoolParams")
+class PsqlpyDriverFeatures(TypedDict):
+    """Psqlpy driver feature flags.
+
+    enable_pgvector: Enable automatic pgvector extension support for vector similarity search.
+        Requires pgvector-python package installed.
+        Defaults to True when pgvector is installed.
+        Provides automatic conversion between NumPy arrays and PostgreSQL vector types.
+    """
+
+    enable_pgvector: NotRequired[bool]
+
+
+__all__ = ("PsqlpyConfig", "PsqlpyConnectionParams", "PsqlpyCursor", "PsqlpyDriverFeatures", "PsqlpyPoolParams")
 
 
 class PsqlpyConfig(AsyncDatabaseConfig[PsqlpyConnection, ConnectionPool, PsqlpyDriver]):
@@ -81,35 +94,47 @@ class PsqlpyConfig(AsyncDatabaseConfig[PsqlpyConnection, ConnectionPool, PsqlpyD
 
     driver_type: ClassVar[type[PsqlpyDriver]] = PsqlpyDriver
     connection_type: "ClassVar[type[PsqlpyConnection]]" = PsqlpyConnection
+    supports_transactional_ddl: "ClassVar[bool]" = True
 
     def __init__(
         self,
         *,
-        pool_config: Optional[Union[PsqlpyPoolParams, dict[str, Any]]] = None,
-        pool_instance: Optional[ConnectionPool] = None,
-        migration_config: Optional[dict[str, Any]] = None,
-        statement_config: Optional[StatementConfig] = None,
-        driver_features: Optional[dict[str, Any]] = None,
+        pool_config: PsqlpyPoolParams | dict[str, Any] | None = None,
+        pool_instance: ConnectionPool | None = None,
+        migration_config: dict[str, Any] | None = None,
+        statement_config: StatementConfig | None = None,
+        driver_features: "PsqlpyDriverFeatures | dict[str, Any] | None" = None,
+        bind_key: str | None = None,
+        extension_config: "dict[str, dict[str, Any]] | None" = None,
     ) -> None:
         """Initialize Psqlpy configuration.
 
         Args:
-            pool_config: Pool configuration parameters
-            pool_instance: Existing connection pool instance to use
-            migration_config: Migration configuration
-            statement_config: SQL statement configuration
-            driver_features: Driver feature configuration
+            pool_config: Pool configuration parameters.
+            pool_instance: Existing connection pool instance to use.
+            migration_config: Migration configuration.
+            statement_config: SQL statement configuration.
+            driver_features: Driver feature configuration (TypedDict or dict).
+            bind_key: Optional unique identifier for this configuration.
+            extension_config: Extension-specific configuration (e.g., Litestar plugin settings).
         """
         processed_pool_config: dict[str, Any] = dict(pool_config) if pool_config else {}
         if "extra" in processed_pool_config:
             extras = processed_pool_config.pop("extra")
             processed_pool_config.update(extras)
+
+        processed_driver_features: dict[str, Any] = dict(driver_features) if driver_features else {}
+        if "enable_pgvector" not in processed_driver_features:
+            processed_driver_features["enable_pgvector"] = PGVECTOR_INSTALLED
+
         super().__init__(
             pool_config=processed_pool_config,
             pool_instance=pool_instance,
             migration_config=migration_config,
             statement_config=statement_config or psqlpy_statement_config,
-            driver_features=driver_features or {},
+            driver_features=processed_driver_features,
+            bind_key=bind_key,
+            extension_config=extension_config,
         )
 
     def _get_pool_config_dict(self) -> dict[str, Any]:
@@ -182,7 +207,7 @@ class PsqlpyConfig(AsyncDatabaseConfig[PsqlpyConnection, ConnectionPool, PsqlpyD
 
     @asynccontextmanager
     async def provide_session(
-        self, *args: Any, statement_config: "Optional[StatementConfig]" = None, **kwargs: Any
+        self, *args: Any, statement_config: "StatementConfig | None" = None, **kwargs: Any
     ) -> AsyncGenerator[PsqlpyDriver, None]:
         """Provide an async driver session context manager.
 
@@ -195,7 +220,11 @@ class PsqlpyConfig(AsyncDatabaseConfig[PsqlpyConnection, ConnectionPool, PsqlpyD
             A PsqlpyDriver instance.
         """
         async with self.provide_connection(*args, **kwargs) as conn:
-            yield self.driver_type(connection=conn, statement_config=statement_config or self.statement_config)
+            yield self.driver_type(
+                connection=conn,
+                statement_config=statement_config or self.statement_config,
+                driver_features=self.driver_features,
+            )
 
     async def provide_pool(self, *args: Any, **kwargs: Any) -> ConnectionPool:
         """Provide async pool instance.