sqlspec 0.16.1__cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

sqlspec/adapters/oracledb/config.py

@@ -0,0 +1,317 @@
+"""OracleDB database configuration with direct field-based configuration."""
+
+import contextlib
+import logging
+from contextlib import asynccontextmanager
+from typing import TYPE_CHECKING, Any, ClassVar, Optional, TypedDict, Union, cast
+
+import oracledb
+from typing_extensions import NotRequired
+
+from sqlspec.adapters.oracledb._types import OracleAsyncConnection, OracleSyncConnection
+from sqlspec.adapters.oracledb.driver import (
+    OracleAsyncCursor,
+    OracleAsyncDriver,
+    OracleSyncCursor,
+    OracleSyncDriver,
+    oracledb_statement_config,
+)
+from sqlspec.config import AsyncDatabaseConfig, SyncDatabaseConfig
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncGenerator, Callable, Generator
+
+    from oracledb import AuthMode
+    from oracledb.pool import AsyncConnectionPool, ConnectionPool
+
+    from sqlspec.core.statement import StatementConfig
+
+
+__all__ = ("OracleAsyncConfig", "OracleConnectionParams", "OraclePoolParams", "OracleSyncConfig")
+
+logger = logging.getLogger(__name__)
+
+
+class OracleConnectionParams(TypedDict, total=False):
+    """OracleDB connection parameters."""
+
+    dsn: NotRequired[str]
+    user: NotRequired[str]
+    password: NotRequired[str]
+    host: NotRequired[str]
+    port: NotRequired[int]
+    service_name: NotRequired[str]
+    sid: NotRequired[str]
+    wallet_location: NotRequired[str]
+    wallet_password: NotRequired[str]
+    config_dir: NotRequired[str]
+    tcp_connect_timeout: NotRequired[float]
+    retry_count: NotRequired[int]
+    retry_delay: NotRequired[int]
+    mode: NotRequired["AuthMode"]
+    events: NotRequired[bool]
+    edition: NotRequired[str]
+
+
+class OraclePoolParams(OracleConnectionParams, total=False):
+    """OracleDB pool parameters."""
+
+    min: NotRequired[int]
+    max: NotRequired[int]
+    increment: NotRequired[int]
+    threaded: NotRequired[bool]
+    getmode: NotRequired[Any]
+    homogeneous: NotRequired[bool]
+    timeout: NotRequired[int]
+    wait_timeout: NotRequired[int]
+    max_lifetime_session: NotRequired[int]
+    session_callback: NotRequired["Callable[..., Any]"]
+    max_sessions_per_shard: NotRequired[int]
+    soda_metadata_cache: NotRequired[bool]
+    ping_interval: NotRequired[int]
+    extra: NotRequired[dict[str, Any]]
+
+
+class OracleSyncConfig(SyncDatabaseConfig[OracleSyncConnection, "ConnectionPool", OracleSyncDriver]):
+    """Configuration for Oracle synchronous database connections with direct field-based configuration."""
+
+    driver_type: ClassVar[type[OracleSyncDriver]] = OracleSyncDriver
+    connection_type: "ClassVar[type[OracleSyncConnection]]" = OracleSyncConnection
+
+    def __init__(
+        self,
+        *,
+        pool_instance: "Optional[ConnectionPool]" = None,
+        pool_config: "Optional[Union[OraclePoolParams, dict[str, Any]]]" = None,
+        statement_config: "Optional[StatementConfig]" = None,
+        migration_config: Optional[dict[str, Any]] = None,
+    ) -> None:
+        """Initialize Oracle synchronous configuration.
+
+        Args:
+            pool_config: Pool configuration parameters
+            pool_instance: Existing pool instance to use
+            statement_config: Default SQL statement configuration
+            migration_config: Migration configuration
+        """
+        # Store the pool config as a dict and extract/merge extras
+        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)
+        statement_config = statement_config or oracledb_statement_config
+        super().__init__(
+            pool_config=processed_pool_config,
+            pool_instance=pool_instance,
+            migration_config=migration_config,
+            statement_config=statement_config,
+        )
+
+    def _create_pool(self) -> "ConnectionPool":
+        """Create the actual connection pool."""
+
+        return oracledb.create_pool(**dict(self.pool_config))
+
+    def _close_pool(self) -> None:
+        """Close the actual connection pool."""
+        if self.pool_instance:
+            self.pool_instance.close()
+
+    def create_connection(self) -> "OracleSyncConnection":
+        """Create a single connection (not from pool).
+
+        Returns:
+            An Oracle Connection instance.
+        """
+        if self.pool_instance is None:
+            self.pool_instance = self.create_pool()
+        return self.pool_instance.acquire()
+
+    @contextlib.contextmanager
+    def provide_connection(self, *args: Any, **kwargs: Any) -> "Generator[OracleSyncConnection, None, None]":
+        """Provide a connection context manager.
+
+        Args:
+            *args: Additional arguments.
+            **kwargs: Additional keyword arguments.
+
+        Yields:
+            An Oracle Connection instance.
+        """
+        if self.pool_instance is None:
+            self.pool_instance = self.create_pool()
+        conn = self.pool_instance.acquire()
+        try:
+            yield conn
+        finally:
+            self.pool_instance.release(conn)
+
+    @contextlib.contextmanager
+    def provide_session(
+        self, *args: Any, statement_config: "Optional[StatementConfig]" = None, **kwargs: Any
+    ) -> "Generator[OracleSyncDriver, None, None]":
+        """Provide a driver session context manager.
+
+        Args:
+            *args: Additional arguments.
+            statement_config: Optional statement configuration override.
+            **kwargs: Additional keyword arguments.
+
+        Yields:
+            An OracleSyncDriver instance.
+        """
+        with self.provide_connection(*args, **kwargs) as conn:
+            yield self.driver_type(connection=conn, statement_config=statement_config or self.statement_config)
+
+    def provide_pool(self, *args: Any, **kwargs: Any) -> "ConnectionPool":
+        """Provide pool instance.
+
+        Returns:
+            The connection pool.
+        """
+        if not self.pool_instance:
+            self.pool_instance = self.create_pool()
+        return self.pool_instance
+
+    def get_signature_namespace(self) -> "dict[str, type[Any]]":
+        """Get the signature namespace for OracleDB types.
+
+        This provides all OracleDB-specific types that Litestar needs to recognize
+        to avoid serialization attempts.
+
+        Returns:
+            Dictionary mapping type names to types.
+        """
+
+        namespace = super().get_signature_namespace()
+        namespace.update(
+            {
+                "OracleSyncConnection": OracleSyncConnection,
+                "OracleAsyncConnection": OracleAsyncConnection,
+                "OracleSyncCursor": OracleSyncCursor,
+            }
+        )
+        return namespace
+
+
+class OracleAsyncConfig(AsyncDatabaseConfig[OracleAsyncConnection, "AsyncConnectionPool", OracleAsyncDriver]):
+    """Configuration for Oracle asynchronous database connections with direct field-based configuration."""
+
+    connection_type: "ClassVar[type[OracleAsyncConnection]]" = OracleAsyncConnection
+    driver_type: ClassVar[type[OracleAsyncDriver]] = OracleAsyncDriver
+
+    def __init__(
+        self,
+        *,
+        pool_config: "Optional[Union[OraclePoolParams, dict[str, Any]]]" = None,
+        pool_instance: "Optional[AsyncConnectionPool]" = None,
+        statement_config: "Optional[StatementConfig]" = None,
+        migration_config: Optional[dict[str, Any]] = None,
+    ) -> None:
+        """Initialize Oracle asynchronous configuration.
+
+        Args:
+            pool_config: Pool configuration parameters
+            pool_instance: Existing pool instance to use
+            statement_config: Default SQL statement configuration
+            migration_config: Migration configuration
+        """
+        # Store the pool config as a dict and extract/merge extras
+        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)
+
+        super().__init__(
+            pool_config=processed_pool_config,
+            pool_instance=pool_instance,
+            migration_config=migration_config,
+            statement_config=statement_config or oracledb_statement_config,
+        )
+
+    async def _create_pool(self) -> "AsyncConnectionPool":
+        """Create the actual async connection pool."""
+
+        return oracledb.create_pool_async(**dict(self.pool_config))
+
+    async def _close_pool(self) -> None:
+        """Close the actual async connection pool."""
+        if self.pool_instance:
+            await self.pool_instance.close()
+
+    async def create_connection(self) -> OracleAsyncConnection:
+        """Create a single async connection (not from pool).
+
+        Returns:
+            An Oracle AsyncConnection instance.
+        """
+        if self.pool_instance is None:
+            self.pool_instance = await self.create_pool()
+        return cast("OracleAsyncConnection", await self.pool_instance.acquire())
+
+    @asynccontextmanager
+    async def provide_connection(self, *args: Any, **kwargs: Any) -> "AsyncGenerator[OracleAsyncConnection, None]":
+        """Provide an async connection context manager.
+
+        Args:
+            *args: Additional arguments.
+            **kwargs: Additional keyword arguments.
+
+        Yields:
+            An Oracle AsyncConnection instance.
+        """
+        if self.pool_instance is None:
+            self.pool_instance = await self.create_pool()
+        conn = await self.pool_instance.acquire()
+        try:
+            yield conn
+        finally:
+            await self.pool_instance.release(conn)
+
+    @asynccontextmanager
+    async def provide_session(
+        self, *args: Any, statement_config: "Optional[StatementConfig]" = None, **kwargs: Any
+    ) -> "AsyncGenerator[OracleAsyncDriver, None]":
+        """Provide an async driver session context manager.
+
+        Args:
+            *args: Additional arguments.
+            statement_config: Optional statement configuration override.
+            **kwargs: Additional keyword arguments.
+
+        Yields:
+            An OracleAsyncDriver instance.
+        """
+        async with self.provide_connection(*args, **kwargs) as conn:
+            yield self.driver_type(connection=conn, statement_config=statement_config or self.statement_config)
+
+    async def provide_pool(self, *args: Any, **kwargs: Any) -> "AsyncConnectionPool":
+        """Provide async pool instance.
+
+        Returns:
+            The async connection pool.
+        """
+        if not self.pool_instance:
+            self.pool_instance = await self.create_pool()
+        return self.pool_instance
+
+    def get_signature_namespace(self) -> "dict[str, type[Any]]":
+        """Get the signature namespace for OracleDB async types.
+
+        This provides all OracleDB async-specific types that Litestar needs to recognize
+        to avoid serialization attempts.
+
+        Returns:
+            Dictionary mapping type names to types.
+        """
+
+        namespace = super().get_signature_namespace()
+        namespace.update(
+            {
+                "OracleSyncConnection": OracleSyncConnection,
+                "OracleAsyncConnection": OracleAsyncConnection,
+                "OracleSyncCursor": OracleSyncCursor,
+                "OracleAsyncCursor": OracleAsyncCursor,
+            }
+        )
+        return namespace