asyncmy

Async MySQL driver.

Configuration

class sqlspec.adapters.asyncmy.AsyncmyConfig

Bases: AsyncDatabaseConfig[Connection, AsyncmyPool, AsyncmyDriver]

Configuration for Asyncmy database connections.

Example:

config = AsyncmyConfig(
    connection_config=AsyncmyPoolParams(
        host="localhost", user="root", database="mydb"
    )
)

driver_type

alias of AsyncmyDriver

__init__(*, connection_config=None, connection_instance=None, migration_config=None, statement_config=None, driver_features=None, bind_key=None, extension_config=None, observability_config=None, **kwargs)

Initialize Asyncmy configuration.

Parameters:

• connection_config -- Connection and pool configuration parameters

• connection_instance -- Existing pool instance to use

• migration_config -- Migration configuration

• statement_config -- Statement configuration override

• driver_features -- Driver feature configuration (TypedDict or dict)

• bind_key -- Optional unique identifier for this 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

async close_pool()

Close the connection pool.

Return type:

None

async create_connection()

Create a single async connection (not from pool).

Return type:

Connection

Returns:

An Asyncmy connection instance.

async provide_pool(*args, **kwargs)

Provide async pool instance.

Return type:

Pool

Returns:

The async connection pool.

get_signature_namespace()

Get the signature namespace for Asyncmy types.

Return type:

dict[str, typing.Any]

Returns:

Dictionary mapping type names to types.

get_event_runtime_hints()

Return queue polling defaults for Asyncmy adapters.

Return type:

EventRuntimeHints

Driver

class sqlspec.adapters.asyncmy.AsyncmyDriver

Bases: AsyncDriverAdapterBase

MySQL/MariaDB database driver using AsyncMy client library.

Implements asynchronous database operations for MySQL and MariaDB servers with support for parameter style conversion, type coercion, error handling, and transaction management.

__init__(connection, statement_config=None, driver_features=None)

Initialize driver adapter with connection and configuration.

Parameters:

• connection (Connection) -- Database connection instance

• statement_config (StatementConfig | None) -- Statement configuration for the driver

• driver_features (dict[str, typing.Any] | None) -- Driver-specific features like extensions, secrets, and connection callbacks

• observability -- Optional runtime handling lifecycle hooks, observers, and spans

async dispatch_execute(cursor, statement)

Execute single SQL statement.

Handles parameter processing, result fetching, and data transformation for MySQL/MariaDB operations.

Parameters:

• cursor (Any) -- AsyncMy cursor object

• statement (SQL) -- SQL statement to execute

Returns:

Statement execution results with data or row counts

Return type:

ExecutionResult

async dispatch_execute_many(cursor, statement)

Execute SQL statement with multiple parameter sets.

Uses AsyncMy's executemany for batch operations with MySQL type conversion and parameter processing.

Parameters:

• cursor (Any) -- AsyncMy cursor object

• statement (SQL) -- SQL statement with multiple parameter sets

Returns:

Batch execution results

Return type:

ExecutionResult

Raises:

ValueError -- If no parameters provided for executemany operation

async dispatch_execute_script(cursor, statement)

Execute SQL script with statement splitting and parameter handling.

Splits multi-statement scripts and executes each statement sequentially. Parameters are embedded as static values for script execution compatibility.

Parameters:

• cursor (Any) -- AsyncMy cursor object

• statement (SQL) -- SQL script to execute

Returns:

Script execution results with statement count

Return type:

ExecutionResult

async begin()

Begin a database transaction.

Explicitly starts a MySQL transaction to ensure proper transaction boundaries.

Raises:

SQLSpecError -- If transaction initialization fails

Return type:

None

async commit()

Commit the current transaction.

Raises:

SQLSpecError -- If transaction commit fails

Return type:

None

async rollback()

Rollback the current transaction.

Raises:

SQLSpecError -- If transaction rollback fails

Return type:

None

with_cursor(connection)

Create cursor context manager for the connection.

Parameters:

connection (Connection) -- AsyncMy database connection

Returns:

Context manager for cursor operations

Return type:

AsyncmyCursor

handle_database_exceptions()

Provide exception handling context manager.

Returns:

Context manager for AsyncMy exception handling

Return type:

AsyncmyExceptionHandler

async select_to_storage(statement, destination, /, *parameters, statement_config=None, partitioner=None, format_hint=None, telemetry=None, **kwargs)

Execute a query and stream Arrow-formatted results into storage.

Return type:

StorageBridgeJob

async load_from_arrow(table, source, *, partitioner=None, overwrite=False, telemetry=None)

Load Arrow data into MySQL using batched inserts.

Return type:

StorageBridgeJob

async load_from_storage(table, source, *, file_format, partitioner=None, overwrite=False)

Load staged artifacts from storage into MySQL.

Return type:

StorageBridgeJob

property data_dictionary: AsyncmyDataDictionary

Get the data dictionary for this driver.

Returns:

Data dictionary instance for metadata queries

collect_rows(cursor, fetched)

Collect asyncmy rows for the direct execution path.

Return type:

tuple[list[typing.Any], list[str], int]

resolve_rowcount(cursor)

Resolve rowcount from asyncmy cursor for the direct execution path.

Return type:

int

Data Dictionary

class sqlspec.adapters.asyncmy.data_dictionary.AsyncmyDataDictionary

Bases: AsyncDataDictionaryBase

MySQL-specific async data dictionary.

dialect: ClassVar[str] = 'mysql'

Dialect identifier. Must be defined by subclasses as a class attribute.

__init__()

async get_version(driver)

Get MySQL database version information.

Return type:

VersionInfo | None

async get_feature_flag(driver, feature)

Check if MySQL database supports a specific feature.

Return type:

bool

async get_optimal_type(driver, type_category)

Get optimal MySQL type for a category.

Return type:

str

async get_tables(driver, schema=None)

Get tables sorted by topological dependency order using the MySQL catalog.

Return type:

list[TableMetadata]

async get_columns(driver, table=None, schema=None)

Get column information for a table or schema.

Return type:

list[ColumnMetadata]

async get_indexes(driver, table=None, schema=None)

Get index metadata for a table or schema.

Return type:

list[IndexMetadata]

async get_foreign_keys(driver, table=None, schema=None)

Get foreign key metadata.

Return type:

list[ForeignKeyMetadata]