sqlspec 0.36.0__cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl

sqlspec/adapters/pymysql/config.py

@@ -0,0 +1,195 @@
+"""PyMySQL database configuration."""
+
+from typing import TYPE_CHECKING, Any, ClassVar, TypedDict, cast
+
+from typing_extensions import NotRequired
+
+from sqlspec.adapters.pymysql._typing import PyMysqlConnection, PyMysqlSessionContext
+from sqlspec.adapters.pymysql.core import apply_driver_features, default_statement_config
+from sqlspec.adapters.pymysql.driver import PyMysqlCursor, PyMysqlDriver, PyMysqlExceptionHandler
+from sqlspec.adapters.pymysql.pool import PyMysqlConnectionPool
+from sqlspec.config import ExtensionConfigs, SyncDatabaseConfig
+from sqlspec.extensions.events import EventRuntimeHints
+from sqlspec.utils.config_tools import normalize_connection_config
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from sqlspec.core import StatementConfig
+    from sqlspec.observability import ObservabilityConfig
+
+__all__ = ("PyMysqlConfig", "PyMysqlConnectionParams", "PyMysqlDriverFeatures", "PyMysqlPoolParams")
+
+
+class PyMysqlConnectionParams(TypedDict):
+    """PyMySQL connection parameters."""
+
+    host: NotRequired[str]
+    user: NotRequired[str]
+    password: NotRequired[str]
+    database: NotRequired[str]
+    port: NotRequired[int]
+    unix_socket: NotRequired[str]
+    charset: NotRequired[str]
+    connect_timeout: NotRequired[int]
+    read_timeout: NotRequired[int]
+    write_timeout: NotRequired[int]
+    autocommit: NotRequired[bool]
+    ssl: NotRequired["dict[str, Any]"]
+    client_flag: NotRequired[int]
+    cursorclass: NotRequired[type]
+    init_command: NotRequired[str]
+    sql_mode: NotRequired[str]
+    extra: NotRequired["dict[str, Any]"]
+
+
+class PyMysqlPoolParams(PyMysqlConnectionParams):
+    """PyMySQL pool parameters."""
+
+    pool_recycle_seconds: NotRequired[int]
+    health_check_interval: NotRequired[float]
+
+
+class PyMysqlDriverFeatures(TypedDict):
+    """PyMySQL driver feature flags."""
+
+    json_serializer: NotRequired["Callable[[Any], str]"]
+    json_deserializer: NotRequired["Callable[[str], Any]"]
+    enable_events: NotRequired[bool]
+    events_backend: NotRequired[str]
+
+
+class PyMysqlConnectionContext:
+    """Context manager for PyMySQL connections."""
+
+    __slots__ = ("_config", "_ctx")
+
+    def __init__(self, config: "PyMysqlConfig") -> None:
+        self._config = config
+        self._ctx: Any = None
+
+    def __enter__(self) -> PyMysqlConnection:
+        pool = self._config.provide_pool()
+        self._ctx = pool.get_connection()
+        return cast("PyMysqlConnection", self._ctx.__enter__())
+
+    def __exit__(
+        self, exc_type: "type[BaseException] | None", exc_val: "BaseException | None", exc_tb: Any
+    ) -> bool | None:
+        if self._ctx:
+            return cast("bool | None", self._ctx.__exit__(exc_type, exc_val, exc_tb))
+        return None
+
+
+class _PyMysqlSessionConnectionHandler:
+    __slots__ = ("_config", "_ctx")
+
+    def __init__(self, config: "PyMysqlConfig") -> None:
+        self._config = config
+        self._ctx: Any = None
+
+    def acquire_connection(self) -> "PyMysqlConnection":
+        pool = self._config.provide_pool()
+        self._ctx = pool.get_connection()
+        return cast("PyMysqlConnection", self._ctx.__enter__())
+
+    def release_connection(self, _conn: "PyMysqlConnection") -> None:
+        if self._ctx is None:
+            return
+        self._ctx.__exit__(None, None, None)
+        self._ctx = None
+
+
+class PyMysqlConfig(SyncDatabaseConfig[PyMysqlConnection, PyMysqlConnectionPool, PyMysqlDriver]):
+    """Configuration for PyMySQL synchronous connections."""
+
+    driver_type: "ClassVar[type[PyMysqlDriver]]" = PyMysqlDriver
+    connection_type: "ClassVar[type[PyMysqlConnection]]" = cast("type[PyMysqlConnection]", PyMysqlConnection)
+    supports_transactional_ddl: "ClassVar[bool]" = False
+    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
+
+    def __init__(
+        self,
+        *,
+        connection_config: "PyMysqlPoolParams | dict[str, Any] | None" = None,
+        connection_instance: "PyMysqlConnectionPool | None" = None,
+        migration_config: "dict[str, Any] | None" = None,
+        statement_config: "StatementConfig | None" = None,
+        driver_features: "PyMysqlDriverFeatures | dict[str, Any] | None" = None,
+        bind_key: "str | None" = None,
+        extension_config: "ExtensionConfigs | None" = None,
+        observability_config: "ObservabilityConfig | None" = None,
+        **kwargs: Any,
+    ) -> None:
+        connection_config = normalize_connection_config(connection_config)
+        connection_config.setdefault("host", "localhost")
+        connection_config.setdefault("port", 3306)
+
+        statement_config = statement_config or default_statement_config
+        statement_config, driver_features = apply_driver_features(statement_config, driver_features)
+
+        super().__init__(
+            connection_config=connection_config,
+            connection_instance=connection_instance,
+            migration_config=migration_config,
+            statement_config=statement_config,
+            driver_features=driver_features,
+            bind_key=bind_key,
+            extension_config=extension_config,
+            observability_config=observability_config,
+            **kwargs,
+        )
+
+    def _create_pool(self) -> "PyMysqlConnectionPool":
+        config = dict(self.connection_config)
+        pool_recycle = config.pop("pool_recycle_seconds", 86400)
+        health_check = config.pop("health_check_interval", 30.0)
+        extra = config.pop("extra", {})
+        config.update(extra)
+        return PyMysqlConnectionPool(config, recycle_seconds=pool_recycle, health_check_interval=health_check)
+
+    def _close_pool(self) -> None:
+        if self.connection_instance:
+            self.connection_instance.close()
+
+    def create_connection(self) -> PyMysqlConnection:
+        pool = self.provide_pool()
+        return pool.acquire()
+
+    def provide_connection(self, *args: Any, **kwargs: Any) -> "PyMysqlConnectionContext":
+        return PyMysqlConnectionContext(self)
+
+    def provide_session(
+        self, *_args: Any, statement_config: "StatementConfig | None" = None, **_kwargs: Any
+    ) -> "PyMysqlSessionContext":
+        handler = _PyMysqlSessionConnectionHandler(self)
+
+        return PyMysqlSessionContext(
+            acquire_connection=handler.acquire_connection,
+            release_connection=handler.release_connection,
+            statement_config=statement_config or self.statement_config or default_statement_config,
+            driver_features=self.driver_features,
+            prepare_driver=self._prepare_driver,
+        )
+
+    def get_signature_namespace(self) -> "dict[str, Any]":
+        namespace = super().get_signature_namespace()
+        namespace.update({
+            "PyMysqlConnectionContext": PyMysqlConnectionContext,
+            "PyMysqlConnection": PyMysqlConnection,
+            "PyMysqlConnectionParams": PyMysqlConnectionParams,
+            "PyMysqlConnectionPool": PyMysqlConnectionPool,
+            "PyMysqlCursor": PyMysqlCursor,
+            "PyMysqlDriver": PyMysqlDriver,
+            "PyMysqlDriverFeatures": PyMysqlDriverFeatures,
+            "PyMysqlExceptionHandler": PyMysqlExceptionHandler,
+            "PyMysqlPoolParams": PyMysqlPoolParams,
+            "PyMysqlSessionContext": PyMysqlSessionContext,
+        })
+        return namespace
+
+    def get_event_runtime_hints(self) -> "EventRuntimeHints":
+        return EventRuntimeHints(poll_interval=0.25, lease_seconds=5, select_for_update=True, skip_locked=True)

