Padrões assíncronos com mssql-python

O driver mssql-python usa I/O síncrona e não oferece suporte nativo async/await . O suporte assíncrono nativo está no roadmap do driver. Até lá, você pode integrar mssql-python com aplicações assíncronas usando estes padrões alternativos:

Executores de pool de threads para descarregar chamadas bloqueadoras.
Encapsulamentos assíncronos para operações síncronas.
Integração com frameworks assíncronos como o FastAPI.

Note

Os padrões deste artigo usam ThreadPoolExecutor para executar chamadas síncronas do mssql-python em threads de segundo plano. Essa abordagem adiciona sobrecarga de threads em comparação com drivers assíncronos nativos. Para cargas de trabalho de banco de dados limitadas por I/O, a sobrecarga geralmente é aceitável.

Quando usar padrões assíncronos

A abordagem de pool de threads funciona bem quando:

Seu aplicativo já usa asyncio (por exemplo, FastAPI, aiohttp ou bots do Discord) e você precisa integrar chamadas de banco de dados sem bloquear o ciclo de eventos.
Consultas ao banco de dados são limitadas por I/O, não por CPU. O pool de threads permite que o ciclo de eventos gerencie outras requisições enquanto espera pelo Microsoft SQL.
Você tem concorrência moderada (dezenas de consultas simultâneas, não milhares).

Para aplicações puramente síncronas, pule esses padrões. Use o driver diretamente com código síncrono para execução direta e com menor overhead.

Padrão executor de pool de threads

Os exemplos a seguir mostram como envolver chamadas síncronas mssql-python em um ThreadPoolExecutor para uso com asyncio.

Encapsulador assíncrono básico

Crie uma função auxiliar simples que execute operações síncronas mssql-python no pool de threads e aguarde o resultado.

import asyncio
from concurrent.futures import ThreadPoolExecutor
import mssql_python
from functools import partial
from typing import Any, Callable

# Create a dedicated thread pool for database operations
db_executor = ThreadPoolExecutor(max_workers=10, thread_name_prefix="db_")

async def run_in_executor(func: Callable, *args, **kwargs) -> Any:
    """Run a synchronous function in the thread pool."""
    loop = asyncio.get_running_loop()
    if kwargs:
        func = partial(func, **kwargs)
    return await loop.run_in_executor(db_executor, func, *args)

# Database functions
def _execute_query(connection_string: str, query: str, params: dict = None) -> list:
    """Synchronous query execution."""
    conn = mssql_python.connect(connection_string)
    cursor = conn.cursor()
    try:
        cursor.execute(query, params or {})
        if cursor.description:
            columns = [col[0] for col in cursor.description]
            return [dict(zip(columns, row)) for row in cursor.fetchall()]
        return []
    finally:
        cursor.close()
        conn.close()

def _execute_scalar(connection_string: str, query: str, params: dict = None) -> Any:
    """Synchronous scalar query."""
    conn = mssql_python.connect(connection_string)
    cursor = conn.cursor()
    try:
        cursor.execute(query, params or {})
        return cursor.fetchval()
    finally:
        cursor.close()
        conn.close()

# Async interfaces
async def async_query(connection_string: str, query: str, params: dict = None) -> list:
    """Execute query asynchronously."""
    return await run_in_executor(_execute_query, connection_string, query, params)

async def async_scalar(connection_string: str, query: str, params: dict = None) -> Any:
    """Execute scalar query asynchronously."""
    return await run_in_executor(_execute_scalar, connection_string, query, params)

# Usage
async def main():
    conn_str = "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes"
    
    # Execute query asynchronously
    products = await async_query(conn_str, "SELECT * FROM Production.Product WHERE ProductSubcategoryID = %(cat)s", {"cat": 5})
    print(f"Found {len(products)} products")
    
    # Execute scalar asynchronously
    count = await async_scalar(conn_str, "SELECT COUNT(*) FROM Production.Product")
    print(f"Total products: {count}")

