sqlspec 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

sqlspec/__metadata__.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from importlib.metadata import PackageNotFoundError, metadata, version
 
-__all__ = ["__project__", "__version__"]
+__all__ = ("__project__", "__version__")
 
 try:
     __version__ = version("sqlspec")

sqlspec/adapters/adbc/config.py

@@ -4,7 +4,7 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from sqlspec.base import GenericDatabaseConfig, NoPoolConfig
+from sqlspec.base import NoPoolSyncConfig
 from sqlspec.typing import Empty, EmptyType
 
 if TYPE_CHECKING:
@@ -17,7 +17,7 @@ __all__ = ("AdbcDatabaseConfig",)
 
 
 @dataclass
-class AdbcDatabaseConfig(NoPoolConfig["Connection"], GenericDatabaseConfig):
+class AdbcDatabaseConfig(NoPoolSyncConfig["Connection"]):
     """Configuration for ADBC connections.
 
     This class provides configuration options for ADBC database connections using the

sqlspec/adapters/aiosqlite/config.py

@@ -1,10 +1,10 @@
 from __future__ import annotations
 
 from contextlib import asynccontextmanager
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import TYPE_CHECKING, Any
 
-from sqlspec.base import GenericDatabaseConfig, NoPoolConfig
+from sqlspec.base import NoPoolSyncConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
 
@@ -19,7 +19,7 @@ __all__ = ("AiosqliteConfig",)
 
 
 @dataclass
-class AiosqliteConfig(NoPoolConfig["Connection"], GenericDatabaseConfig):
+class AiosqliteConfig(NoPoolSyncConfig["Connection"]):
     """Configuration for Aiosqlite database connections.
 
     This class provides configuration options for Aiosqlite database connections, wrapping all parameters
@@ -28,28 +28,21 @@ class AiosqliteConfig(NoPoolConfig["Connection"], GenericDatabaseConfig):
     For details see: https://github.com/omnilib/aiosqlite/blob/main/aiosqlite/__init__.pyi
     """
 
-    database: str
+    database: str = field(default=":memory:")
     """The path to the database file to be opened. Pass ":memory:" to open a connection to a database that resides in RAM instead of on disk."""
-
-    timeout: float | EmptyType = Empty
+    timeout: float | EmptyType = field(default=Empty)
     """How many seconds the connection should wait before raising an OperationalError when a table is locked. If another thread or process has acquired a shared lock, a wait for the specified timeout occurs."""
-
-    detect_types: int | EmptyType = Empty
+    detect_types: int | EmptyType = field(default=Empty)
     """Control whether and how data types are detected. It can be 0 (default) or a combination of PARSE_DECLTYPES and PARSE_COLNAMES."""
-
-    isolation_level: Literal["DEFERRED", "IMMEDIATE", "EXCLUSIVE"] | None | EmptyType = Empty
+    isolation_level: Literal["DEFERRED", "IMMEDIATE", "EXCLUSIVE"] | None | EmptyType = field(default=Empty)
     """The isolation_level of the connection. This can be None for autocommit mode or one of "DEFERRED", "IMMEDIATE" or "EXCLUSIVE"."""
-
-    check_same_thread: bool | EmptyType = Empty
+    check_same_thread: bool | EmptyType = field(default=Empty)
     """If True (default), ProgrammingError is raised if the database connection is used by a thread other than the one that created it. If False, the connection may be shared across multiple threads."""
-
-    factory: type[SQLite3Connection] | EmptyType = Empty
+    factory: type[SQLite3Connection] | EmptyType = field(default=Empty)
     """A custom Connection class factory. If given, must be a callable that returns a Connection instance."""
-
-    cached_statements: int | EmptyType = Empty
+    cached_statements: int | EmptyType = field(default=Empty)
     """The number of statements that SQLite will cache for this connection. The default is 128."""
-
-    uri: bool | EmptyType = Empty
+    uri: bool | EmptyType = field(default=Empty)
     """If set to True, database is interpreted as a URI with supported options."""
 
     @property

sqlspec/adapters/asyncmy/config.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, TypeVar
 from asyncmy.connection import Connection
 from asyncmy.pool import Pool
 
-from sqlspec.base import DatabaseConfigProtocol, GenericDatabaseConfig, GenericPoolConfig
+from sqlspec.base import AsyncDatabaseConfig, GenericPoolConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
 
@@ -106,7 +106,7 @@ class AsyncmyPoolConfig(GenericPoolConfig):
 
 
 @dataclass
-class AsyncMyConfig(DatabaseConfigProtocol[Connection, Pool], GenericDatabaseConfig):
+class AsyncMyConfig(AsyncDatabaseConfig[Connection, Pool]):
     """Asyncmy Configuration."""
 
     __is_async__ = True

sqlspec/adapters/asyncpg/config.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from contextlib import asynccontextmanager
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, TypeVar, Union
+from typing import TYPE_CHECKING, Any, TypeVar, Union
 
 from asyncpg import Record
 from asyncpg import create_pool as asyncpg_create_pool
@@ -11,14 +11,13 @@ from asyncpg.pool import Pool, PoolConnectionProxy
 from typing_extensions import TypeAlias
 
 from sqlspec._serialization import decode_json, encode_json
-from sqlspec.base import DatabaseConfigProtocol, GenericDatabaseConfig, GenericPoolConfig
+from sqlspec.base import AsyncDatabaseConfig, GenericPoolConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
 
 if TYPE_CHECKING:
-    from asyncio import AbstractEventLoop
+    from asyncio import AbstractEventLoop  # pyright: ignore[reportAttributeAccessIssue]
     from collections.abc import AsyncGenerator, Awaitable, Callable, Coroutine
-    from typing import Any
 
 
 __all__ = (
@@ -73,12 +72,9 @@ class AsyncPgPoolConfig(GenericPoolConfig):
 
 
 @dataclass
-class AsyncPgConfig(DatabaseConfigProtocol[PgConnection, Pool], GenericDatabaseConfig):
+class AsyncPgConfig(AsyncDatabaseConfig[PgConnection, Pool]):
     """Asyncpg Configuration."""
 
-    __is_async__ = True
-    __supports_connection_pooling__ = True
-
     pool_config: AsyncPgPoolConfig | None = None
     """Asyncpg Pool configuration"""
     json_deserializer: Callable[[str], Any] = decode_json

sqlspec/adapters/duckdb/config.py

@@ -6,7 +6,7 @@ from typing import TYPE_CHECKING, Any, cast
 
 from duckdb import DuckDBPyConnection
 
-from sqlspec.base import GenericDatabaseConfig, NoPoolConfig
+from sqlspec.base import NoPoolSyncConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
 
@@ -66,7 +66,7 @@ class ExtensionConfig:
 
 
 @dataclass
-class DuckDBConfig(NoPoolConfig[DuckDBPyConnection], GenericDatabaseConfig):
+class DuckDBConfig(NoPoolSyncConfig[DuckDBPyConnection]):
     """Configuration for DuckDB database connections.
 
     This class provides configuration options for DuckDB database connections, wrapping all parameters