sqlspec/adapters/pymysql/core.py

@@ -0,0 +1,299 @@
+"""PyMySQL adapter compiled helpers."""
+
+from typing import TYPE_CHECKING, Any
+
+from sqlspec.core import DriverParameterProfile, ParameterStyle, StatementConfig, build_statement_config_from_profile
+from sqlspec.exceptions import (
+    CheckViolationError,
+    DatabaseConnectionError,
+    DataError,
+    ForeignKeyViolationError,
+    IntegrityError,
+    NotNullViolationError,
+    SQLParsingError,
+    SQLSpecError,
+    TransactionError,
+    UniqueViolationError,
+)
+from sqlspec.utils.serializers import from_json, to_json
+from sqlspec.utils.type_guards import has_cursor_metadata, has_lastrowid, has_rowcount, has_sqlstate, has_type_code
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Mapping, Sequence
+
+__all__ = (
+    "apply_driver_features",
+    "build_insert_statement",
+    "build_profile",
+    "build_statement_config",
+    "collect_rows",
+    "create_mapped_exception",
+    "default_statement_config",
+    "detect_json_columns",
+    "driver_profile",
+    "format_identifier",
+    "normalize_execute_many_parameters",
+    "normalize_execute_parameters",
+    "normalize_lastrowid",
+    "resolve_rowcount",
+)
+
+MYSQL_ER_DUP_ENTRY = 1062
+MYSQL_ER_NO_DEFAULT_FOR_FIELD = 1364
+MYSQL_ER_CHECK_CONSTRAINT_VIOLATED = 3819
+
+
+def _bool_to_int(value: bool) -> int:
+    return int(value)
+
+
+def _quote_mysql_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)
+    parts = [part for part in cleaned.split(".") if part]
+    formatted = ".".join(_quote_mysql_identifier(part) for part in parts)
+    return formatted or _quote_mysql_identifier(cleaned)
+
+
+def build_insert_statement(table: str, columns: "list[str]") -> str:
+    column_clause = ", ".join(_quote_mysql_identifier(column) for column in columns)
+    placeholders = ", ".join("%s" for _ in columns)
+    return f"INSERT INTO {format_identifier(table)} ({column_clause}) VALUES ({placeholders})"
+
+
+def normalize_execute_parameters(parameters: Any) -> Any:
+    """Normalize parameters for PyMySQL execute calls."""
+    return parameters or None
+
+
+def normalize_execute_many_parameters(parameters: Any) -> Any:
+    """Normalize parameters for PyMySQL executemany calls."""
+    if not parameters:
+        msg = "execute_many requires parameters"
+        raise ValueError(msg)
+    return parameters
+
+
+def build_profile() -> "DriverParameterProfile":
+    """Create the PyMySQL driver parameter profile."""
+
+    return DriverParameterProfile(
+        name="PyMySQL",
+        default_style=ParameterStyle.QMARK,
+        supported_styles={ParameterStyle.QMARK, ParameterStyle.POSITIONAL_PYFORMAT},
+        default_execution_style=ParameterStyle.POSITIONAL_PYFORMAT,
+        supported_execution_styles={ParameterStyle.POSITIONAL_PYFORMAT},
+        has_native_list_expansion=False,
+        preserve_parameter_format=True,
+        needs_static_script_compilation=True,
+        allow_mixed_parameter_styles=False,
+        preserve_original_params_for_many=False,
+        json_serializer_strategy="helper",
+        custom_type_coercions={bool: _bool_to_int},
+        default_dialect="mysql",
+    )
+
+
+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 PyMySQL 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": "mysql"}, 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 PyMySQL driver feature defaults to statement config."""
+    features: dict[str, Any] = dict(driver_features) if driver_features else {}
+    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
+
+
+def _create_mysql_error(
+    error: Any, sqlstate: "str | None", code: "int | None", error_class: type[SQLSpecError], description: str
+) -> SQLSpecError:
+    """Create a MySQL error instance without raising it."""
+    code_str = f"[{sqlstate or code}]" if sqlstate or code else ""
+    msg = f"MySQL {description} {code_str}: {error}" if code_str else f"MySQL {description}: {error}"
+    exc = error_class(msg)
+    exc.__cause__ = error
+    return exc
+
+
+def create_mapped_exception(error: Any, *, logger: Any | None = None) -> "SQLSpecError | bool":
+    """Map PyMySQL exceptions to SQLSpec errors.
+
+    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.
+
+    Args:
+        error: The PyMySQL exception to map
+        logger: Optional logger for migration warnings
+
+    Returns:
+        True to suppress expected migration errors, or a SQLSpec exception
+    """
+    error_code = error.args[0] if len(getattr(error, "args", [])) >= 1 and isinstance(error.args[0], int) else None
+    sqlstate = error.sqlstate if has_sqlstate(error) and error.sqlstate is not None else None
+
+    if error_code in {1061, 1091}:
+        if logger is not None:
+            logger.warning("PyMySQL expected migration error (ignoring): %s", error)
+        return True
+
+    if sqlstate == "23505" or error_code == MYSQL_ER_DUP_ENTRY:
+        return _create_mysql_error(error, sqlstate, error_code, UniqueViolationError, "unique constraint violation")
+    if sqlstate == "23503" or error_code in {1216, 1217, 1451, 1452}:
+        return _create_mysql_error(
+            error, sqlstate, error_code, ForeignKeyViolationError, "foreign key constraint violation"
+        )
+    if sqlstate == "23502" or error_code in {1048, MYSQL_ER_NO_DEFAULT_FOR_FIELD}:
+        return _create_mysql_error(error, sqlstate, error_code, NotNullViolationError, "not-null constraint violation")
+    if sqlstate == "23514" or error_code == MYSQL_ER_CHECK_CONSTRAINT_VIOLATED:
+        return _create_mysql_error(error, sqlstate, error_code, CheckViolationError, "check constraint violation")
+    if sqlstate and sqlstate.startswith("23"):
+        return _create_mysql_error(error, sqlstate, error_code, IntegrityError, "integrity constraint violation")
+    if sqlstate and sqlstate.startswith("42"):
+        return _create_mysql_error(error, sqlstate, error_code, SQLParsingError, "SQL syntax error")
+    if sqlstate and sqlstate.startswith("08"):
+        return _create_mysql_error(error, sqlstate, error_code, DatabaseConnectionError, "connection error")
+    if sqlstate and sqlstate.startswith("40"):
+        return _create_mysql_error(error, sqlstate, error_code, TransactionError, "transaction error")
+    if sqlstate and sqlstate.startswith("22"):
+        return _create_mysql_error(error, sqlstate, error_code, DataError, "data error")
+    if error_code in {2002, 2003, 2005, 2006, 2013}:
+        return _create_mysql_error(error, sqlstate, error_code, DatabaseConnectionError, "connection error")
+    if error_code in {1205, 1213}:
+        return _create_mysql_error(error, sqlstate, error_code, TransactionError, "transaction error")
+    if error_code in range(1064, 1100):
+        return _create_mysql_error(error, sqlstate, error_code, SQLParsingError, "SQL syntax error")
+    return _create_mysql_error(error, sqlstate, error_code, SQLSpecError, "database error")
+
+
+def detect_json_columns(cursor: Any, json_type_codes: "set[int]") -> "list[int]":
+    """Identify JSON column indexes from cursor metadata."""
+    if not has_cursor_metadata(cursor):
+        return []
+    description = cursor.description
+    if not description or not json_type_codes:
+        return []
+
+    json_indexes: list[int] = []
+    for index, column in enumerate(description):
+        if has_type_code(column):
+            type_code = column.type_code
+        elif isinstance(column, (tuple, list)) and len(column) > 1:
+            type_code = column[1]
+        else:
+            type_code = None
+        if type_code in json_type_codes:
+            json_indexes.append(index)
+    return json_indexes
+
+
+def _deserialize_pymysql_json_rows(
+    column_names: "list[str]",
+    rows: "list[dict[str, Any]]",
+    json_indexes: "list[int]",
+    deserializer: "Callable[[Any], Any]",
+    *,
+    logger: Any | None = None,
+) -> "list[dict[str, Any]]":
+    """Apply JSON deserialization to selected columns."""
+    if not rows or not column_names or not json_indexes:
+        return rows
+
+    target_columns = [column_names[index] for index in json_indexes if index < len(column_names)]
+    if not target_columns:
+        return rows
+
+    for row in rows:
+        for column in target_columns:
+            if column not in row:
+                continue
+            raw_value = row[column]
+            if raw_value is None:
+                continue
+            if isinstance(raw_value, bytearray):
+                raw_value = bytes(raw_value)
+            if not isinstance(raw_value, (str, bytes)):
+                continue
+            try:
+                row[column] = deserializer(raw_value)
+            except Exception:
+                if logger is not None:
+                    logger.debug("Failed to deserialize JSON column %s", column, exc_info=True)
+    return rows
+
+
+def collect_rows(
+    fetched_data: "Sequence[Any] | None",
+    description: "Sequence[Any] | None",
+    json_indexes: "list[int]",
+    deserializer: "Callable[[Any], Any]",
+    *,
+    logger: Any | None = None,
+) -> "tuple[list[dict[str, Any]], list[str]]":
+    """Collect PyMySQL rows into dictionaries with JSON decoding."""
+    if not description:
+        return [], []
+    column_names = [desc[0] for desc in description]
+    if not fetched_data:
+        return [], column_names
+    if not isinstance(fetched_data[0], dict):
+        rows = [dict(zip(column_names, row, strict=False)) for row in fetched_data]
+    else:
+        rows = [dict(row) for row in fetched_data]
+    rows = _deserialize_pymysql_json_rows(column_names, rows, json_indexes, deserializer, logger=logger)
+    return rows, column_names
+
+
+def resolve_rowcount(cursor: Any) -> int:
+    """Resolve rowcount from a PyMySQL cursor."""
+    if not has_rowcount(cursor):
+        return 0
+    rowcount = cursor.rowcount
+    if isinstance(rowcount, int) and rowcount >= 0:
+        return rowcount
+    return 0
+
+
+def normalize_lastrowid(cursor: Any) -> int | None:
+    """Normalize lastrowid for PyMySQL when rowcount indicates success."""
+    if not has_rowcount(cursor):
+        return None
+    rowcount = cursor.rowcount
+    if not isinstance(rowcount, int) or rowcount <= 0:
+        return None
+    if not has_lastrowid(cursor):
+        return None
+    last_id = cursor.lastrowid
+    return last_id if isinstance(last_id, int) else None

