Wywołanie procedur przechowywanych za pomocą mssql-python

Sterownik mssql-python nie implementuje callproc() metody ze specyfikacji DB-API 2.0. Wywołanie callproc() powoduje zgłoszenie NotSupportedError. Zamiast tego używaj sekwencji escape ODBC {CALL ...} ze standardowymi metodami wykonywania zapytań.

Podstawowe wykonywanie procedur przechowywanych

Bez parametrów

Wykonaj procedurę zapisaną, korzystając z sekwencji {CALL} ucieczki. Ten przykład wywołuje procedurę sp_databases systemową przechowywaną, która nie przyjmuje żadnych parametrów i zwraca jeden wiersz na każdą bazę danych:

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)

Z parametrami wejściowymi

Przekaż parametry za pomocą pozycyjnych lub nazwanych symboli zastępczych:

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

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

Parametry wyjściowe

Deklaruj i pobieraj parametry wyjściowe

Procedury przechowywane w SQL Server mogą zwracać wartości poprzez parametry wyjściowe. Użyj Transact-SQL zmiennych (T-SQL) do przechwycenia wartości wyjściowych, a następnie pobierz je za pomocą SELECT instrukcji:

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}")

Wiele parametrów wyjściowych

Przechwycaj wiele wartości wyjściowych, deklarując oddzielne zmienne. Ten sam wzorzec działa z każdą procedurą przechowywaną, która ma 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}")

Wartości zwracane

Przechwycaj wartość zwrotu procedury przechowywanej

Wykonaj procedurę przechowywaną, która zwraca wyniki:

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")

Wartość zwrotu z parametrami wyjściowymi

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}")

Zestawy wyników

Pojedynczy zestaw wyników

Wykonaj procedurę przechowywaną, która zwraca pojedynczy zestaw wyników:

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

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

Wiele zestawów wyników

Niektóre procedury składowane zwracają wiele zestawów wyników. Użyj polecenia nextset() , aby nawigować między nimi:

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}")

Sprawdź więcej zestawów wyników

Iteruj przez wszystkie zbiory wyników zwracane przez procedurę przechowywaną, używając: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

Transakcje z procedurami przechowywanymi

Jawna kontrola transakcji

Opakuj wiele wywołań procedur przechowywanych w transakcji, aby zapewnić atomowość:

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}")

Niech procedura przechowywana zarządza transakcją

Jeśli procedura przechowywana obsługuje własne transakcje:

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")

Obsługa błędów

Złapanie błędów procedur przechowywanych

Obsługa wyjątków wywołanych przez procedury przechowywane lub instrukcje Transact-SQL:

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}")

Przechwytuj instrukcje PRINT i komunikaty informacyjne

Instrukcje programu SQL Server PRINT oraz RAISERROR o poziomie ważności poniżej 11 są po wykonaniu rejestrowane w cursor.messages. Każdy wpis jest krotką (message_type, message_text). Gdy PRINT występuje przed zbiorem wyników, zajmuje własny zbiór wyników bez wierszy, więc najpierw odczytaj cursor.messages, a następnie wywołaj nextset(), aby przejść do wierszy:

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}")

Gdy procedura przechowywana zwraca komunikaty PRINT w wielu zbiorach wyników, odczytaj cursor.messages po execute(), a następnie ponownie po każdym wywołaniu nextset(), aby przechwycić komunikaty z każdego zbioru wyników:

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}")

Pełne cursor.messages API można znaleźć w artykule Zarządzanie kursorami.

Najlepsze rozwiązania

Użyj nazwanych parametrów

Parametry nazwane są bardziej przejrzyste i pozwalają zachować niezależność od kolejności:

# 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"))

Obsługa parametrów wyjściowych dopuszczających wartość null

Sprawdź wartości NULL podczas pobierania parametrów wyjściowych z procedur przechowywanych:

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")

Używaj SET NOCOUNT ON w procedurach przechowywanych

Aby uzyskać lepszą wydajność i czystszą obsługę wyników, upewnij się, że Twoje przechowywane procedury obejmują:

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

Przykład: Pełny przepływ pracy

Oto praktyczny przykład, który wywołuje procedurę przechowywaną, pobiera wartości wyjściowe i obsługuje błędy:

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)

Pobierz wygenerowane klucze za pomocą OUTPUT INSERTED

Aby pobrać wartość tożsamości z elementu INSERT (z procedurą przechowywaną lub bez niej), użyj OUTPUT INSERTED zamiast SCOPE_IDENTITY(). To podejście zwraca wartość w tym samym zestawie wyników:

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}")

Ten wzór działa dla każdej tabeli z kolumną tożsamości i nie wymaga procedury przechowywanej.

Nieobsługiwane funkcje

callproc()

Sterownik mssql-python zgłasza NotSupportedError, jeśli wywołasz cursor.callproc(). Użyj cursor.execute("{CALL ...}") lub cursor.execute("EXECUTE ...") zamiast tego, jak pokazano w tym artykule.

Parametry o wartości tabelarycznej (TVP)

Parametry o wartościach tabelarycznych nie są obsługiwane w bieżącej wersji mssql-python (1.11.0). Jeśli musisz przekazać zestaw wierszy do procedury przechowywanej, użyj alternatyw:

  • Najpierw wstaw do tabeli tymczasowej, a potem pobierz odczyt procedury przechowywanej z niej.
  • Użyj bulkcopy(), aby załadować dane do tabeli pomostowej.
  • Przekaż ciąg JSON i przeanalizuj go za pomocą OPENJSON wewnątrz procedury.

Treści powiązane

  • Last updated on