asyncio.run(main())

Note

Esse exemplo aguarda as duas consultas uma após a outra, para que elas sejam executadas sequencialmente. A await palavra-chave libera o ciclo de eventos para executar outras tarefas enquanto cada consulta espera, mas não sobrepõe essas duas consultas entre si. Para executar consultas independentes ao mesmo tempo, agende-as junto com asyncio.gather, conforme mostrado na seção do pool de conexões assíncronas :

products, count = await asyncio.gather(
    async_query(conn_str, "SELECT * FROM Production.Product WHERE ProductSubcategoryID = %(cat)s", {"cat": 5}),
    async_scalar(conn_str, "SELECT COUNT(*) FROM Production.Product"),
)

Pool de conexão assíncrona

Esta seção mostra como criar um wrapper compatível com operações assíncronas sobre o pool de conexões integrado do mssql-python para uso em aplicações asyncio.

Note

O driver mssql-python inclui pool de conexões integrado. O pool assíncrono mostrado aqui envolve conexões pooled síncronas com gerentes de contexto assíncronos para uso em asyncio aplicações. Você não precisa gerenciar um pool personalizado se estiver chamando apenas mssql-python a partir de um executor de pool de threads.

Classe de banco de dados assíncrono em pool

Construa uma classe de pool de conexões assíncronas reutilizável que gerencie uma fila de conexões mssql-python e forneça métodos assíncronos para execução de consultas.

import asyncio
from concurrent.futures import ThreadPoolExecutor
from contextlib import asynccontextmanager
from typing import Any, Optional
import mssql_python
from dataclasses import dataclass
from queue import Queue, Empty
import threading

@dataclass
class PooledConnection:
    """Wrapper for pooled connection."""
    connection: Any
    cursor: Any
    in_use: bool = False

class AsyncDatabasePool:
    """Async-friendly connection pool for mssql-python."""
    
    def __init__(self, connection_string: str, pool_size: int = 10):
        self.connection_string = connection_string
        self.pool_size = pool_size
        self._pool: Queue[PooledConnection] = Queue(maxsize=pool_size)
        self._executor = ThreadPoolExecutor(max_workers=pool_size, thread_name_prefix="dbpool_")
        self._lock = threading.Lock()
        self._initialized = False
    
    async def initialize(self):
        """Initialize the connection pool."""
        if self._initialized:
            return
        
        loop = asyncio.get_running_loop()
        
        async def create_connection():
            def _create():
                conn = mssql_python.connect(self.connection_string)
                cursor = conn.cursor()
                return PooledConnection(connection=conn, cursor=cursor)
            return await loop.run_in_executor(self._executor, _create)
        
        # Create initial connections
        tasks = [create_connection() for _ in range(self.pool_size)]
        connections = await asyncio.gather(*tasks)
        
        for conn in connections:
            self._pool.put(conn)
        
        self._initialized = True
    
    async def acquire(self, timeout: float = 30.0) -> PooledConnection:
        """Acquire a connection from the pool."""
        loop = asyncio.get_running_loop()
        
        def _acquire():
            try:
                conn = self._pool.get(timeout=timeout)
                conn.in_use = True
                return conn
            except Empty:
                raise TimeoutError("Could not acquire connection from pool")
        
        return await loop.run_in_executor(self._executor, _acquire)
    
    def release(self, conn: PooledConnection):
        """Release a connection back to the pool."""
        conn.in_use = False
        try:
            conn.connection.commit()
        except Exception:
            conn.connection.rollback()
        self._pool.put(conn)
    
    @asynccontextmanager
    async def connection(self):
        """Async context manager for getting a connection."""
        conn = await self.acquire()
        try:
            yield conn
        except Exception:
            conn.connection.rollback()
            raise
        else:
            conn.connection.commit()
        finally:
            self.release(conn)
    
    async def execute(self, query: str, params: dict = None) -> list:
        """Execute query and return results."""
        async with self.connection() as conn:
            loop = asyncio.get_running_loop()
            
            def _execute():
                conn.cursor.execute(query, params or {})
                if conn.cursor.description:
                    columns = [col[0] for col in conn.cursor.description]
                    return [dict(zip(columns, row)) for row in conn.cursor.fetchall()]
                return []
            
            return await loop.run_in_executor(self._executor, _execute)
    
    async def execute_scalar(self, query: str, params: dict = None) -> Any:
        """Execute query and return single value."""
        async with self.connection() as conn:
            loop = asyncio.get_running_loop()
            
            def _execute():
                conn.cursor.execute(query, params or {})
                return conn.cursor.fetchval()
            
            return await loop.run_in_executor(self._executor, _execute)
    
    async def close(self):
        """Close all connections in the pool."""
        while not self._pool.empty():
            try:
                conn = self._pool.get_nowait()
                conn.cursor.close()
                conn.connection.close()
            except Empty:
                break
        
        self._executor.shutdown(wait=True)

