sqlspec 0.7.1__py3-none-any.whl → 0.9.0__py3-none-any.whl

sqlspec/adapters/oracledb/config/_asyncio.py

@@ -1,14 +1,12 @@
 from contextlib import asynccontextmanager
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Optional
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, Any, Optional, cast
 
 from oracledb import create_pool_async as oracledb_create_pool  # pyright: ignore[reportUnknownVariableType]
 from oracledb.connection import AsyncConnection
-from oracledb.pool import AsyncConnectionPool
 
-from sqlspec.adapters.oracledb.config._common import (
-    OracleGenericPoolConfig,
-)
+from sqlspec.adapters.oracledb.config._common import OracleGenericPoolConfig
+from sqlspec.adapters.oracledb.driver import OracleAsyncDriver
 from sqlspec.base import AsyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
@@ -16,20 +14,22 @@ from sqlspec.typing import dataclass_to_dict
 if TYPE_CHECKING:
     from collections.abc import AsyncGenerator, Awaitable
 
+    from oracledb.pool import AsyncConnectionPool
+
 
 __all__ = (
-    "OracleAsyncDatabaseConfig",
+    "OracleAsyncConfig",
     "OracleAsyncPoolConfig",
 )
 
 
 @dataclass
-class OracleAsyncPoolConfig(OracleGenericPoolConfig[AsyncConnection, AsyncConnectionPool]):
+class OracleAsyncPoolConfig(OracleGenericPoolConfig["AsyncConnection", "AsyncConnectionPool"]):
     """Async Oracle Pool Config"""
 
 
 @dataclass
-class OracleAsyncDatabaseConfig(AsyncDatabaseConfig[AsyncConnection, AsyncConnectionPool]):
+class OracleAsyncConfig(AsyncDatabaseConfig["AsyncConnection", "AsyncConnectionPool", "OracleAsyncDriver"]):
     """Oracle Async database Configuration.
 
     This class provides the base configuration for Oracle database connections, extending
@@ -49,23 +49,91 @@ class OracleAsyncDatabaseConfig(AsyncDatabaseConfig[AsyncConnection, AsyncConnec
 
     If set, the plugin will use the provided pool rather than instantiate one.
     """
+    connection_type: "type[AsyncConnection]" = field(init=False, default_factory=lambda: AsyncConnection)
+    """Connection class to use.
+
+    Defaults to :class:`AsyncConnection`.
+    """
+    driver_type: "type[OracleAsyncDriver]" = field(init=False, default_factory=lambda: OracleAsyncDriver)  # type: ignore[type-abstract,unused-ignore]
+    """Driver class to use.
+
+    Defaults to :class:`OracleAsyncDriver`.
+    """
+
+    @property
+    def connection_config_dict(self) -> "dict[str, Any]":
+        """Return the connection configuration as a dict.
+
+        Returns:
+            A string keyed dict of config kwargs for the oracledb.connect function.
+
+        Raises:
+            ImproperConfigurationError: If the connection configuration is not provided.
+        """
+        if self.pool_config:
+            # Filter out pool-specific parameters
+            pool_only_params = {
+                "min",
+                "max",
+                "increment",
+                "timeout",
+                "wait_timeout",
+                "max_lifetime_session",
+                "session_callback",
+            }
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude=pool_only_params.union({"pool_instance", "connection_type", "driver_type"}),
+            )
+        msg = "You must provide a 'pool_config' for this adapter."
+        raise ImproperConfigurationError(msg)
 
     @property
     def pool_config_dict(self) -> "dict[str, Any]":
         """Return the pool configuration as a dict.
 
+        Raises:
+            ImproperConfigurationError: If no pool_config is provided but a pool_instance
+
         Returns:
             A string keyed dict of config kwargs for the Asyncpg :func:`create_pool <oracledb.pool.create_pool>`
             function.
         """
         if self.pool_config is not None:
-            return dataclass_to_dict(self.pool_config, exclude_empty=True, convert_nested=False)
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude={"pool_instance", "connection_type", "driver_type"},
+            )
         msg = "'pool_config' methods can not be used when a 'pool_instance' is provided."
         raise ImproperConfigurationError(msg)
 
