Volejte uložené procedury pomocí mssql-python

Ovladač mssql-python neimplementuje metodu callproc() ze specifikace DB-API 2.0. Volání callproc() vyvolá NotSupportedError. Místo toho použijte escape sekvenci ODBC {CALL ...} se standardními metodami provádění dotazů.

Základní provádění uložených procedur

Bez parametrů

Proveďte uloženou proceduru pomocí escape sekvence {CALL} . Tento příklad volá systémovou uloženou proceduru sp_databases , která nepřijímá žádné parametry a vrací jeden řádek na databázi:

import mssql_python

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

cursor.execute("{CALL sp_databases}")

for row in cursor:
    print(row.DATABASE_NAME, row.DATABASE_SIZE)

S vstupními parametry

Předávejte parametry pomocí pozičních nebo pojmenovaných zástupných symbolů:

# Single parameter
cursor.execute(
    "{CALL dbo.uspGetManagerEmployees(?)}", (16,)
)

for row in cursor:
    print(row.FirstName, row.LastName)

Výstupní parametry

Deklarujte a získávejte výstupní parametry

Uložené procedury SQL Server mohou vracet hodnoty prostřednictvím výstupních parametrů. Použijte Transact-SQL (T-SQL) proměnné k zachycení výstupních hodnot a poté je získejte pomocí příkazu SELECT :

cursor.execute("""
    DECLARE @total_out MONEY;
    SELECT @total_out = SUM(TotalDue)
    FROM Sales.SalesOrderHeader
    WHERE CustomerID = %(customer_id)s;
    SELECT @total_out AS TotalAmount;
""", {"customer_id": 29825})

row = cursor.fetchone()
total = row.TotalAmount
print(f"Customer total: ${total}")

Více výstupních parametrů

Zachyťte více výstupních hodnot deklarováním samostatných proměnných. Stejný vzor funguje s jakoukoli uloženou procedurou, která má OUTPUT parametry:

cursor.execute("""
    DECLARE @total_orders INT, @total_spent MONEY;
    SELECT @total_orders = COUNT(*), @total_spent = SUM(TotalDue)
    FROM Sales.SalesOrderHeader
    WHERE CustomerID = %(cust_id)s;
    SELECT @total_orders AS OrderCount, @total_spent AS TotalSpent;
""", {"cust_id": 29825})

stats = cursor.fetchone()
print(f"Orders: {stats.OrderCount}, Total spent: ${stats.TotalSpent}")

Návratové hodnoty

Zachycení návratové hodnoty uložené procedury

Spusť uloženou proceduru, která vrací výsledky:

cursor.execute("EXECUTE dbo.uspGetEmployeeManagers @BusinessEntityID = %(emp_id)s", {"emp_id": 5})

rows = cursor.fetchall()
if rows:
    print(f"Found {len(rows)} managers in chain")
    for row in rows:
        print(f"  Manager: {row.FirstName} {row.LastName}")
else:
    print("No managers found")

Návratová hodnota s výstupními parametry

cursor.execute("""
    DECLARE @return_value INT, @message NVARCHAR(500);
    SELECT @return_value = CASE WHEN COUNT(*) > 0 THEN 0 ELSE 1 END,
           @message = CASE WHEN COUNT(*) > 0 THEN N'Customer found' ELSE N'Customer not found' END
    FROM Sales.Customer WHERE CustomerID = %(cust_id)s;
    SELECT @return_value AS ReturnCode, @message AS Message;
""", {"cust_id": 29825})

result = cursor.fetchone()
print(f"Return code: {result.ReturnCode}, Message: {result.Message}")

Sady výsledků

Jedna sada výsledků

Spuskutěte uloženou proceduru, která vrací jedinou sadu výsledků:

cursor.execute(
    "{CALL dbo.uspGetBillOfMaterials(?, ?)}",
    (800, "2026-01-01")
)

customers = cursor.fetchall()
for row in customers:
    print(f"{row.ProductAssemblyID}: {row.ComponentDesc}")

Více výsledkových sad

Některé uložené procedury vrací více sad výsledků. Pomocí nextset() můžete mezi nimi přecházet:

cursor.execute("""
    SELECT TOP 1 SalesOrderID, OrderDate, TotalDue
    FROM Sales.SalesOrderHeader WHERE CustomerID = 29825;
    SELECT TOP 3 Name, ListPrice
    FROM Production.Product WHERE ListPrice > 0
    ORDER BY ListPrice DESC;
""")