# Usage
async def main():
    pool = AsyncDatabasePool("Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes", pool_size=5)
    await pool.initialize()
    
    try:
        # Execute queries concurrently
        tasks = [
            pool.execute("SELECT * FROM Production.Product WHERE ProductSubcategoryID = %(cat)s", {"cat": i})
            for i in range(1, 6)
        ]
        results = await asyncio.gather(*tasks)
        
        for i, products in enumerate(results, 1):
            print(f"Category {i}: {len(products)} products")
        
        # Single scalar query
        total = await pool.execute_scalar("SELECT COUNT(*) FROM Production.Product")
        print(f"Total: {total}")
    finally:
        await pool.close()

# Only run the demo when this file is executed directly, not when imported.
if __name__ == "__main__":
    asyncio.run(main())

Integração com o FastAPI

O gerenciador de contexto do lifespan FastAPI gerencia automaticamente a inicialização e limpeza do pool.

FastAPI assíncrona com mssql-python

Este exemplo se baseia na seção do pool de conexões assíncronas . Salve o código dessa seção em um arquivo chamado db.py, e então crie o seguinte aplicativo FastAPI em um arquivo nomeado main.py ao lado. O exemplo do pool protege sua demonstração com if __name__ == "__main__":, então importar db.py não executa a demonstração. Este aplicativo usa o gerenciador de contexto lifespan para inicializar o pool durante a inicialização e limpar o pool no encerramento.

from fastapi import FastAPI, Depends, HTTPException
from contextlib import asynccontextmanager
from typing import Optional
import asyncio

from db import AsyncDatabasePool  # The pool class from the previous section

# Initialize pool on startup
pool: Optional[AsyncDatabasePool] = None

@asynccontextmanager
async def lifespan(app: FastAPI):
    """Manage database pool lifecycle."""
    global pool
    pool = AsyncDatabasePool(
        "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes",
        pool_size=10
    )
    await pool.initialize()
    yield
    await pool.close()

app = FastAPI(lifespan=lifespan)

async def get_db():
    """Dependency for database access."""
    return pool

@app.get("/products")
async def list_products(db: AsyncDatabasePool = Depends(get_db)):
    products = await db.execute("SELECT ProductID, Name, ListPrice FROM Production.Product")
    return {"products": products}

@app.get("/products/{product_id}")
async def get_product(product_id: int, db: AsyncDatabasePool = Depends(get_db)):
    products = await db.execute(
        "SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID = %(id)s",
        {"id": product_id}
    )
    if not products:
        raise HTTPException(status_code=404, detail="Product not found")
    return products[0]

