Executar consultas com mssql-python

O driver mssql-python fornece métodos de cursor para execução de consultas SQL, consultas parametrizadas, operações em lote e instruções preparadas.

Execução básica da consulta

Use o método execute() de um cursor para executar instruções SQL:

import mssql_python

conn = mssql_python.connect(connection_string)
cursor = conn.cursor()

cursor.execute("SELECT Name, ListPrice FROM Production.Product WHERE Color = 'Black'")
rows = cursor.fetchall()

for row in rows:
    print(row.Name, row.ListPrice)

cursor.close()
conn.close()

Consultas parametrizadas

Sempre use consultas parametrizadas para evitar a injeção de SQL. O estilo de parâmetros padrão do driver é pyformat (placeholders nomeados), mas ele também oferece suporte a qmark (placeholders posicionais). Use qmark para sequências de escape ODBC {CALL} .

Estilo pyformat (padrão)

Use marcadores nomeados com %(name)s sintaxe e passe um dicionário:

cursor.execute(
    "SELECT Name, ListPrice FROM Production.Product WHERE Color = %(color)s AND ListPrice > %(price)s",
    {"color": "Black", "price": 10.00}
)

Estilo Qmark

Use marcadores posicionais com ? e passe uma tupla ou lista:

cursor.execute(
    "SELECT Name, ListPrice FROM Production.Product WHERE ProductSubcategoryID = ? AND ListPrice > ?",
    (1, 10.00)
)

O driver detecta automaticamente o estilo de parâmetros com base na sua consulta SQL e nos tipos de parâmetro.

INSERT, UPDATE, DELETE operações

Para instruções de modificação de dados, use consultas parametrizadas e confirme a transação:

cursor.execute("CREATE TABLE #ExecDemo (Name NVARCHAR(50), CategoryID INT, Price DECIMAL(10,2))")
cursor.execute(
    "INSERT INTO #ExecDemo (Name, CategoryID, Price) VALUES (%(name)s, %(category)s, %(price)s)",
    {"name": "New Product", "category": 1, "price": 19.99}
)
conn.commit()

print(f"Rows affected: {cursor.rowcount}")

Execução em lote com executemany()

Use executemany() para inserir várias fileiras de forma eficiente. O driver usa vinculação de parâmetros por coluna para alto desempenho:

products = [
    {"name": "Product A", "category": 1, "price": 10.00},
    {"name": "Product B", "category": 1, "price": 15.00},
    {"name": "Product C", "category": 2, "price": 20.00},
]

cursor.execute("CREATE TABLE #BatchDemo (Name NVARCHAR(50), CategoryID INT, Price DECIMAL(10,2))")
cursor.executemany(
    "INSERT INTO #BatchDemo (Name, CategoryID, Price) VALUES (%(name)s, %(category)s, %(price)s)",
    products
)
conn.commit()

print(f"Rows inserted: {cursor.rowcount}")

Com o estilo qmark:

products = [
    ("Product A", 1, 10.00),
    ("Product B", 1, 15.00),
    ("Product C", 2, 20.00),
]

cursor.execute("CREATE TABLE #QmarkDemo (Name NVARCHAR(50), CategoryID INT, Price DECIMAL(10,2))")
cursor.executemany(
    "INSERT INTO #QmarkDemo (Name, CategoryID, Price) VALUES (?, ?, ?)",
    products
)
conn.commit()

Execução em lote em múltiplas instruções

Use batch_execute() na conexão para executar múltiplas instruções diferentes em uma única chamada:

results, cursor = conn.batch_execute(
    [
        "CREATE TABLE #BatchExec (Name NVARCHAR(50), CategoryID INT)",
        "INSERT INTO #BatchExec (Name, CategoryID) VALUES (%(name)s, %(cat)s)",
        "SELECT COUNT(*) FROM #BatchExec"
    ],
    [
        None,                                 # No params for CREATE
        {"name": "New Item", "cat": 1},       # Params for INSERT
        None                                  # No params for SELECT
    ]
)

