sqlspec 0.47.0__cp314-cp314-win_amd64.whl

sqlspec/adapters/sqlite/config.py

@@ -0,0 +1,240 @@
+"""SQLite database configuration with thread-local connections."""
+
+import uuid
+from typing import TYPE_CHECKING, Any, ClassVar, TypedDict
+
+from typing_extensions import NotRequired
+
+from sqlspec.adapters.sqlite._typing import SqliteConnection, SqliteCursor, SqliteSessionContext
+from sqlspec.adapters.sqlite.core import apply_driver_features, build_connection_config, default_statement_config
+from sqlspec.adapters.sqlite.driver import SqliteDriver, SqliteExceptionHandler
+from sqlspec.adapters.sqlite.pool import SqliteConnectionPool
+from sqlspec.adapters.sqlite.type_converter import register_type_handlers
+from sqlspec.config import ExtensionConfigs, SyncDatabaseConfig
+from sqlspec.driver._sync import SyncPoolConnectionContext, SyncPoolSessionFactory
+from sqlspec.utils.logging import get_logger
+
+logger = get_logger("sqlspec.adapters.sqlite")
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from sqlspec.core import StatementConfig
+    from sqlspec.observability import ObservabilityConfig
+
+
+class SqliteConnectionParams(TypedDict):
+    """SQLite connection parameters."""
+
+    database: NotRequired[str]
+    timeout: NotRequired[float]
+    detect_types: NotRequired[int]
+    isolation_level: "NotRequired[str | None]"
+    check_same_thread: NotRequired[bool]
+    factory: "NotRequired[type[SqliteConnection] | None]"
+    cached_statements: NotRequired[int]
+    uri: NotRequired[bool]
+
+
+class SqliteDriverFeatures(TypedDict):
+    """SQLite driver feature configuration.
+
+    Controls optional type handling and serialization features for SQLite connections.
+
+    enable_custom_adapters: Enable custom type adapters for JSON/UUID/datetime conversion.
+        Defaults to True for enhanced Python type support.
+        Set to False only if you need pure SQLite behavior without type conversions.
+    json_serializer: Custom JSON serializer function.
+        Defaults to sqlspec.utils.serializers.to_json.
+    json_deserializer: Custom JSON deserializer function.
+        Defaults to sqlspec.utils.serializers.from_json.
+    on_connection_create: Callback executed when a connection is created.
+        Receives the raw sqlite3 connection for low-level driver configuration.
+        Runs after internal setup (PRAGMA optimizations).
+    enable_events: Enable database event channel support.
+        Defaults to True when extension_config["events"] is configured.
+        Provides pub/sub capabilities via table-backed queue (SQLite has no native pub/sub).
+        Requires extension_config["events"] for migration setup.
+    events_backend: Event channel backend selection.
+        Only option: "table_queue" (durable table-backed queue with retries and exactly-once delivery).
+        SQLite does not have native pub/sub, so table_queue is the only backend.
+        Defaults to "table_queue".
+    """
+
+    enable_custom_adapters: NotRequired[bool]
+    json_serializer: "NotRequired[Callable[[Any], str]]"
+    json_deserializer: "NotRequired[Callable[[str], Any]]"
+    on_connection_create: "NotRequired[Callable[[SqliteConnection], None]]"
+    enable_events: NotRequired[bool]
+    events_backend: NotRequired[str]
+
+
+__all__ = ("SqliteConfig", "SqliteConnectionParams", "SqliteDriverFeatures")
+
+
+class SqliteConnectionContext(SyncPoolConnectionContext):
+    """Context manager for Sqlite connections."""
+
+    __slots__ = ()
+
+
+class _SqliteSessionConnectionHandler(SyncPoolSessionFactory):
+    __slots__ = ()
+
+
+class SqliteConfig(SyncDatabaseConfig[SqliteConnection, SqliteConnectionPool, SqliteDriver]):
+    """SQLite configuration with thread-local connections.
+
+    Example::
+
+        config = SqliteConfig(
+            connection_config=SqliteConnectionParams(
+                database="app.db"
+            )
+        )
+    """
+
+    driver_type: "ClassVar[type[SqliteDriver]]" = SqliteDriver
+    connection_type: "ClassVar[type[SqliteConnection]]" = SqliteConnection
+    supports_transactional_ddl: "ClassVar[bool]" = True
+    supports_native_arrow_export: "ClassVar[bool]" = True
+    supports_native_arrow_import: "ClassVar[bool]" = True
+    supports_native_parquet_export: "ClassVar[bool]" = True
+    supports_native_parquet_import: "ClassVar[bool]" = True
+    _connection_context_class: "ClassVar[type[SqliteConnectionContext]]" = SqliteConnectionContext
+    _session_factory_class: "ClassVar[type[_SqliteSessionConnectionHandler]]" = _SqliteSessionConnectionHandler
+    _session_context_class: "ClassVar[type[SqliteSessionContext]]" = SqliteSessionContext
+    _default_statement_config = default_statement_config
+
+    def __init__(
+        self,
+        *,
+        connection_config: "SqliteConnectionParams | dict[str, Any] | None" = None,
+        connection_instance: "SqliteConnectionPool | None" = None,
+        migration_config: "dict[str, Any] | None" = None,
+        statement_config: "StatementConfig | None" = None,
+        driver_features: "SqliteDriverFeatures | dict[str, Any] | None" = None,
+        bind_key: "str | None" = None,
+        extension_config: "ExtensionConfigs | None" = None,
+        observability_config: "ObservabilityConfig | None" = None,
+        **kwargs: Any,
+    ) -> None:
+        """Initialize SQLite configuration.
+
+        Args:
+            connection_config: Configuration parameters including connection settings
+            connection_instance: Pre-created pool instance
+            migration_config: Migration configuration
+            statement_config: Default SQL statement configuration
+            driver_features: Optional driver feature configuration
+            bind_key: Optional bind key for the configuration
+            extension_config: Extension-specific configuration (e.g., Litestar plugin settings)
+            observability_config: Adapter-level observability overrides for lifecycle hooks and observers
+            **kwargs: Additional keyword arguments passed to the base configuration.
+        """
+        config_dict: dict[str, Any] = dict(connection_config) if connection_config else {}
+        if "database" not in config_dict or config_dict["database"] == ":memory:":
+            config_dict["database"] = f"file:memory_{uuid.uuid4().hex}?mode=memory&cache=private"
+            config_dict["uri"] = True
+        elif "database" in config_dict:
+            database_path = str(config_dict["database"])
+            if database_path.startswith("file:") and not config_dict.get("uri"):
+                logger.debug(
+                    "Database URI detected (%s) but uri=True not set. "
+                    "Auto-enabling URI mode to prevent physical file creation.",
+                    database_path,
+                )
+                config_dict["uri"] = True
+
+        statement_config = statement_config or default_statement_config
+        statement_config, driver_features = apply_driver_features(statement_config, driver_features)
+
+        # Extract user connection hook before storing driver_features
+        features_dict = dict(driver_features) if driver_features else {}
+        self._user_connection_hook: Callable[[SqliteConnection], None] | None = features_dict.pop(
+            "on_connection_create", None
+        )
+
+        super().__init__(
+            bind_key=bind_key,
+            connection_instance=connection_instance,
+            connection_config=config_dict,
+            migration_config=migration_config,
+            statement_config=statement_config,
+            driver_features=features_dict,
+            extension_config=extension_config,
+            observability_config=observability_config,
+            **kwargs,
+        )
+
+    def _create_pool(self) -> SqliteConnectionPool:
+        """Create connection pool from configuration."""
+        config_dict = build_connection_config(self.connection_config)
+
+        pool_kwargs: dict[str, Any] = {}
+        recycle_seconds = self.connection_config.get("pool_recycle_seconds")
+        if recycle_seconds is not None:
+            pool_kwargs["recycle_seconds"] = recycle_seconds
+
+        health_check_interval = self.connection_config.get("health_check_interval")
+        if health_check_interval is not None:
+            pool_kwargs["health_check_interval"] = health_check_interval
+
+        enable_optimizations = self.connection_config.get("enable_optimizations")
+        if enable_optimizations is not None:
+            pool_kwargs["enable_optimizations"] = enable_optimizations
+
+        pool = SqliteConnectionPool(
+            connection_parameters=config_dict, on_connection_create=self._user_connection_hook, **pool_kwargs
+        )
+
+        if self.driver_features.get("enable_custom_adapters", False):
+            self._register_type_adapters()
+
+        return pool
+
+    def _register_type_adapters(self) -> None:
+        """Register custom type adapters and converters for SQLite.
+
+        Called once during pool creation if enable_custom_adapters is True.
+        Registers JSON serialization handlers if configured.
+        """
+        if self.driver_features.get("enable_custom_adapters", False):
+            register_type_handlers(
+                json_serializer=self.driver_features.get("json_serializer"),
+                json_deserializer=self.driver_features.get("json_deserializer"),
+            )
+
+    def _close_pool(self) -> None:
+        """Close the connection pool."""
+        if self.connection_instance:
+            self.connection_instance.close()
+
+    def create_connection(self) -> SqliteConnection:
+        """Get a SQLite connection from the pool.
+
+        Returns:
+            SqliteConnection: A connection from the pool
+        """
+        pool = self.provide_pool()
+        return pool.acquire()
+
+    def get_signature_namespace(self) -> "dict[str, Any]":
+        """Get the signature namespace for SQLite types.
+
+        Returns:
+            Dictionary mapping type names to types.
+        """
+        namespace = super().get_signature_namespace()
+        namespace.update({
+            "SqliteConnectionContext": SqliteConnectionContext,
+            "SqliteConnection": SqliteConnection,
+            "SqliteConnectionParams": SqliteConnectionParams,
+            "SqliteConnectionPool": SqliteConnectionPool,
+            "SqliteCursor": SqliteCursor,
+            "SqliteDriver": SqliteDriver,
+            "SqliteDriverFeatures": SqliteDriverFeatures,
+            "SqliteExceptionHandler": SqliteExceptionHandler,
+            "SqliteSessionContext": SqliteSessionContext,
+        })
+        return namespace