@app.get("/stats")
async def get_stats(db: AsyncDatabasePool = Depends(get_db)):
    # Execute multiple queries concurrently
    product_count, subcategory_count, total_value = await asyncio.gather(
        db.execute_scalar("SELECT COUNT(*) FROM Production.Product"),
        db.execute_scalar("SELECT COUNT(*) FROM Production.ProductSubcategory"),
        db.execute_scalar("SELECT SUM(ListPrice) FROM Production.Product"),
    )
    
    return {
        "products": product_count,
        "subcategories": subcategory_count,
        "total_value": float(total_value) if total_value else 0
    }

Instale as dependências e execute o app com um servidor ASGI como o Uvicorn. Execute este comando a partir da pasta que contém main.py e db.py:

pip install fastapi uvicorn mssql-python
uvicorn main:app --reload

Com o servidor em execução, abra http://127.0.0.1:8000/products, http://127.0.0.1:8000/products/1 ou http://127.0.0.1:8000/stats para chamar cada endpoint.

Tarefas em segundo plano

Execute operações periódicas de banco de dados em um cronograma sem bloquear o ciclo de eventos da aplicação.

Trabalhador em segundo plano assíncrono

Implemente um executor de tarefas que execute operações registradas no banco de dados em intervalos especificados, prevenindo execuções simultâneas duplicadas. Este exemplo se baseia na seção do pool de conexões assíncronas , então salve o código dessa seção como db.py. Depois, salve o código a seguir como worker.py ao lado dele. Ele configura o registro para que cada execução reporte seu resultado.

import asyncio
from typing import Callable, Any
from dataclasses import dataclass
from datetime import datetime
import logging

from db import AsyncDatabasePool  # The pool class from the Async connection pool section

logger = logging.getLogger(__name__)

@dataclass
class Task:
    """Background task definition."""
    name: str
    func: Callable
    interval: float  # seconds
    last_run: datetime = None
    running: bool = False

class AsyncTaskRunner:
    """Run database tasks in the background."""
    
    def __init__(self, pool: AsyncDatabasePool):
        self.pool = pool
        self.tasks: dict[str, Task] = {}
        self._running = False
    
    def register(self, name: str, func: Callable, interval: float):
        """Register a periodic task."""
        self.tasks[name] = Task(name=name, func=func, interval=interval)
    
    async def _run_task(self, task: Task):
        """Execute a single task."""
        if task.running:
            return
        
        task.running = True
        try:
            await task.func(self.pool)
            task.last_run = datetime.now()
            logger.info(f"Task {task.name} completed")
        except Exception as e:
            logger.error(f"Task {task.name} failed: {e}")
        finally:
            task.running = False
    
    async def start(self):
        """Start the task runner."""
        self._running = True
        
        while self._running:
            now = datetime.now()
            
            for task in self.tasks.values():
                if task.last_run is None or \
                   (now - task.last_run).total_seconds() >= task.interval:
                    asyncio.create_task(self._run_task(task))
            
            await asyncio.sleep(1)  # Check every second
    
    def stop(self):
        """Stop the task runner."""
        self._running = False

# Example tasks
async def count_products(pool: AsyncDatabasePool):
    """Read-only task: report the current product count."""
    total = await pool.execute_scalar("SELECT COUNT(*) FROM Production.Product")
    logger.info("count_products: %s products", total)

async def check_low_inventory(pool: AsyncDatabasePool):
    """Report how many products are below an inventory threshold."""
    rows = await pool.execute(
        """
        SELECT ProductID, LocationID, Quantity
        FROM Production.ProductInventory
        WHERE Quantity < %(threshold)s
        """,
        {"threshold": 100},
    )
    logger.info("check_low_inventory: %s rows below threshold", len(rows))

# Usage
async def main():
    logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")

    pool = AsyncDatabasePool(
        "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes",
        pool_size=3,
    )
    await pool.initialize()

    runner = AsyncTaskRunner(pool)
    runner.register("count_products", count_products, interval=2)
    runner.register("low_inventory", check_low_inventory, interval=3)

    # Run the runner in the background, let it cycle a few times, then stop.
    # In a real app, run the runner for the application's lifetime instead,
    # for example from a FastAPI lifespan handler.
    runner_task = asyncio.create_task(runner.start())
    await asyncio.sleep(7)
    runner.stop()
    await runner_task
    await pool.close()