print(f"CREATE result: {results[0]}")
print(f"INSERT affected: {results[1]} rows")
print(f"Row count: {results[2][0][0]}")

Instruções preparadas

O driver prepara consultas por padrão (use_prepare=True). Quando você executa a mesma string SQL várias vezes no mesmo cursor, o driver reutiliza automaticamente a instrução preparada em chamadas subsequentes:

# First execution prepares the statement
cursor.execute(
    "SELECT Name, ListPrice FROM Production.Product WHERE ProductSubcategoryID = %(subcategory_id)s",
    {"subcategory_id": 1},
)
rows1 = cursor.fetchall()

# Same SQL string on same cursor → driver reuses the prepared plan
cursor.execute(
    "SELECT Name, ListPrice FROM Production.Product WHERE ProductSubcategoryID = %(subcategory_id)s",
    {"subcategory_id": 2},
)
rows2 = cursor.fetchall()

Para pular a preparação e usar execução direta:

cursor.execute(
    "SELECT Name, ListPrice FROM Production.Product WHERE ProductSubcategoryID = 1",
    use_prepare=False  # Uses SQLExecDirectW instead of SQLPrepareW
)

Execução em nível de conexão

Para consultas simples e pontuais, use execute() diretamente na conexão:

# Creates cursor, executes, and returns cursor
cursor = conn.execute("SELECT TOP 10 Name, ListPrice FROM Production.Product")
rows = cursor.fetchall()
cursor.close()

Procedimentos armazenados

Chame procedimentos armazenados usando EXECUTE ou a sintaxe de escape ODBC {CALL} . Para informações sobre parâmetros de saída, múltiplos conjuntos de resultados e padrões de transação, veja Procedimentos armazenados.

cursor.execute(
    "EXECUTE dbo.uspGetManagerEmployees @BusinessEntityID = %(business_entity_id)s",
    {"business_entity_id": 16}
)
rows = cursor.fetchall()

Definir tamanhos de entrada

Use setinputsizes() para declarar explicitamente os tipos de parâmetros, o que pode melhorar o desempenho para operações em lote:

cursor.setinputsizes([
    (mssql_python.SQL_WVARCHAR, 50, 0),   # NVARCHAR(50)
    (mssql_python.SQL_INTEGER, 0, 0),     # INT
])

cursor.executemany(
    "SELECT ProductID, Name FROM Production.Product WHERE Name LIKE ? AND ProductSubcategoryID = ?",
    [("Road%", 2), ("Mountain%", 1)]
)

Tratamento de erros

Enrolar operações de banco de dados em blocos try-except:

try:
    cursor.execute("CREATE TABLE #ErrDemo (Name NVARCHAR(50) NOT NULL)")
    cursor.execute("INSERT INTO #ErrDemo (Name) VALUES (%(name)s)", {"name": None})
    conn.commit()
except mssql_python.IntegrityError as e:
    print(f"Constraint violation: {e}")
    conn.rollback()
except mssql_python.ProgrammingError as e:
    print(f"SQL error: {e}")
    conn.rollback()

Práticas recomendadas

1. Sempre use consultas parametrizadas para evitar a injeção de SQL.
2. Use cópia em massa para inserções em massa em vez de múltiplas chamadas execute().
3. Confirme explicitamente as transações ao desativar o autocommit.
4. Feche cursores e conexões quando terminado para liberar recursos.
5. Use gerentes de contexto para limpeza automática de recursos:

with mssql_python.connect(connection_string) as conn:
    with conn.cursor() as cursor:
        cursor.execute("SELECT TOP 5 Name, ListPrice FROM Production.Product")
        rows = cursor.fetchall()
# Connection and cursor automatically closed

Conteúdo relacionado

• Obter dados
• Mapeamentos de tipo de dados
• Gerenciamento de transações
• Gerenciamento do cursor