sqlspec/adapters/sqlite/core.py

@@ -0,0 +1,357 @@
+"""SQLite adapter compiled helpers."""
+
+from datetime import date, datetime
+from decimal import Decimal
+from typing import TYPE_CHECKING, Any, cast
+
+from sqlspec.core import DriverParameterProfile, ParameterStyle, StatementConfig, build_statement_config_from_profile
+from sqlspec.exceptions import (
+    CheckViolationError,
+    DatabaseConnectionError,
+    DataError,
+    DeadlockError,
+    ForeignKeyViolationError,
+    IntegrityError,
+    NotNullViolationError,
+    OperationalError,
+    PermissionDeniedError,
+    QueryTimeoutError,
+    SQLParsingError,
+    SQLSpecError,
+    UniqueViolationError,
+)
+from sqlspec.utils.serializers import from_json, to_json
+from sqlspec.utils.type_converters import build_decimal_converter, build_time_iso_converter, build_uuid_coercions
+from sqlspec.utils.type_guards import has_sqlite_error
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Mapping, Sequence
+
+__all__ = (
+    "apply_driver_features",
+    "build_connection_config",
+    "build_insert_statement",
+    "build_profile",
+    "build_statement_config",
+    "collect_rows",
+    "create_mapped_exception",
+    "default_statement_config",
+    "driver_profile",
+    "format_identifier",
+    "normalize_execute_many_parameters",
+    "normalize_execute_parameters",
+    "resolve_rowcount",
+)
+
+SQLITE_CONSTRAINT_UNIQUE_CODE = 2067
+SQLITE_CONSTRAINT_FOREIGNKEY_CODE = 787
+SQLITE_CONSTRAINT_NOTNULL_CODE = 1811
+SQLITE_CONSTRAINT_CHECK_CODE = 531
+SQLITE_CONSTRAINT_CODE = 19
+SQLITE_CANTOPEN_CODE = 14
+SQLITE_IOERR_CODE = 10
+SQLITE_MISMATCH_CODE = 20
+SQLITE_BUSY_CODE = 5
+SQLITE_LOCKED_CODE = 6
+SQLITE_INTERRUPT_CODE = 9
+SQLITE_PERM_CODE = 3
+SQLITE_READONLY_CODE = 8
+
+
+_TIME_TO_ISO = build_time_iso_converter()
+_DECIMAL_TO_STRING = build_decimal_converter(mode="string")
+
+
+def _bool_to_int(value: bool) -> int:
+    return int(value)
+
+
+def _quote_sqlite_identifier(identifier: str) -> str:
+    normalized = identifier.replace('"', '""')
+    return f'"{normalized}"'
+
+
+def format_identifier(identifier: str) -> str:
+    cleaned = identifier.strip()
+    if not cleaned:
+        msg = "Table name must not be empty"
+        raise SQLSpecError(msg)
+
+    if "." not in cleaned:
+        return _quote_sqlite_identifier(cleaned)
+
+    return ".".join(_quote_sqlite_identifier(part) for part in cleaned.split(".") if part)
+
+
+def build_insert_statement(table: str, columns: "list[str]") -> str:
+    column_clause = ", ".join(_quote_sqlite_identifier(column) for column in columns)
+    placeholders = ", ".join("?" for _ in columns)
+    return f"INSERT INTO {format_identifier(table)} ({column_clause}) VALUES ({placeholders})"
+
+
+def collect_rows(fetched_data: "list[Any]", description: "Sequence[Any] | None") -> "tuple[list[Any], list[str], int]":
+    """Collect SQLite result rows as raw tuples.
+
+    Returns raw driver-native rows without dict conversion for lazy materialization.
+
+    Args:
+        fetched_data: Raw rows from cursor.fetchall()
+        description: Cursor description (tuple of tuples)
+
+    Returns:
+        Tuple of (data, column_names, row_count)
+    """
+    if not description:
+        return [], [], 0
+
+    column_names = [col[0] for col in description]
+    return fetched_data, column_names, len(fetched_data)
+
+
+def resolve_rowcount(cursor: Any) -> int:
+    """Resolve rowcount from a SQLite cursor.
+
+    Args:
+        cursor: SQLite cursor with optional rowcount metadata.
+
+    Returns:
+        Positive rowcount value or 0 when unknown.
+    """
+    try:
+        rowcount = cursor.rowcount
+    except AttributeError:
+        return 0
+
+    if isinstance(rowcount, int) and rowcount > 0:
+        return rowcount
+    return 0
+
+
+def normalize_execute_parameters(parameters: Any) -> Any:
+    """Normalize parameters for SQLite execute calls.
+
+    Args:
+        parameters: Prepared parameters payload.
+
+    Returns:
+        Normalized parameters payload.
+    """
+    return parameters or ()
+
+
+def normalize_execute_many_parameters(parameters: Any) -> Any:
+    """Normalize parameters for SQLite executemany calls.
+
+    Args:
+        parameters: Prepared parameters payload.
+
+    Returns:
+        Normalized parameters payload.
+
+    Raises:
+        ValueError: When parameters are missing for executemany.
+    """
+    if not parameters:
+        msg = "execute_many requires parameters"
+        raise ValueError(msg)
+    return parameters
+
+
+def build_connection_config(connection_config: "Mapping[str, Any]") -> "dict[str, Any]":
+    """Build connection configuration for pool creation.
+
+    Args:
+        connection_config: Raw connection configuration mapping.
+
+    Returns:
+        Dictionary with connection parameters.
+    """
+    excluded_keys = {
+        "enable_optimizations",
+        "health_check_interval",
+        "pool_min_size",
+        "pool_max_size",
+        "pool_timeout",
+        "pool_recycle_seconds",
+        "extra",
+    }
+    return {key: value for key, value in connection_config.items() if value is not None and key not in excluded_keys}
+
+
+def _create_sqlite_error(
+    error: Any, code: "int | None", error_class: type[SQLSpecError], description: str
+) -> SQLSpecError:
+    """Create a SQLSpec exception from a SQLite error.
+
+    Args:
+        error: The original SQLite exception
+        code: SQLite extended error code
+        error_class: The SQLSpec exception class to instantiate
+        description: Human-readable description of the error type
+
+    Returns:
+        A new SQLSpec exception instance with the original as its cause
+    """
+    code_str = f"[code {code}]" if code else ""
+    msg = f"SQLite {description} {code_str}: {error}" if code_str else f"SQLite {description}: {error}"
+    exc = error_class(msg)
+    exc.__cause__ = cast("BaseException", error)
+    return exc
+
+
+def create_mapped_exception(error: BaseException) -> SQLSpecError:
+    """Map SQLite exceptions to SQLSpec exceptions.
+
+    This is a factory function that returns an exception instance rather than
+    raising. This pattern is more robust for use in __exit__ handlers and
+    avoids issues with exception control flow in different Python versions.
+
+    Mapping priority:
+    1. SQLite extended error codes (most reliable)
+    2. SQLite error names
+    3. Error message patterns
+    4. Default SQLSpecError fallback
+
+    Args:
+        error: The SQLite exception to map
+
+    Returns:
+        A SQLSpec exception that wraps the original error
+    """
+    if has_sqlite_error(error):
+        error_code = error.sqlite_errorcode
+        error_name = error.sqlite_errorname
+    else:
+        error_code = None
+        error_name = None
+    error_msg = str(error).lower()
+
+    # Check for busy/locked conditions first (deadlock-like scenarios in SQLite)
+    # SQLITE_BUSY means another process has the database locked
+    # SQLITE_LOCKED means another connection has the table/rows locked
+    if error_code == SQLITE_BUSY_CODE or error_name == "SQLITE_BUSY":
+        return _create_sqlite_error(error, error_code, DeadlockError, "database busy")
+    if error_code == SQLITE_LOCKED_CODE or error_name == "SQLITE_LOCKED":
+        return _create_sqlite_error(error, error_code, DeadlockError, "database locked")
+    if "locked" in error_msg or "busy" in error_msg:
+        return _create_sqlite_error(error, error_code or 0, DeadlockError, "database locked")
+
+    # Query interruption (timeout-like behavior)
+    if error_code == SQLITE_INTERRUPT_CODE or error_name == "SQLITE_INTERRUPT":
+        return _create_sqlite_error(error, error_code, QueryTimeoutError, "query interrupted")
+    if "interrupt" in error_msg:
+        return _create_sqlite_error(error, error_code or 0, QueryTimeoutError, "query interrupted")
+
+    # Permission errors
+    if error_code == SQLITE_PERM_CODE or error_name == "SQLITE_PERM":
+        return _create_sqlite_error(error, error_code, PermissionDeniedError, "permission denied")
+    if error_code == SQLITE_READONLY_CODE or error_name == "SQLITE_READONLY":
+        return _create_sqlite_error(error, error_code, PermissionDeniedError, "database is read-only")
+    if "permission denied" in error_msg or "readonly" in error_msg:
+        return _create_sqlite_error(error, error_code or 0, PermissionDeniedError, "permission denied")
+
+    if not error_code:
+        if "unique constraint" in error_msg:
+            return _create_sqlite_error(error, 0, UniqueViolationError, "unique constraint violation")
+        if "foreign key constraint" in error_msg:
+            return _create_sqlite_error(error, 0, ForeignKeyViolationError, "foreign key constraint violation")
+        if "not null constraint" in error_msg:
+            return _create_sqlite_error(error, 0, NotNullViolationError, "not-null constraint violation")
+        if "check constraint" in error_msg:
+            return _create_sqlite_error(error, 0, CheckViolationError, "check constraint violation")
+        if "syntax" in error_msg:
+            return _create_sqlite_error(error, None, SQLParsingError, "SQL syntax error")
+        return _create_sqlite_error(error, None, SQLSpecError, "database error")
+
+    # Constraint violations (check extended error codes first)
+    if error_code == SQLITE_CONSTRAINT_UNIQUE_CODE or error_name == "SQLITE_CONSTRAINT_UNIQUE":
+        return _create_sqlite_error(error, error_code, UniqueViolationError, "unique constraint violation")
+    if error_code == SQLITE_CONSTRAINT_FOREIGNKEY_CODE or error_name == "SQLITE_CONSTRAINT_FOREIGNKEY":
+        return _create_sqlite_error(error, error_code, ForeignKeyViolationError, "foreign key constraint violation")
+    if error_code == SQLITE_CONSTRAINT_NOTNULL_CODE or error_name == "SQLITE_CONSTRAINT_NOTNULL":
+        return _create_sqlite_error(error, error_code, NotNullViolationError, "not-null constraint violation")
+    if error_code == SQLITE_CONSTRAINT_CHECK_CODE or error_name == "SQLITE_CONSTRAINT_CHECK":
+        return _create_sqlite_error(error, error_code, CheckViolationError, "check constraint violation")
+    if error_code == SQLITE_CONSTRAINT_CODE or error_name == "SQLITE_CONSTRAINT":
+        return _create_sqlite_error(error, error_code, IntegrityError, "integrity constraint violation")
+
+    # Connection/file errors
+    if error_code == SQLITE_CANTOPEN_CODE or error_name == "SQLITE_CANTOPEN":
+        return _create_sqlite_error(error, error_code, DatabaseConnectionError, "connection error")
+    if error_code == SQLITE_IOERR_CODE or error_name == "SQLITE_IOERR":
+        return _create_sqlite_error(error, error_code, OperationalError, "operational error")
+
+    # Data type errors
+    if error_code == SQLITE_MISMATCH_CODE or error_name == "SQLITE_MISMATCH":
+        return _create_sqlite_error(error, error_code, DataError, "data error")
+
+    # SQL syntax errors
+    if error_code == 1 or "syntax" in error_msg:
+        return _create_sqlite_error(error, error_code, SQLParsingError, "SQL syntax error")
+
+    return _create_sqlite_error(error, error_code, SQLSpecError, "database error")
+
+
+def build_profile() -> "DriverParameterProfile":
+    """Create the SQLite driver parameter profile."""
+
+    return DriverParameterProfile(
+        name="SQLite",
+        default_style=ParameterStyle.QMARK,
+        supported_styles={ParameterStyle.QMARK, ParameterStyle.NAMED_COLON},
+        default_execution_style=ParameterStyle.QMARK,
+        supported_execution_styles={ParameterStyle.QMARK, ParameterStyle.NAMED_COLON},
+        has_native_list_expansion=False,
+        preserve_parameter_format=True,
+        needs_static_script_compilation=False,
+        allow_mixed_parameter_styles=False,
+        preserve_original_params_for_many=False,
+        json_serializer_strategy="helper",
+        custom_type_coercions={
+            bool: _bool_to_int,
+            datetime: _TIME_TO_ISO,
+            date: _TIME_TO_ISO,
+            Decimal: _DECIMAL_TO_STRING,
+            **build_uuid_coercions(),
+        },
+        default_dialect="sqlite",
+    )
+
+
+driver_profile = build_profile()
+
+
+def build_statement_config(
+    *, json_serializer: "Callable[[Any], str] | None" = None, json_deserializer: "Callable[[str], Any] | None" = None
+) -> "StatementConfig":
+    """Construct the SQLite statement configuration with optional JSON codecs."""
+    serializer = json_serializer or to_json
+    deserializer = json_deserializer or from_json
+    profile = driver_profile
+    return build_statement_config_from_profile(
+        profile,
+        statement_overrides={"dialect": "sqlite", "enable_parameter_type_wrapping": False},
+        json_serializer=serializer,
+        json_deserializer=deserializer,
+    )
+
+
+default_statement_config = build_statement_config()
+
+
+def apply_driver_features(
+    statement_config: "StatementConfig", driver_features: "Mapping[str, Any] | None"
+) -> "tuple[StatementConfig, dict[str, Any]]":
+    """Apply SQLite driver feature defaults to statement config."""
+    features: dict[str, Any] = dict(driver_features) if driver_features else {}
+    features.setdefault("enable_custom_adapters", True)
+    json_serializer = features.setdefault("json_serializer", to_json)
+    json_deserializer = features.setdefault("json_deserializer", from_json)
+
+    if json_serializer is not None:
+        parameter_config = statement_config.parameter_config.with_json_serializers(
+            json_serializer, deserializer=json_deserializer
+        )
+        statement_config = statement_config.replace(parameter_config=parameter_config)
+
+    return statement_config, features