if __name__ == "__main__":
    asyncio.run(main())

Execute o trabalhador:

python worker.py

Cada tarefa registrada registra quando é executada, então você vê a saída repetida a cada poucos segundos:

2026-07-17 15:07:25 INFO count_products: 504 products
2026-07-17 15:07:25 INFO Task count_products completed
2026-07-17 15:07:26 INFO check_low_inventory: 179 rows below threshold
2026-07-17 15:07:26 INFO Task low_inventory completed

Execução simultânea de consultas

Use asyncio.gather com um semáforo para limitar o número de consultas em execução simultaneamente. Os exemplos desta seção baseiam-se na seção Pool de conexões assíncronas, então salve o código dessa seção como db.py e execute cada exemplo em seu próprio arquivo ao lado dele.

Consultas paralelas com semáforo

Execute múltiplas consultas simultaneamente usando um semáforo para limitar o número de operações simultâneas, evitando a saturação do pool de threads.

import asyncio

from db import AsyncDatabasePool  # The pool class from the Async connection pool section

async def parallel_queries(pool: AsyncDatabasePool, queries: list[tuple[str, dict]],
                          max_concurrent: int = 5) -> list:
    """Execute multiple queries with concurrency limit."""
    semaphore = asyncio.Semaphore(max_concurrent)

    async def run_query(query: str, params: dict):
        async with semaphore:
            return await pool.execute(query, params)

    tasks = [run_query(q, p) for q, p in queries]
    return await asyncio.gather(*tasks)

# Usage
async def main():
    pool = AsyncDatabasePool(
        "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes",
        pool_size=5,
    )
    await pool.initialize()
    try:
        queries = [
            ("SELECT * FROM Production.Product WHERE ProductSubcategoryID = %(cat)s", {"cat": 1}),
            ("SELECT * FROM Production.Product WHERE ProductSubcategoryID = %(cat)s", {"cat": 2}),
            ("SELECT * FROM Sales.SalesOrderHeader WHERE Status = %(status)s", {"status": 5}),
            ("SELECT * FROM Sales.Customer WHERE TerritoryID = %(territory)s", {"territory": 1}),
        ]

        results = await parallel_queries(pool, queries, max_concurrent=3)

        for i, rows in enumerate(results, 1):
            print(f"Query {i}: {len(rows)} rows")
    finally:
        await pool.close()

if __name__ == "__main__":
    asyncio.run(main())

Cada consulta é executada simultaneamente, e a saída informa quantas linhas cada uma retornou:

Query 1: 32 rows
Query 2: 43 rows
Query 3: 31465 rows
Query 4: 3520 rows

Para carregar grandes volumes de linhas, não recorra à concorrência. Use menos viagens de ida e volta, como descrito na cópia em massa.

Streaming de grandes resultados

Obter linhas de grandes conjuntos de resultados usando OFFSET/FETCH paginação para manter o uso de memória limitado. Este exemplo se baseia na seção do pool de conexões assíncronas , então salve o código dessa seção como db.py e execute este exemplo ao lado.

Gerador assíncrono para grandes conjuntos de dados

Implemente uma função geradora assíncrona que busque páginas de resultados sob demanda, permitindo que os chamadores iterem sobre grandes conjuntos de dados sem carregar tudo na memória.

import asyncio

from db import AsyncDatabasePool  # The pool class from the Async connection pool section