+    async def create_connection(self) -> "AsyncConnection":
+        """Create and return a new oracledb async connection from the pool.
+
+        Returns:
+            An AsyncConnection instance.
+
+        Raises:
+            ImproperConfigurationError: If the connection could not be created.
+        """
+        try:
+            pool = await self.provide_pool()
+            return cast("AsyncConnection", await pool.acquire())  # type: ignore[no-any-return,unused-ignore]
+        except Exception as e:
+            msg = f"Could not configure the Oracle async connection. Error: {e!s}"
+            raise ImproperConfigurationError(msg) from e
+
     async def create_pool(self) -> "AsyncConnectionPool":
         """Return a pool. If none exists yet, create one.
 
+        Raises:
+            ImproperConfigurationError: If neither pool_config nor pool_instance are provided,
+                or if the pool could not be configured.
+
         Returns:
             Getter that returns the pool instance used by the plugin.
         """
@@ -95,9 +163,25 @@ class OracleAsyncDatabaseConfig(AsyncDatabaseConfig[AsyncConnection, AsyncConnec
     async def provide_connection(self, *args: "Any", **kwargs: "Any") -> "AsyncGenerator[AsyncConnection, None]":
         """Create a connection instance.
 
-        Returns:
-            A connection instance.
+        Yields:
+            AsyncConnection: A connection instance.
         """
         db_pool = await self.provide_pool(*args, **kwargs)
         async with db_pool.acquire() as connection:  # pyright: ignore[reportUnknownMemberType]
             yield connection
+
+    @asynccontextmanager
+    async def provide_session(self, *args: "Any", **kwargs: "Any") -> "AsyncGenerator[OracleAsyncDriver, None]":
+        """Create and provide a database session.
+
+        Yields:
+            OracleAsyncDriver: A driver instance with an active connection.
+        """
+        async with self.provide_connection(*args, **kwargs) as connection:
+            yield self.driver_type(connection)
+
+    async def close_pool(self) -> None:
+        """Close the connection pool."""
+        if self.pool_instance is not None:
+            await self.pool_instance.close()
+            self.pool_instance = None

sqlspec/adapters/oracledb/config/_common.py

@@ -27,7 +27,7 @@ PoolT = TypeVar("PoolT", bound="Union[ConnectionPool, AsyncConnectionPool]")
 
 
 @dataclass
-class OracleGenericPoolConfig(Generic[ConnectionT, PoolT], GenericPoolConfig):
+class OracleGenericPoolConfig(GenericPoolConfig, Generic[ConnectionT, PoolT]):
     """Configuration for Oracle database connection pools.
 
     This class provides configuration options for both synchronous and asynchronous Oracle

sqlspec/adapters/oracledb/config/_sync.py

@@ -1,35 +1,35 @@
 from contextlib import contextmanager
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Any, Optional
 
 from oracledb import create_pool as oracledb_create_pool  # pyright: ignore[reportUnknownVariableType]
 from oracledb.connection import Connection
-from oracledb.pool import ConnectionPool
 
-from sqlspec.adapters.oracledb.config._common import (
-    OracleGenericPoolConfig,
-)
+from sqlspec.adapters.oracledb.config._common import OracleGenericPoolConfig
+from sqlspec.adapters.oracledb.driver import OracleSyncDriver
 from sqlspec.base import SyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
 
 if TYPE_CHECKING:
     from collections.abc import Generator
-    from typing import Any
+
+    from oracledb.pool import ConnectionPool
+
 
 __all__ = (
-    "OracleSyncDatabaseConfig",
+    "OracleSyncConfig",
     "OracleSyncPoolConfig",
 )
 
 
 @dataclass
-class OracleSyncPoolConfig(OracleGenericPoolConfig[Connection, ConnectionPool]):
+class OracleSyncPoolConfig(OracleGenericPoolConfig["Connection", "ConnectionPool"]):
     """Sync Oracle Pool Config"""
 
 
 @dataclass
-class OracleSyncDatabaseConfig(SyncDatabaseConfig[Connection, ConnectionPool]):
+class OracleSyncConfig(SyncDatabaseConfig["Connection", "ConnectionPool", "OracleSyncDriver"]):
     """Oracle Sync database Configuration.
 
     This class provides the base configuration for Oracle database connections, extending
@@ -49,23 +49,91 @@ class OracleSyncDatabaseConfig(SyncDatabaseConfig[Connection, ConnectionPool]):
 
     If set, the plugin will use the provided pool rather than instantiate one.
     """
+    connection_type: "type[Connection]" = field(init=False, default_factory=lambda: Connection)  # pyright: ignore
+    """Connection class to use.
+
+    Defaults to :class:`Connection`.
+    """
+    driver_type: "type[OracleSyncDriver]" = field(init=False, default_factory=lambda: OracleSyncDriver)  # type: ignore[type-abstract,unused-ignore]
+    """Driver class to use.
+
+    Defaults to :class:`OracleSyncDriver`.
+    """
+
+    @property
+    def connection_config_dict(self) -> "dict[str, Any]":
+        """Return the connection configuration as a dict.
+
+        Returns:
+            A string keyed dict of config kwargs for the oracledb.connect function.
+
+        Raises:
+            ImproperConfigurationError: If the connection configuration is not provided.
+        """
+        if self.pool_config:
+            # Filter out pool-specific parameters
+            pool_only_params = {
+                "min",
+                "max",
+                "increment",
+                "timeout",
+                "wait_timeout",
+                "max_lifetime_session",
+                "session_callback",
+            }
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude=pool_only_params.union({"pool_instance", "connection_type", "driver_type"}),
+            )
+        msg = "You must provide a 'pool_config' for this adapter."
+        raise ImproperConfigurationError(msg)
 
     @property
     def pool_config_dict(self) -> "dict[str, Any]":
         """Return the pool configuration as a dict.
 
+        Raises:
+            ImproperConfigurationError: If no pool_config is provided but a pool_instance
+
         Returns:
             A string keyed dict of config kwargs for the Asyncpg :func:`create_pool <oracledb.pool.create_pool>`
             function.
         """
         if self.pool_config:
-            return dataclass_to_dict(self.pool_config, exclude_empty=True, convert_nested=False)
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude={"pool_instance", "connection_type", "driver_type"},
+            )
         msg = "'pool_config' methods can not be used when a 'pool_instance' is provided."
         raise ImproperConfigurationError(msg)
 
+    def create_connection(self) -> "Connection":
+        """Create and return a new oracledb connection from the pool.
+
+        Returns:
+            A Connection instance.
+
+        Raises:
+            ImproperConfigurationError: If the connection could not be created.
+        """
+        try:
+            pool = self.provide_pool()
+            return pool.acquire()
+        except Exception as e:
+            msg = f"Could not configure the Oracle connection. Error: {e!s}"
+            raise ImproperConfigurationError(msg) from e
+
     def create_pool(self) -> "ConnectionPool":
         """Return a pool. If none exists yet, create one.
 
+        Raises:
+            ImproperConfigurationError: If neither pool_config nor pool_instance is provided,
+                or if the pool could not be configured.
+
         Returns:
             Getter that returns the pool instance used by the plugin.
         """
@@ -95,9 +163,25 @@ class OracleSyncDatabaseConfig(SyncDatabaseConfig[Connection, ConnectionPool]):
     def provide_connection(self, *args: "Any", **kwargs: "Any") -> "Generator[Connection, None, None]":
         """Create a connection instance.
 
-        Returns:
-            A connection instance.
+        Yields:
+            Connection: A connection instance from the pool.
         """
         db_pool = self.provide_pool(*args, **kwargs)
         with db_pool.acquire() as connection:  # pyright: ignore[reportUnknownMemberType]
             yield connection
+
+    @contextmanager
+    def provide_session(self, *args: "Any", **kwargs: "Any") -> "Generator[OracleSyncDriver, None, None]":
+        """Create and provide a database session.
+
+        Yields:
+            OracleSyncDriver: A driver instance with an active connection.
+        """
+        with self.provide_connection(*args, **kwargs) as connection:
+            yield self.driver_type(connection)
+
+    def close_pool(self) -> None:
+        """Close the connection pool."""
+        if self.pool_instance is not None:
+            self.pool_instance.close()
+            self.pool_instance = None