# First result set: order header
order = cursor.fetchone()
print(f"Order: {order.SalesOrderID}, Date: {order.OrderDate}")

cursor.nextset()

# Second result set: products
print("Products:")
for item in cursor:
    print(f"  {item.Name}: ${item.ListPrice}")

Zkontrolujte další sady výsledků

Projděte všechny sady výsledků vrácené uloženou procedurou pomocí nextset():

cursor.execute("SELECT TOP 3 ProductID, Name FROM Production.Product; SELECT TOP 3 FirstName, LastName FROM Person.Person")

result_set_num = 1
while True:
    print(f"--- Result Set {result_set_num} ---")
    for row in cursor:
        print(row)
    
    if not cursor.nextset():
        break
    result_set_num += 1

Transakce s uloženými procedurami

Explicitní řízení transakcí

Zabalte více volání uložených procedur do transakce, abyste zajistili atomicitu:

conn.autocommit = False

try:
    cursor.execute("{CALL dbo.DebitAccount(?, ?)}", (1001, 100.00))
    
    cursor.execute("{CALL dbo.CreditAccount(?, ?)}", (1002, 100.00))
    
    conn.commit()
    print("Transfer completed")
except mssql_python.DatabaseError as e:
    conn.rollback()
    print(f"Transfer failed: {e}")

Nechte uložené procedury spravovat transakce

Pokud uložená procedura zpracovává své vlastní transakce:

conn.autocommit = True  # Let SP manage transactions

cursor.execute("""
    DECLARE @result INT;
    EXECUTE @result = dbo.TransferFunds 
        @FromAccount = %(from_acc)s,
        @ToAccount = %(to_acc)s,
        @Amount = %(amount)s;
    SELECT @result AS TransferResult;
""", {"from_acc": 1001, "to_acc": 1002, "amount": 100.00})

result = cursor.fetchone()
if result.TransferResult == 0:
    print("Transfer successful")

Zpracování chyb

Chyť chyby uložených procedur

Řešení výjimek vyvolaných uloženými procedurami nebo Transact-SQL příkazy:

try:
    cursor.execute("{CALL dbo.DangerousProcedure}")
except mssql_python.ProgrammingError as e:
    # Handle SQL errors raised by RAISERROR or THROW
    print(f"Stored procedure error: {e}")
except mssql_python.DatabaseError as e:
    # Handle other database errors
    print(f"Database error: {e}")

Zachytit příkazy PRINT a informativní zprávy

Příkazy SQL Server PRINT a RAISERROR se závažností nižší než 11 se po provedení zaznamenají v cursor.messages. Každý záznam je n-tice (message_type, message_text) . Když se před sadou výsledků spustí PRINT, zabere vlastní sadu výsledků bez řádků, takže nejprve načtěte cursor.messages a potom zavolejte nextset(), abyste se dostali k řádkům:

cursor.execute("PRINT 'Operation complete'; SELECT 1 AS Status")

for msg_type, msg_text in cursor.messages:
    print(f"Server message: {msg_text}")

cursor.nextset()
row = cursor.fetchone()
print(f"Status: {row.Status}")

Když uložená procedura vysílá zprávy PRINT v rámci více sad výsledků, čtěte cursor.messages po execute() a znovu po každém volání nextset(), aby se zachytily zprávy ze všech sad výsledků:

cursor.execute("""
    PRINT 'Starting first result set';
    SELECT TOP 3 ProductID, Name FROM Production.Product;
    PRINT 'Starting second result set';
    SELECT TOP 3 FirstName, LastName FROM Person.Person;
""")

all_messages = []
while True:
    all_messages.extend(cursor.messages)
    if cursor.description:
        for row in cursor:
            print(row)
    if not cursor.nextset():
        break

for _, text in all_messages:
    print(f"Server: {text}")

Pro kompletní cursor.messages API viz Správa kurzorů.

Osvědčené postupy

Použijte pojmenované parametry

Pojmenované parametry jsou jasnější a zachovávají nezávislost na pořadí:

# Recommended: {CALL} with positional parameters
cursor.execute(
    "{CALL dbo.uspGetBillOfMaterials(?, ?)}",
    (800, "2026-01-01")
)