async def stream_results(pool: AsyncDatabasePool, query: str,
                        params: dict = None, chunk_size: int = 1000):
    """Stream query results as async generator."""
    offset = 0

    while True:
        paged_query = f"""
            {query}
            ORDER BY (SELECT NULL)
            OFFSET %(offset)s ROWS
            FETCH NEXT %(limit)s ROWS ONLY
        """
        chunk_params = {**(params or {}), "offset": offset, "limit": chunk_size}

        results = await pool.execute(paged_query, chunk_params)

        if not results:
            break

        for row in results:
            yield row

        offset += chunk_size

        # Allow event loop to process other tasks
        await asyncio.sleep(0)

# Usage
async def main():
    pool = AsyncDatabasePool(
        "Server=<server>.database.windows.net;Database=<database>;Authentication=ActiveDirectoryDefault;Encrypt=yes",
        pool_size=5,
    )
    await pool.initialize()
    try:
        processed = 0
        async for order in stream_results(
            pool, "SELECT SalesOrderID FROM Sales.SalesOrderHeader", chunk_size=500
        ):
            processed += 1
        print(f"Streamed {processed} orders in chunks of 500.")
    finally:
        await pool.close()

if __name__ == "__main__":
    asyncio.run(main())

O gerador busca uma página por vez, então a memória permanece limitada não importa o tamanho do conjunto de resultados:

Streamed 31465 orders in chunks of 500.

Práticas recomendadas

Aplique essas diretrizes para manter os padrões assíncronos seguros e eficientes.

Dimensionamento correto do executor

Dimensione o pool de threads de acordo com cargas de trabalho limitadas por E/S, e não apenas com base no número de CPUs.

import os

# Rule of thumb: 2-4x CPU cores for I/O-bound database work
cpu_count = os.cpu_count() or 4
pool_size = cpu_count * 2

db_executor = ThreadPoolExecutor(max_workers=pool_size)

Desligamento normal

Pare o agendador de tarefas, aguarde a conclusão do trabalho em andamento e, em seguida, feche o pool e o executor nessa ordem.

async def graceful_shutdown(pool: AsyncDatabasePool, runner: AsyncTaskRunner):
    """Gracefully shut down all async components."""
    # Stop accepting new tasks
    runner.stop()
    
    # Wait for running tasks to complete
    await asyncio.sleep(2)
    
    # Close database pool
    await pool.close()
    
    # Shutdown executor
    db_executor.shutdown(wait=True)

Tratamento de erros

Tente novamente apenas em falhas transitórias e recue com um atraso e jitter limitados. Reutilize o is_transient_error classificador da lógica de tentativas e da resiliência de conexão para que falhas permanentes como credenciais ruins ou erros de sintaxe falhem rápido, em vez de tentar novamente.

import asyncio
import random
import mssql_python

# Reuse is_transient_error() from the Retry logic article.

async def resilient_query(pool: AsyncDatabasePool, query: str,
                          params: dict = None, retries: int = 3,
                          base_delay: float = 1.0, max_delay: float = 30.0) -> list:
    """Execute a query, retrying only on transient failures."""
    for attempt in range(retries + 1):
        try:
            return await pool.execute(query, params)
        except mssql_python.Error as e:
            if not is_transient_error(e) or attempt == retries:
                raise
            delay = min(base_delay * (2 ** attempt), max_delay)
            delay *= 0.5 + random.random()  # Add jitter
            await asyncio.sleep(delay)

Comentários

Esta página foi útil?

Last updated on 2026-07-22

Padrões assíncronos com mssql-python

Quando usar padrões assíncronos

Padrão executor de pool de threads

Encapsulador assíncrono básico

Pool de conexão assíncrona

Classe de banco de dados assíncrono em pool

Integração com o FastAPI

FastAPI assíncrona com mssql-python

Tarefas em segundo plano

Trabalhador em segundo plano assíncrono

Execução simultânea de consultas

Consultas paralelas com semáforo

Streaming de grandes resultados

Gerador assíncrono para grandes conjuntos de dados

Práticas recomendadas

Dimensionamento correto do executor

Desligamento normal

Tratamento de erros

Conteúdo relacionado

Comentários

Recursos adicionais