sqlspec/adapters/pymysql/data_dictionary.py

@@ -0,0 +1,122 @@
+"""MySQL-specific data dictionary for metadata queries via PyMySQL."""
+
+from typing import TYPE_CHECKING, ClassVar
+
+from mypy_extensions import mypyc_attr
+
+from sqlspec.driver import SyncDataDictionaryBase
+from sqlspec.typing import ColumnMetadata, ForeignKeyMetadata, IndexMetadata, TableMetadata, VersionInfo
+
+if TYPE_CHECKING:
+    from sqlspec.adapters.pymysql.driver import PyMysqlDriver
+
+__all__ = ("PyMysqlDataDictionary",)
+
+
+@mypyc_attr(allow_interpreted_subclasses=True, native_class=False)
+class PyMysqlDataDictionary(SyncDataDictionaryBase):
+    """MySQL-specific sync data dictionary."""
+
+    dialect: ClassVar[str] = "mysql"
+
+    def __init__(self) -> None:
+        super().__init__()
+
+    def get_version(self, driver: "PyMysqlDriver") -> "VersionInfo | None":
+        """Get MySQL database version information."""
+        driver_id = id(driver)
+        # Inline cache check to avoid cross-module method call that causes mypyc segfault
+        if driver_id in self._version_fetch_attempted:
+            return self._version_cache.get(driver_id)
+        # Not cached, fetch from database
+
+        version_value = driver.select_value_or_none(self.get_query("version"))
+        if not version_value:
+            self._log_version_unavailable(type(self).dialect, "missing")
+            self.cache_version(driver_id, None)
+            return None
+
+        version_info = self.parse_version_with_pattern(self.get_dialect_config().version_pattern, str(version_value))
+        if version_info is None:
+            self._log_version_unavailable(type(self).dialect, "parse_failed")
+            self.cache_version(driver_id, None)
+            return None
+
+        self._log_version_detected(type(self).dialect, version_info)
+        self.cache_version(driver_id, version_info)
+        return version_info
+
+    def get_feature_flag(self, driver: "PyMysqlDriver", feature: str) -> bool:
+        """Check if MySQL database supports a specific feature."""
+        version_info = self.get_version(driver)
+        return self.resolve_feature_flag(feature, version_info)
+
+    def get_optimal_type(self, driver: "PyMysqlDriver", type_category: str) -> str:
+        """Get optimal MySQL type for a category."""
+        config = self.get_dialect_config()
+        version_info = self.get_version(driver)
+
+        if type_category == "json":
+            json_version = config.get_feature_version("supports_json")
+            if version_info and json_version and version_info >= json_version:
+                return "JSON"
+            return "TEXT"
+
+        return config.get_optimal_type(type_category)
+
+    def get_tables(self, driver: "PyMysqlDriver", schema: "str | None" = None) -> "list[TableMetadata]":
+        """Get tables sorted by topological dependency order using the MySQL catalog."""
+        schema_name = self.resolve_schema(schema)
+        self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="tables")
+        return driver.select(self.get_query("tables_by_schema"), schema_name=schema_name, schema_type=TableMetadata)
+
+    def get_columns(
+        self, driver: "PyMysqlDriver", table: "str | None" = None, schema: "str | None" = None
+    ) -> "list[ColumnMetadata]":
+        """Get column information for a table or schema."""
+        schema_name = self.resolve_schema(schema)
+        if table is None:
+            self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="columns")
+            return driver.select(
+                self.get_query("columns_by_schema"), schema_name=schema_name, schema_type=ColumnMetadata
+            )
+
+        self._log_table_describe(driver, schema_name=schema_name, table_name=table, operation="columns")
+        return driver.select(
+            self.get_query("columns_by_table"), table_name=table, schema_name=schema_name, schema_type=ColumnMetadata
+        )
+
+    def get_indexes(
+        self, driver: "PyMysqlDriver", table: "str | None" = None, schema: "str | None" = None
+    ) -> "list[IndexMetadata]":
+        """Get index metadata for a table or schema."""
+        schema_name = self.resolve_schema(schema)
+        if table is None:
+            self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="indexes")
+            return driver.select(
+                self.get_query("indexes_by_schema"), schema_name=schema_name, schema_type=IndexMetadata
+            )
+
+        self._log_table_describe(driver, schema_name=schema_name, table_name=table, operation="indexes")
+        return driver.select(
+            self.get_query("indexes_by_table"), table_name=table, schema_name=schema_name, schema_type=IndexMetadata
+        )
+
+    def get_foreign_keys(
+        self, driver: "PyMysqlDriver", table: "str | None" = None, schema: "str | None" = None
+    ) -> "list[ForeignKeyMetadata]":
+        """Get foreign key metadata."""
+        schema_name = self.resolve_schema(schema)
+        if table is None:
+            self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="foreign_keys")
+            return driver.select(
+                self.get_query("foreign_keys_by_schema"), schema_name=schema_name, schema_type=ForeignKeyMetadata
+            )
+
+        self._log_table_describe(driver, schema_name=schema_name, table_name=table, operation="foreign_keys")
+        return driver.select(
+            self.get_query("foreign_keys_by_table"),
+            table_name=table,
+            schema_name=schema_name,
+            schema_type=ForeignKeyMetadata,
+        )