# Also valid: EXECUTE with named T-SQL parameters
cursor.execute("""
    EXECUTE dbo.uspGetBillOfMaterials
        @StartProductID = ?,
        @CheckDate = ?
""", (800, "2026-01-01"))

Práce s nulovatelnými výstupními parametry

Při získávání výstupních parametrů z uložených procedur zkontrolujte hodnoty NULL:

cursor.execute("""
    DECLARE @optional_value NVARCHAR(100);
    SELECT @optional_value = Color FROM Production.Product WHERE ProductID = %(id)s;
    SELECT @optional_value AS OutputValue;
""", {"id": 1})

result = cursor.fetchone()
if result.OutputValue is not None:
    print(f"Value: {result.OutputValue}")
else:
    print("No value returned")

Použijte SET NOCOUNT ON v uložených procedurách

Pro lepší výkon a čistší zpracování výsledků zajistěte, aby vaše uložené postupy zahrnovaly:

CREATE PROCEDURE dbo.MyProcedure
AS
BEGIN
    SET NOCOUNT ON;  -- Prevents "n rows affected" messages
    -- procedure logic
END

Příklad: Kompletní pracovní postup

Zde je praktický příklad, který volá uloženou proceduru, získává výstupní hodnoty a zpracovává chyby:

import mssql_python

def get_employee_report(manager_id: int) -> dict:
    """Look up a manager's employees and compute average vacation hours."""
    conn = mssql_python.connect(connection_string)
    conn.autocommit = False
    cursor = conn.cursor()

    try:
        # Get manager info
        cursor.execute("""
            SELECT BusinessEntityID, JobTitle
            FROM HumanResources.Employee
            WHERE BusinessEntityID = %(mgr)s
        """, {"mgr": manager_id})
        mgr = cursor.fetchone()
        print(f"Manager {mgr.BusinessEntityID}: {mgr.JobTitle}")

        # Get direct reports via stored procedure
        cursor.execute("{CALL dbo.uspGetManagerEmployees(?)}", (manager_id,))
        employees = cursor.fetchall()
        print(f"Found {len(employees)} employee(s)")

        # Compute average vacation hours
        cursor.execute("""
            DECLARE @avg_hours INT;
            SELECT @avg_hours = AVG(VacationHours)
            FROM HumanResources.Employee;
            SELECT @avg_hours AS AvgVacation;
        """)
        avg = cursor.fetchone().AvgVacation
        print(f"Avg vacation hours: {avg}")

        conn.commit()
        return {"manager": mgr.JobTitle, "reports": len(employees), "avg_vacation": avg}

    except mssql_python.DatabaseError as e:
        conn.rollback()
        raise
    finally:
        cursor.close()
        conn.close()

# Usage
result = get_employee_report(manager_id=16)

Získejte generované klíče pomocí OUTPUT INSERTED

Chcete-li načíst hodnotu identity z objektu INSERT (s uloženou procedurou nebo bez ní), použijte místo OUTPUT INSERTED výraz SCOPE_IDENTITY(). Tento přístup vrací hodnotu ve stejné množině výsledků:

cursor.execute("""
    INSERT INTO Production.ProductCategory (Name)
    OUTPUT INSERTED.ProductCategoryID
    VALUES (%(name)s)
""", {"name": "Custom Parts"})

new_id = cursor.fetchval()
print(f"New category ID: {new_id}")

Tento vzor funguje pro jakoukoli tabulku s sloupcem identity a nevyžaduje uloženou proceduru.

Nepodporované funkce

callproc()

Řidič mssql-python zvyšuje hodnotu NotSupportedError , pokud zavoláte cursor.callproc(). Použijte raději cursor.execute("{CALL ...}") nebo cursor.execute("EXECUTE ..."), jak je ukázáno v celém tomto článku.

Parametry s hodnotou typu tabulka (TVP)

Parametry s hodnotou tabulky nejsou v aktuální verzi (1.12.0) mssql-python podporovány. Pokud potřebujete předat sadu řádků uložené procedurě, použijte alternativy:

  • Nejprve vložte do tabulky dočasných údajů, pak z ní načtete uloženou proceduru.
  • K načtení dat do přechodné tabulky použijte bulkcopy().
  • Předejte řetězec JSON a parsujte ho pomocí OPENJSON uvnitř procedury.

Související obsah

  • Last updated on