sqlspec 0.24.1__py3-none-any.whl → 0.26.0__py3-none-any.whl

sqlspec/config.py

@@ -1,5 +1,6 @@
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any, Callable, ClassVar, Generic, Optional, TypeVar, Union
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, Callable, ClassVar, Generic, Optional, TypeVar, Union, cast
 
 from typing_extensions import NotRequired, TypedDict
 
@@ -11,11 +12,10 @@ from sqlspec.utils.logging import get_logger
 if TYPE_CHECKING:
     from collections.abc import Awaitable
     from contextlib import AbstractAsyncContextManager, AbstractContextManager
-    from pathlib import Path
 
     from sqlspec.driver import AsyncDriverAdapterBase, SyncDriverAdapterBase
     from sqlspec.loader import SQLFileLoader
-    from sqlspec.migrations.commands import MigrationCommands
+    from sqlspec.migrations.commands import AsyncMigrationCommands, SyncMigrationCommands
 
 
 __all__ = (
@@ -89,6 +89,7 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
     __slots__ = (
         "_migration_commands",
         "_migration_loader",
+        "bind_key",
         "driver_features",
         "migration_config",
         "pool_instance",
@@ -96,7 +97,7 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
     )
 
     _migration_loader: "SQLFileLoader"
-    _migration_commands: "MigrationCommands"
+    _migration_commands: "Union[SyncMigrationCommands, AsyncMigrationCommands]"
     driver_type: "ClassVar[type[Any]]"
     connection_type: "ClassVar[type[Any]]"
     is_async: "ClassVar[bool]" = False
@@ -105,6 +106,7 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
     supports_native_arrow_export: "ClassVar[bool]" = False
     supports_native_parquet_import: "ClassVar[bool]" = False
     supports_native_parquet_export: "ClassVar[bool]" = False
+    bind_key: "Optional[str]"
     statement_config: "StatementConfig"
     pool_instance: "Optional[PoolT]"
     migration_config: "Union[dict[str, Any], MigrationConfig]"
@@ -176,10 +178,10 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
         at runtime when needed.
         """
         from sqlspec.loader import SQLFileLoader
-        from sqlspec.migrations.commands import MigrationCommands
+        from sqlspec.migrations.commands import create_migration_commands
 
         self._migration_loader = SQLFileLoader()
-        self._migration_commands = MigrationCommands(self)  # type: ignore[arg-type]
+        self._migration_commands = create_migration_commands(self)  # type: ignore[arg-type]
 
     def _ensure_migration_loader(self) -> "SQLFileLoader":
         """Get the migration SQL loader and auto-load files if needed.
@@ -200,7 +202,7 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
 
         return self._migration_loader
 
-    def _ensure_migration_commands(self) -> "MigrationCommands":
+    def _ensure_migration_commands(self) -> "Union[SyncMigrationCommands, AsyncMigrationCommands]":
         """Get the migration commands instance.
 
         Returns:
@@ -225,7 +227,6 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
         Args:
             *paths: One or more file paths or directory paths to load migration SQL files from.
         """
-        from pathlib import Path
 
         loader = self._ensure_migration_loader()
         for path in paths:
@@ -236,7 +237,7 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
             else:
                 logger.warning("Migration path does not exist: %s", path_obj)
 
-    def get_migration_commands(self) -> "MigrationCommands":
+    def get_migration_commands(self) -> "Union[SyncMigrationCommands, AsyncMigrationCommands]":
         """Get migration commands for this configuration.
 
         Returns:
@@ -244,25 +245,27 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
         """
         return self._ensure_migration_commands()
 
-    def migrate_up(self, revision: str = "head") -> None:
+    async def migrate_up(self, revision: str = "head") -> None:
         """Apply migrations up to the specified revision.
 
         Args:
             revision: Target revision or "head" for latest. Defaults to "head".
         """
         commands = self._ensure_migration_commands()
-        commands.upgrade(revision)
 
-    def migrate_down(self, revision: str = "-1") -> None:
+        await cast("AsyncMigrationCommands", commands).upgrade(revision)
+
+    async def migrate_down(self, revision: str = "-1") -> None:
         """Apply migrations down to the specified revision.
 
         Args:
             revision: Target revision, "-1" for one step back, or "base" for all migrations. Defaults to "-1".
         """
         commands = self._ensure_migration_commands()
-        commands.downgrade(revision)
 
-    def get_current_migration(self, verbose: bool = False) -> "Optional[str]":
+        await cast("AsyncMigrationCommands", commands).downgrade(revision)
+
+    async def get_current_migration(self, verbose: bool = False) -> "Optional[str]":
         """Get the current migration version.
 
         Args:
@@ -272,9 +275,10 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
             Current migration version or None if no migrations applied.
         """
         commands = self._ensure_migration_commands()
-        return commands.current(verbose=verbose)
 
-    def create_migration(self, message: str, file_type: str = "sql") -> None:
+        return await cast("AsyncMigrationCommands", commands).current(verbose=verbose)
+
+    async def create_migration(self, message: str, file_type: str = "sql") -> None:
         """Create a new migration file.
 
         Args:
@@ -282,9 +286,10 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
             file_type: Type of migration file to create ('sql' or 'py'). Defaults to 'sql'.
         """
         commands = self._ensure_migration_commands()
-        commands.revision(message, file_type)
 
-    def init_migrations(self, directory: "Optional[str]" = None, package: bool = True) -> None:
+        await cast("AsyncMigrationCommands", commands).revision(message, file_type)
+
+    async def init_migrations(self, directory: "Optional[str]" = None, package: bool = True) -> None:
         """Initialize migration directory structure.
 
         Args:
@@ -297,7 +302,8 @@ class DatabaseConfigProtocol(ABC, Generic[ConnectionT, PoolT, DriverT]):
 
         commands = self._ensure_migration_commands()
         assert directory is not None
-        commands.init(directory, package)
+
+        await cast("AsyncMigrationCommands", commands).init(directory, package)
 
 
 class NoPoolSyncConfig(DatabaseConfigProtocol[ConnectionT, None, DriverT]):
@@ -315,7 +321,9 @@ class NoPoolSyncConfig(DatabaseConfigProtocol[ConnectionT, None, DriverT]):
         migration_config: "Optional[Union[dict[str, Any], MigrationConfig]]" = None,
         statement_config: "Optional[StatementConfig]" = None,
         driver_features: "Optional[dict[str, Any]]" = None,
+        bind_key: "Optional[str]" = None,
     ) -> None:
+        self.bind_key = bind_key
         self.pool_instance = None
         self.connection_config = connection_config or {}
         self.migration_config: Union[dict[str, Any], MigrationConfig] = migration_config or {}
@@ -369,7 +377,9 @@ class NoPoolAsyncConfig(DatabaseConfigProtocol[ConnectionT, None, DriverT]):
         migration_config: "Optional[Union[dict[str, Any], MigrationConfig]]" = None,
         statement_config: "Optional[StatementConfig]" = None,
         driver_features: "Optional[dict[str, Any]]" = None,
+        bind_key: "Optional[str]" = None,
     ) -> None:
+        self.bind_key = bind_key
         self.pool_instance = None
         self.connection_config = connection_config or {}
         self.migration_config: Union[dict[str, Any], MigrationConfig] = migration_config or {}
@@ -424,7 +434,9 @@ class SyncDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT, DriverT]):
         migration_config: "Optional[Union[dict[str, Any], MigrationConfig]]" = None,
         statement_config: "Optional[StatementConfig]" = None,
         driver_features: "Optional[dict[str, Any]]" = None,
+        bind_key: "Optional[str]" = None,
     ) -> None:
+        self.bind_key = bind_key
         self.pool_instance = pool_instance
         self.pool_config = pool_config or {}
         self.migration_config: Union[dict[str, Any], MigrationConfig] = migration_config or {}
@@ -501,7 +513,9 @@ class AsyncDatabaseConfig(DatabaseConfigProtocol[ConnectionT, PoolT, DriverT]):
         migration_config: "Optional[Union[dict[str, Any], MigrationConfig]]" = None,
         statement_config: "Optional[StatementConfig]" = None,
         driver_features: "Optional[dict[str, Any]]" = None,
+        bind_key: "Optional[str]" = None,
     ) -> None:
+        self.bind_key = bind_key
         self.pool_instance = pool_instance
         self.pool_config = pool_config or {}
         self.migration_config: Union[dict[str, Any], MigrationConfig] = migration_config or {}

sqlspec/core/__init__.py

@@ -90,7 +90,7 @@ Example Usage:
 """
 
 from sqlspec.core import filters
-from sqlspec.core.cache import CacheConfig, CacheStats, UnifiedCache, get_statement_cache
+from sqlspec.core.cache import CacheConfig, CacheStats, MultiLevelCache, UnifiedCache, get_cache
 from sqlspec.core.compiler import OperationType, SQLProcessor
 from sqlspec.core.filters import StatementFilter
 from sqlspec.core.hashing import (
@@ -115,6 +115,7 @@ __all__ = (
     "ArrowResult",
     "CacheConfig",
     "CacheStats",
+    "MultiLevelCache",
     "OperationType",
     "ParameterConverter",
     "ParameterProcessor",
@@ -129,7 +130,7 @@ __all__ = (
     "TypedParameter",
     "UnifiedCache",
     "filters",
-    "get_statement_cache",
+    "get_cache",
     "hash_expression",
     "hash_expression_node",
     "hash_optimized_expression",