sqlspec/adapters/oracledb/config/_asyncio.py

@@ -4,14 +4,14 @@ from contextlib import asynccontextmanager
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from oracledb import create_pool_async as oracledb_create_pool
+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 (
-    OracleGenericDatabaseConfig,
     OracleGenericPoolConfig,
 )
+from sqlspec.base import AsyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
 
@@ -31,11 +31,18 @@ class OracleAsyncPoolConfig(OracleGenericPoolConfig[AsyncConnection, AsyncConnec
 
 
 @dataclass
-class OracleAsyncDatabaseConfig(OracleGenericDatabaseConfig[AsyncConnection, AsyncConnectionPool]):
-    """Async Oracle database Configuration."""
+class OracleAsyncDatabaseConfig(AsyncDatabaseConfig[AsyncConnection, AsyncConnectionPool]):
+    """Oracle Async database Configuration.
 
-    __is_async__ = True
-    __supports_connection_pooling__ = True
+    This class provides the base configuration for Oracle database connections, extending
+    the generic database configuration with Oracle-specific settings. It supports both
+    thin and thick modes of the python-oracledb driver.([1](https://python-oracledb.readthedocs.io/en/latest/index.html))
+
+    The configuration supports all standard Oracle connection parameters and can be used
+    with both synchronous and asynchronous connections. It includes support for features
+    like Oracle Wallet, external authentication, connection pooling, and advanced security
+    options.([2](https://python-oracledb.readthedocs.io/en/latest/user_guide/tuning.html))
+    """
 
     pool_config: OracleAsyncPoolConfig | None = None
     """Oracle Pool configuration"""
@@ -94,5 +101,5 @@ class OracleAsyncDatabaseConfig(OracleGenericDatabaseConfig[AsyncConnection, Asy
             A connection instance.
         """
         db_pool = await self.provide_pool(*args, **kwargs)
-        async with db_pool.acquire() as connection:
+        async with db_pool.acquire() as connection:  # pyright: ignore[reportUnknownMemberType]
             yield connection

sqlspec/adapters/oracledb/config/_common.py

@@ -5,7 +5,7 @@ from typing import TYPE_CHECKING, Generic, TypeVar
 
 from oracledb import ConnectionPool
 
-from sqlspec.base import DatabaseConfigProtocol, GenericDatabaseConfig, GenericPoolConfig
+from sqlspec.base import GenericPoolConfig
 from sqlspec.typing import Empty
 
 if TYPE_CHECKING:
@@ -19,10 +19,7 @@ if TYPE_CHECKING:
 
     from sqlspec.typing import EmptyType
 
-__all__ = (
-    "OracleGenericDatabaseConfig",
-    "OracleGenericPoolConfig",
-)
+__all__ = ("OracleGenericPoolConfig",)
 
 
 T = TypeVar("T")
@@ -134,18 +131,3 @@ class OracleGenericPoolConfig(Generic[ConnectionT, PoolT], GenericPoolConfig):
     """SSL/TLS protocol version"""
     handle: int | EmptyType = Empty
     """Oracle service context handle"""
-
-
-@dataclass
-class OracleGenericDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT], GenericDatabaseConfig):
-    """Oracle database Configuration.
-
-    This class provides the base configuration for Oracle database connections, extending
-    the generic database configuration with Oracle-specific settings. It supports both
-    thin and thick modes of the python-oracledb driver.([1](https://python-oracledb.readthedocs.io/en/latest/index.html))
-
-    The configuration supports all standard Oracle connection parameters and can be used
-    with both synchronous and asynchronous connections. It includes support for features
-    like Oracle Wallet, external authentication, connection pooling, and advanced security
-    options.([2](https://python-oracledb.readthedocs.io/en/latest/user_guide/tuning.html))
-    """

sqlspec/adapters/oracledb/config/_sync.py

@@ -4,14 +4,14 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from oracledb import create_pool as oracledb_create_pool
+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 (
-    OracleGenericDatabaseConfig,
     OracleGenericPoolConfig,
 )
+from sqlspec.base import SyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
 
@@ -31,11 +31,18 @@ class OracleSyncPoolConfig(OracleGenericPoolConfig[Connection, ConnectionPool]):
 
 
 @dataclass
-class OracleSyncDatabaseConfig(OracleGenericDatabaseConfig[Connection, ConnectionPool]):
-    """Oracle database Configuration."""
+class OracleSyncDatabaseConfig(SyncDatabaseConfig[Connection, ConnectionPool]):
+    """Oracle Sync database Configuration.
 
-    __is_async__ = False
-    __supports_connection_pooling__ = True
+    This class provides the base configuration for Oracle database connections, extending
+    the generic database configuration with Oracle-specific settings. It supports both
+    thin and thick modes of the python-oracledb driver.([1](https://python-oracledb.readthedocs.io/en/latest/index.html))
+
+    The configuration supports all standard Oracle connection parameters and can be used
+    with both synchronous and asynchronous connections. It includes support for features
+    like Oracle Wallet, external authentication, connection pooling, and advanced security
+    options.([2](https://python-oracledb.readthedocs.io/en/latest/user_guide/tuning.html))
+    """
 
     pool_config: OracleSyncPoolConfig | None = None
     """Oracle Pool configuration"""

sqlspec/adapters/psycopg/config/_async.py

@@ -7,10 +7,8 @@ from typing import TYPE_CHECKING
 from psycopg import AsyncConnection
 from psycopg_pool import AsyncConnectionPool
 
-from sqlspec.adapters.psycopg.config._common import (
-    PsycoPgGenericDatabaseConfig,
-    PsycoPgGenericPoolConfig,
-)
+from sqlspec.adapters.psycopg.config._common import PsycoPgGenericPoolConfig
+from sqlspec.base import AsyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
 
@@ -31,11 +29,15 @@ class PsycoPgAsyncPoolConfig(PsycoPgGenericPoolConfig[AsyncConnection, AsyncConn
 
 
 @dataclass
-class PsycoPgAsyncDatabaseConfig(PsycoPgGenericDatabaseConfig[AsyncConnection, AsyncConnectionPool]):
-    """Async Psycopg database Configuration."""
+class PsycoPgAsyncDatabaseConfig(AsyncDatabaseConfig[AsyncConnection, AsyncConnectionPool]):
+    """Async Psycopg database Configuration.
+
+    This class provides the base configuration for Psycopg database connections, extending
+    the generic database configuration with Psycopg-specific settings.([1](https://www.psycopg.org/psycopg3/docs/api/connections.html))
 
-    __is_async__ = True
-    __supports_connection_pooling__ = True
+    The configuration supports all standard Psycopg connection parameters and can be used
+    with both synchronous and asynchronous connections.([2](https://www.psycopg.org/psycopg3/docs/api/connections.html))
+    """
 
     pool_config: PsycoPgAsyncPoolConfig | None = None
     """Psycopg Pool configuration"""

sqlspec/adapters/psycopg/config/_common.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Generic, TypeVar
 
-from sqlspec.base import DatabaseConfigProtocol, GenericDatabaseConfig, GenericPoolConfig
+from sqlspec.base import GenericPoolConfig
 from sqlspec.typing import Empty
 
 if TYPE_CHECKING:
@@ -16,10 +16,7 @@ if TYPE_CHECKING:
     from sqlspec.typing import EmptyType
 
 
-__all__ = (
-    "PsycoPgGenericDatabaseConfig",
-    "PsycoPgGenericPoolConfig",
-)
+__all__ = ("PsycoPgGenericPoolConfig",)
 
 
 ConnectionT = TypeVar("ConnectionT", bound="Connection | AsyncConnection")
@@ -59,15 +56,3 @@ class PsycoPgGenericPoolConfig(Generic[ConnectionT, PoolT], GenericPoolConfig):
     """Number of background workers"""
     configure: Callable[[ConnectionT], None] | EmptyType = Empty
     """Callback to configure new connections"""
-
-
-@dataclass
-class PsycoPgGenericDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT], GenericDatabaseConfig):
-    """Psycopg database Configuration.
-
-    This class provides the base configuration for Psycopg database connections, extending
-    the generic database configuration with Psycopg-specific settings.([1](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-
-    The configuration supports all standard Psycopg connection parameters and can be used
-    with both synchronous and asynchronous connections.([2](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-    """

sqlspec/adapters/psycopg/config/_sync.py

@@ -7,10 +7,8 @@ from typing import TYPE_CHECKING
 from psycopg import Connection
 from psycopg_pool import ConnectionPool
 
-from sqlspec.adapters.psycopg.config._common import (
-    PsycoPgGenericDatabaseConfig,
-    PsycoPgGenericPoolConfig,
-)
+from sqlspec.adapters.psycopg.config._common import PsycoPgGenericPoolConfig
+from sqlspec.base import SyncDatabaseConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import dataclass_to_dict
 
@@ -31,11 +29,14 @@ class PsycoPgSyncPoolConfig(PsycoPgGenericPoolConfig[Connection, ConnectionPool]
 
 
 @dataclass
-class PsycoPgSyncDatabaseConfig(PsycoPgGenericDatabaseConfig[Connection, ConnectionPool]):
-    """Sync Psycopg database Configuration."""
-
-    __is_async__ = False
-    __supports_connection_pooling__ = True
+class PsycoPgSyncDatabaseConfig(SyncDatabaseConfig[Connection, ConnectionPool]):
+    """Sync Psycopg database Configuration.
+    This class provides the base configuration for Psycopg database connections, extending
+    the generic database configuration with Psycopg-specific settings.([1](https://www.psycopg.org/psycopg3/docs/api/connections.html))
+
+    The configuration supports all standard Psycopg connection parameters and can be used
+    with both synchronous and asynchronous connections.([2](https://www.psycopg.org/psycopg3/docs/api/connections.html))
+    """
 
     pool_config: PsycoPgSyncPoolConfig | None = None
     """Psycopg Pool configuration"""

sqlspec/adapters/sqlite/config.py

@@ -4,7 +4,7 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Literal
 
-from sqlspec.base import GenericDatabaseConfig, NoPoolConfig
+from sqlspec.base import NoPoolSyncConfig
 from sqlspec.exceptions import ImproperConfigurationError
 from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
 
@@ -16,7 +16,7 @@ __all__ = ("SqliteConfig",)
 
 
 @dataclass
-class SqliteConfig(NoPoolConfig["Connection"], GenericDatabaseConfig):
+class SqliteConfig(NoPoolSyncConfig["Connection"]):
     """Configuration for SQLite database connections.
 
     This class provides configuration options for SQLite database connections, wrapping all parameters

sqlspec/base.py

@@ -2,16 +2,21 @@ from abc import ABC, abstractmethod
 from collections.abc import AsyncGenerator, Awaitable, Generator
 from contextlib import AbstractAsyncContextManager, AbstractContextManager
 from dataclasses import dataclass
-from typing import Any, ClassVar, Generic, TypeVar, Union
+from typing import Annotated, Any, ClassVar, Generic, TypeVar, Union, cast, overload
 
 __all__ = (
+    "AsyncDatabaseConfig",
     "DatabaseConfigProtocol",
     "GenericPoolConfig",
-    "NoPoolConfig",
+    "NoPoolAsyncConfig",
+    "NoPoolSyncConfig",
+    "SyncDatabaseConfig",
 )
 
 ConnectionT = TypeVar("ConnectionT")
 PoolT = TypeVar("PoolT")
+AsyncConfigT = TypeVar("AsyncConfigT", bound="Union[AsyncDatabaseConfig[Any, Any], NoPoolAsyncConfig[Any]]")
+SyncConfigT = TypeVar("SyncConfigT", bound="Union[SyncDatabaseConfig[Any, Any], NoPoolSyncConfig[Any]]")
 
 
 @dataclass
@@ -21,6 +26,9 @@ class DatabaseConfigProtocol(Generic[ConnectionT, PoolT], ABC):
     __is_async__: ClassVar[bool] = False
     __supports_connection_pooling__: ClassVar[bool] = False
 
+    def __hash__(self) -> int:
+        return id(self)
+
     @abstractmethod
     def create_connection(self) -> Union[ConnectionT, Awaitable[ConnectionT]]:
         """Create and return a new database connection."""
@@ -67,14 +75,34 @@ class DatabaseConfigProtocol(Generic[ConnectionT, PoolT], ABC):
         return self.__supports_connection_pooling__
 
 
-class NoPoolConfig(DatabaseConfigProtocol[ConnectionT, None]):
-    """Base class for database configurations that do not implement a pool."""
+class NoPoolSyncConfig(DatabaseConfigProtocol[ConnectionT, None]):
+    """Base class for a sync database configurations that do not implement a pool."""
+
+    __is_async__ = False
+    __supports_connection_pooling__ = False
 
     def create_pool(self) -> None:
         """This database backend has not implemented the pooling configurations."""
+        return
+
+    def provide_pool(self, *args: Any, **kwargs: Any) -> None:
+        """This database backend has not implemented the pooling configurations."""
+        return
+
+
+class NoPoolAsyncConfig(DatabaseConfigProtocol[ConnectionT, None]):
+    """Base class for an async database configurations that do not implement a pool."""
+
+    __is_async__ = True
+    __supports_connection_pooling__ = False
+
+    async def create_pool(self) -> None:
+        """This database backend has not implemented the pooling configurations."""
+        return
 
     def provide_pool(self, *args: Any, **kwargs: Any) -> None:
         """This database backend has not implemented the pooling configurations."""
+        return
 
 
 @dataclass
@@ -83,5 +111,111 @@ class GenericPoolConfig:
 
 
 @dataclass
-class GenericDatabaseConfig:
-    """Generic Database Configuration."""
+class SyncDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT]):
+    """Generic Sync Database Configuration."""
+
+    __is_async__ = False
+    __supports_connection_pooling__ = True
+
+
+@dataclass
+class AsyncDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT]):
+    """Generic Async Database Configuration."""
+
+    __is_async__ = True
+    __supports_connection_pooling__ = True
+
+
+class ConfigManager:
+    """Type-safe configuration manager with literal inference."""
+
+    def __init__(self) -> None:
+        self._configs: dict[Any, DatabaseConfigProtocol[Any, Any]] = {}
+
+    @overload
+    def add_config(self, config: SyncConfigT) -> type[SyncConfigT]: ...
+
+    @overload
+    def add_config(self, config: AsyncConfigT) -> type[AsyncConfigT]: ...
+
+    def add_config(
+        self,
+        config: Union[
+            SyncConfigT,
+            AsyncConfigT,
+        ],
+    ) -> Union[Annotated[type[SyncConfigT], int], Annotated[type[AsyncConfigT], int]]:  # pyright: ignore[reportInvalidTypeVarUse]
+        """Add a new configuration to the manager."""
+        key = Annotated[type(config), id(config)]  # type: ignore[valid-type]
+        self._configs[key] = config
+        return key  # type: ignore[return-value]  # pyright: ignore[reportReturnType]
+
+    @overload
+    def get_config(self, name: type[SyncConfigT]) -> SyncConfigT: ...
+
+    @overload
+    def get_config(self, name: type[AsyncConfigT]) -> AsyncConfigT: ...
+
+    def get_config(
+        self, name: Union[type[DatabaseConfigProtocol[ConnectionT, PoolT]], Any]
+    ) -> DatabaseConfigProtocol[ConnectionT, PoolT]:
+        """Retrieve a configuration by its type."""
+        config = self._configs.get(name)
+        if not config:
+            raise KeyError(f"No configuration found for {name}")
+        return config
+
+    @overload
+    def get_connection(
+        self,
+        name: Union[
+            type[NoPoolSyncConfig[ConnectionT]],
+            type[SyncDatabaseConfig[ConnectionT, PoolT]],
+        ],
+    ) -> ConnectionT: ...  # pyright: ignore[reportInvalidTypeVarUse]
+
+    @overload
+    def get_connection(
+        self,
+        name: Union[
+            type[NoPoolAsyncConfig[ConnectionT]],
+            type[AsyncDatabaseConfig[ConnectionT, PoolT]],
+        ],
+    ) -> Awaitable[ConnectionT]: ...  # pyright: ignore[reportInvalidTypeVarUse]
+
+    def get_connection(
+        self,
+        name: Union[
+            type[NoPoolSyncConfig[ConnectionT]],
+            type[NoPoolAsyncConfig[ConnectionT]],
+            type[SyncDatabaseConfig[ConnectionT, PoolT]],
+            type[AsyncDatabaseConfig[ConnectionT, PoolT]],
+        ],
+    ) -> Union[ConnectionT, Awaitable[ConnectionT]]:
+        """Create and return a connection from the specified configuration."""
+        config = self.get_config(name)
+        return config.create_connection()
+
+    @overload
+    def get_pool(self, name: type[Union[NoPoolSyncConfig[ConnectionT], NoPoolAsyncConfig[ConnectionT]]]) -> None: ...  # pyright: ignore[reportInvalidTypeVarUse]
+
+    @overload
+    def get_pool(self, name: type[SyncDatabaseConfig[ConnectionT, PoolT]]) -> type[PoolT]: ...  # pyright: ignore[reportInvalidTypeVarUse]
+
+    @overload
+    def get_pool(self, name: type[AsyncDatabaseConfig[ConnectionT, PoolT]]) -> Awaitable[type[PoolT]]: ...  # pyright: ignore[reportInvalidTypeVarUse]
+
+    def get_pool(
+        self,
+        name: Union[
+            type[NoPoolSyncConfig[ConnectionT]],
+            type[NoPoolAsyncConfig[ConnectionT]],
+            type[SyncDatabaseConfig[ConnectionT, PoolT]],
+            type[AsyncDatabaseConfig[ConnectionT, PoolT]],
+        ],
+    ) -> Union[type[PoolT], Awaitable[type[PoolT]], None]:
+        """Create and return a connection pool from the specified configuration."""
+        config = self.get_config(name)
+        if isinstance(config, (NoPoolSyncConfig, NoPoolAsyncConfig)):
+            return None
+        return cast("Union[type[PoolT], Awaitable[type[PoolT]]]", config.create_pool())

sqlspec/extensions/litestar/plugin.py

@@ -1,34 +1,42 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING
 
 from litestar.plugins import InitPluginProtocol
 
+from sqlspec.base import ConfigManager
+
 if TYPE_CHECKING:
     from litestar.config.app import AppConfig
 
 
-T = TypeVar("T")
-
-
 class SQLSpecPlugin(InitPluginProtocol):
-    """Aiosql plugin."""
+    """SQLSpec plugin."""
 
     __slots__ = ("_config",)
 
-    def __init__(self, config: Any) -> None:
-        """Initialize ``AiosqlPlugin``.
+    def __init__(self, config: ConfigManager) -> None:
+        """Initialize ``SQLSpecPlugin``.
 
         Args:
-            config: configure and start Aiosql.
+            config: configure SQLSpec plugin for use with Litestar.
         """
         self._config = config
 
+    @property
+    def config(self) -> ConfigManager:
+        """Return the plugin config.
+
+        Returns:
+            ConfigManager.
+        """
+        return self._config
+
     def on_app_init(self, app_config: AppConfig) -> AppConfig:
-        """Configure application for use with Aiosql.
+        """Configure application for use with SQLSpec.
 
         Args:
             app_config: The :class:`AppConfig <.config.app.AppConfig>` instance.
         """
-        app_config.signature_namespace.update(self._config.signature_namespace)
+        app_config.signature_types.append(ConfigManager)
         return app_config

{sqlspec-0.5.0.dist-info → sqlspec-0.6.0.dist-info}/METADATA

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: sqlspec
-Version: 0.5.0
+Version: 0.6.0
 Summary: SQL Experiments in Python
 Author-email: Cody Fincher <cody@litestar.dev>
 Maintainer-email: Litestar Developers <hello@litestar.dev>
+License-Expression: MIT
+License-File: LICENSE
 License-File: NOTICE
 Requires-Python: <4.0,>=3.9
 Requires-Dist: eval-type-backport; python_version < '3.10'
@@ -35,7 +37,6 @@ Requires-Dist: msgspec; extra == 'msgspec'
 Provides-Extra: oracledb
 Requires-Dist: oracledb; extra == 'oracledb'
 Provides-Extra: performance
-Requires-Dist: google-re2; (sys_platform == 'linux') and extra == 'performance'
 Requires-Dist: sqlglot[rs]; extra == 'performance'
 Provides-Extra: psycopg
 Requires-Dist: psycopg[binary,pool]; extra == 'psycopg'
@@ -57,30 +58,31 @@ SQLSpec is an experimental Python library designed to streamline and modernize y
 
 **Note**: SQLSpec is currently under active development and the API is subject to change.  It is not yet ready for production use.  Contributions are welcome!
 
-### Core Features (Planned but subject to change, removal or redesign)
+## Core Features (Planned but subject to change, removal or redesign)
 
 - **Consistent Database Session Interface**: Provides a consistent connectivity interface for interacting with one or more database systems, including SQLite, Postgres, DuckDB, MySQL, Oracle, SQL Server, Spanner, BigQuery, and more.
 - **Emphasis on RAW SQL and Minimal Abstractions and Performance**: SQLSpec is a library for working with SQL in Python.  It's goals are to offer minimal abstractions between the user and the database.  It does not aim to be an ORM library.
-- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msqgspec, Attrs, etc.
+- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msgspec, Attrs, etc.
 - **Extensible Design**: Easily add support for new database dialects or extend existing functionality to meet your specific needs.  Easily add support for async and sync database drivers.
 - **Minimal Dependencies**: SQLSpec is designed to be lightweight and can run on it's own or with other libraries such as `litestar`, `fastapi`, `flask` and more.  (Contributions welcome!)
 - **Dynamic Query Manipulation**: Easily apply filters to pre-defined queries with a fluent, Pythonic API. Safely manipulate queries without the risk of SQL injection.
 - **Dialect Validation and Conversion**: Use `sqlglot` to validate your SQL against specific dialects and seamlessly convert between them.
 - **Support for Async and Sync Database Drivers**: SQLSpec supports both async and sync database drivers, allowing you to choose the style that best fits your application.
+- **Basic Migration Management**: A mechanism to generate empty migration files where you can add your own SQL and intelligently track which migrations have been applied.
 
-### What SQLSpec Is Not (Yet)
+## What SQLSpec Is Not (Yet)
 
 SQLSpec is a work in progress. While it offers a solid foundation for modern SQL interactions, it does not yet include every feature you might find in a mature ORM or database toolkit. The focus is on building a robust, flexible core that can be extended over time.
 
-### Inspiration and Future Direction
+## Inspiration and Future Direction
 
 SQLSpec originally drew inspiration from features found in the `aiosql` library.  This is a great library for working with and executed SQL stored in files.  It's unclear how much of an overlap there will be between the two libraries, but it's possible that some features will be contributed back to `aiosql` where appropriate.
 
-### Current Focus: Universal Connectivity
+## Current Focus: Universal Connectivity
 
 The primary goal at this stage is to establish a **native connectivity interface** that works seamlessly across all supported database environments. This means you can connect to any of the supported databases using a consistent API, regardless of the underlying driver or dialect.
 
-### Adapters: Completed, In Progress, and Planned
+## Adapters: Completed, In Progress, and Planned
 
 This list is not final. If you have a driver you'd like to see added, please open an issue or submit a PR!
 
@@ -98,13 +100,13 @@ This list is not final. If you have a driver you'd like to see added, please ope
 | [`oracledb`](https://oracle.github.io/python-oracledb/)                                                      | Oracle     | Async   | ✅         |
 | [`oracledb`](https://oracle.github.io/python-oracledb/)                                                      | Oracle     | Sync    | ✅         |
 | [`duckdb`](https://duckdb.org/)                                                                               | DuckDB     | Sync    | ✅         |
-| [`bigquery`](https://googleapis.dev/python/bigquery/latest/index.html)                                        | BigQuery   | Sync    | 🗓️ Planned |
-| [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️ Planned |
-| [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️ Planned |
-| [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️ Planned |
-| [`snowflake`](https://docs.snowflake.com)
+| [`bigquery`](https://googleapis.dev/python/bigquery/latest/index.html)                                        | BigQuery   | Sync    | 🗓️ |
+| [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️  |
+| [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️  |
+| [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️  |
+| [`snowflake`](https://docs.snowflake.com)                                                                    | Snowflake  | Sync    | 🗓️  |
 
-### Proposed Project Structure
+## Proposed Project Structure
 
 - `sqlspec/`:
     - `adapters/`: Contains all database drivers and associated configuration.
@@ -119,7 +121,7 @@ This list is not final. If you have a driver you'd like to see added, please ope
     - `exceptions.py`: Contains custom exceptions for SQLSpec.
     - `typing.py`: Contains type hints, type guards and several facades for optional libraries that are not required for the core functionality of SQLSpec.
 
-### Get Involved
+## Get Involved
 
 SQLSpec is an open-source project, and contributions are welcome! Whether you're interested in adding support for new databases, improving the query interface, or simply providing feedback, your input is valuable.
 

{sqlspec-0.5.0.dist-info → sqlspec-0.6.0.dist-info}/RECORD

@@ -1,44 +1,46 @@
 sqlspec/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-sqlspec/__metadata__.py,sha256=Vw99abV_UQNVH2jB0IBa9-8emyZQcXm1J9eMtLxFX2Y,496
+sqlspec/__metadata__.py,sha256=KWtGqYzOJaPcKEiZAsQwwnwz3cHls7wkgmdx61W01vw,496
 sqlspec/_serialization.py,sha256=NnJajyQU2I1QCwE0eOBcUbG1E25aiNLOPqMk6S-52Sg,850
 sqlspec/_typing.py,sha256=pJkUkgy3zra1SFV96F4PTWStWyRNV44rrZEyrtQfgbw,4235
-sqlspec/base.py,sha256=rvdylQ2YyTx8iyqgpk04FmkFwNpd_qZytUs4mvJ6MBw,2793
+sqlspec/base.py,sha256=b3i6biSBLovRW8ts2L1gtVQgxXHCw6S1sKjFfmj2gfQ,7713
 sqlspec/exceptions.py,sha256=fhCOILBj0J7HJP67BNSC0d9YUbW8QpZPXM55xJJzE8A,3039
 sqlspec/filters.py,sha256=K6AVBo1OTLVXZZiLuM7n_44MQKUT0DzZe9roiAsTX-4,3614
 sqlspec/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlspec/typing.py,sha256=6g8lkdYRAFWW_4Vct9D2QNOaw0AYyHHMXT7jbdT6aeI,13665
 sqlspec/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlspec/adapters/adbc/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqlspec/adapters/adbc/config.py,sha256=DRlcJGo2haN_UKTnp4zplC_UV6yf5XwyHu0Z2L5lrSM,1690
+sqlspec/adapters/adbc/config.py,sha256=AF5rWTqc7GHmajcCeDXyWci8ForWpQzogQbMphaHEEs,1652
 sqlspec/adapters/aiosqlite/__init__.py,sha256=PLqWg24l3TooJvqA0Xf1WErrxtqwo8DEoL_Zp2iSCzs,68
-sqlspec/adapters/aiosqlite/config.py,sha256=ou3aAB2JzTkkFplTCwdXKTVHMPfoGsTR1CGdI9BeSM4,3861
+sqlspec/adapters/aiosqlite/config.py,sha256=S_NU925KisY8AQAEpdTvdQI0nEOiY8Xi-CCPzsdUb7g,3956
 sqlspec/adapters/asyncmy/__init__.py,sha256=o0R_Azae3FHiSZ1TQ5ZjyCneDOuvnEeMjmSkhuiKoWo,103
-sqlspec/adapters/asyncmy/config.py,sha256=YWsw8PBDMae-oVle-szKBzZYFq9ayIhDL7UdLLM7ybk,5696
+sqlspec/adapters/asyncmy/config.py,sha256=PUVUmi62MELljUwpZh9TYRGbmBujXkvNVgxEnvWHecA,5644
 sqlspec/adapters/asyncpg/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqlspec/adapters/asyncpg/config.py,sha256=3kDG4nAtdRU8gC-AJvifwwIokDtrI63G6aYcMKwNHZQ,6226
+sqlspec/adapters/asyncpg/config.py,sha256=77RIUNxGQSEED6Fg_kdP1OlpLLIkzNw9Y_pMp2eJbGg,6131
 sqlspec/adapters/duckdb/__init__.py,sha256=-IC44IEsRPbz16HpQFAGkV7Bfbow8CGMruBsdMEIEf4,85
-sqlspec/adapters/duckdb/config.py,sha256=sqKD_FUdPMQKZad15qX9VIMQ2CdTd5x6Jors43YxQbE,8206
+sqlspec/adapters/duckdb/config.py,sha256=rJ3nC514LVk5cUVvAP8aS0oQXot76DqwEAtGLlPm0so,8168
 sqlspec/adapters/oracledb/__init__.py,sha256=f7P24wnDhDoEwgO0pJbutqqN2L0WUZWqVJIAcvphb4M,300
 sqlspec/adapters/oracledb/config/__init__.py,sha256=XoHgInT4IbXjDg5ax3ncuUoVvnYB5qQjI-Ib7gwSycU,338
-sqlspec/adapters/oracledb/config/_asyncio.py,sha256=Hr28ogOUED1kRIPYQE73hA6fpthDTJ3rxFg4-PO2ZtU,3327
-sqlspec/adapters/oracledb/config/_common.py,sha256=5y8G_aYjJAGAVSQufMQlGHnlSW5cqeiBmz4W5lCceOQ,6244
-sqlspec/adapters/oracledb/config/_sync.py,sha256=QsPNqiO4GKD1oouAL6ulApKJx6_r5_Sjcy2udrOK1JU,3232
+sqlspec/adapters/oracledb/config/_asyncio.py,sha256=yq05yLzJyMTc-9DqpRJoHu8V9T0U6MYMnt0x23ndJHY,4019
+sqlspec/adapters/oracledb/config/_common.py,sha256=9FQAynMkh8ATBoVhloPqf6AMc-XSKg29N-RtzFokyhs,5334
+sqlspec/adapters/oracledb/config/_sync.py,sha256=9WRAgFUOycFCtqqO8HuB8ADfv4ou1u_h01gou9dOEhI,3882
 sqlspec/adapters/psycopg/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlspec/adapters/psycopg/config/__init__.py,sha256=y4s9ezhFu764yQIqm_qlE_HYJiumTRN_dDfewwRGSkI,342
-sqlspec/adapters/psycopg/config/_async.py,sha256=d3nZCn6pjxUCWqEdHKrdWsu7wkR5b4dkEygm3zR_gTk,2828
-sqlspec/adapters/psycopg/config/_common.py,sha256=p4oh2nqwvN1IAM8M9OqPWjBdPRw2-Qow3RIx-houjYc,2794
-sqlspec/adapters/psycopg/config/_sync.py,sha256=8HhvhDufeFtuKROkKAW96Pl2lVB_5WPBBrXK9AJz3uE,2707
+sqlspec/adapters/psycopg/config/_async.py,sha256=r-RQeVUgIqWPNxoTegXNfS3hnFoUt2eB8JCvm5A_hEQ,3198
+sqlspec/adapters/psycopg/config/_common.py,sha256=UP0BXPSEsbY-CLxLktx4vhmEO-jdSQI1eXqSeo0vjAE,2102
+sqlspec/adapters/psycopg/config/_sync.py,sha256=btaJkyPj8SX_ZN5_9bu7flcqWv1_YNk4p_JauiYDriQ,3073
 sqlspec/adapters/sqlite/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqlspec/adapters/sqlite/config.py,sha256=tNF3a3wQDzZaa1UEVKrhtVmIjF-8mqTGhQKUhJi5tMM,3750
+sqlspec/adapters/sqlite/config.py,sha256=dvxXMsUc6AgnjZyAcQ2clZM4y3iNViMUJLH2DxL-AOs,3712
 sqlspec/extensions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlspec/extensions/litestar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sqlspec/extensions/litestar/plugin.py,sha256=oiBFfRffNvy_vnGptREd6JYZGB6Yd98KbtVct_VcW0A,837
+sqlspec/extensions/litestar/config.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlspec/extensions/litestar/plugin.py,sha256=phX5x9JTIHxfC-U7-Gowq6HQilD-j13WnK2n7-93MWw,1030
 sqlspec/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sqlspec/utils/deprecation.py,sha256=MbmIs1Qz1ZIITW7TrCE-wa1nmO0x4nGqtM1AShmKYT8,3900
 sqlspec/utils/fixtures.py,sha256=FbySeVuU0E_B885ulQh_J5CO_5eL51beH9X0y9zjsYU,2196
 sqlspec/utils/module_loader.py,sha256=Qe52uUgAwHSMJC2aKQwMs0F1XSbwJARF-8QdASItH_M,2720
 sqlspec/utils/text.py,sha256=FnlNj7drS6JwcFc3dd7BPUBP6JDSmxTZmxnZPAB-Yq0,1479
-sqlspec-0.5.0.dist-info/METADATA,sha256=0ROm7C3bz5eykaLTrEG4Yed9AR82cN0VVL5D-GJ26zQ,8932
-sqlspec-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sqlspec-0.5.0.dist-info/licenses/NOTICE,sha256=Lyir8ozXWov7CyYS4huVaOCNrtgL17P-bNV-5daLntQ,1634
-sqlspec-0.5.0.dist-info/RECORD,,
+sqlspec-0.6.0.dist-info/METADATA,sha256=Tk8P_oOaDt2ujjEx0UTB_vH0v5optk4m4inl36wh5oA,9135
+sqlspec-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sqlspec-0.6.0.dist-info/licenses/LICENSE,sha256=MdujfZ6l5HuLz4mElxlu049itenOR3gnhN1_Nd3nVcM,1078
+sqlspec-0.6.0.dist-info/licenses/NOTICE,sha256=Lyir8ozXWov7CyYS4huVaOCNrtgL17P-bNV-5daLntQ,1634
+sqlspec-0.6.0.dist-info/RECORD,,

sqlspec-0.6.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Litestar Organization
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.