Hívd meg tárolt eljárásokat mssql-python segítségével

Az mssql-python illesztőprogram nem valósítja meg a DB-API 2.0 specifikációból származó callproc() metódusot. A(z) callproc() hívása NotSupportedError kivételt vált ki. Ehelyett az ODBC {CALL ...} escape sequence-t használjuk a szokásos lekérdezésvégrehajtási módszerekkel.

Alapvető tárolt eljárás végrehajtása

Paraméterek nélkül

Hajtson végre egy tárolt eljárást a {CALL} escape-szekvencia használatával. Ez a példa a sp_databases rendszer tárolt eljárását hívja, amely nem vesz fel paramétereket, és adatbázisonként egy sort ad vissza:

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)

Bemeneti paraméterekkel

Paraméterek átadása pozíciós vagy elnevezett helyőrzők használatával:

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

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

Kimeneti paraméterek

Deklarálni és visszanyerni a kimeneti paramétereket

Az SQL Server tárolt eljárásai kimeneti paramétereken keresztül értékeket tudnak visszaadni. Használj Transact-SQL (T-SQL) változókat a kimeneti értékek rögzítésére, majd egy utasítással kérd vissza őket 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}")

Több kimeneti paraméter

Több kimeneti értéket rögzítsünk külön változók kihirdetésével. Ugyanez a minta bármely tárolt eljárásra működik, amelynek paraméterei OUTPUT vannak:

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

Visszaadott értékek

Tárolt eljárás visszaküldési értékének rögzítése

Hajts végre egy tárolt eljárást, amely eredményeket ad vissza:

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

Visszaküldési érték kimeneti paraméterekkel

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

Eredményhalmazok

Egyetlen eredménykészlet

Hajtson végre egy tárolt eljárást, amely egyetlen eredményhalmazt ad vissza:

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

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

Több eredményhalmaz

Egyes tárolt eljárások több eredményhalmazt adnak vissza. A közöttük való navigáláshoz használja a(z) nextset() elemet:

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

További eredményhalmazok keresése

Ismételjük végig az összes tárolt eljárás által visszaadott eredményhalmazt a következők nextset()segítségével:

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

Tranzakciók tárolt eljárásokkal

Explicit tranzakciókezelés

Több tárolt eljáráshívást csomagoljunk be egy tranzakcióba, hogy biztosítsuk az atomititást:

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

A tárolt eljárás kezelje a tranzakciót

Ha a tárolt eljárás saját tranzakciókat kezel:

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

Hibakezelés

A tárolt eljárások hibáinak kezelése

Kezelje azokat a kivételeket, amelyeket tárolt eljárások vagy Transact-SQL utasítások okoznak:

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

PRINT-utasítások és tájékoztató üzenetek rögzítése

Az SQL Server PRINT utasításai és a 11 alatti súlyosságú RAISERROR a végrehajtás után a(z) cursor.messages elemben kerülnek rögzítésre. Minden bejegyzés egy (message_type, message_text) tuple. Amikor egy PRINT eredményhalmaz előtt fut, akkor saját sortalan eredményhalmazt foglal el, tehát először olvassuk cursor.messages , majd hívjuk nextset() , hogy elérjük a sorokat:

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

Amikor egy tárolt eljárás több eredményhalmazban PRINT üzeneteket bocsát ki, olvassa be a cursor.messages elemet a execute() után, majd minden egyes nextset() hívás után ismét, hogy az összes eredményhalmaz üzenete rögzítésre kerüljön:

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

A teljes cursor.messages API-ért lásd: Cursor-menedzsment.

Bevált gyakorlatok

Névalapú paraméterek használata

Az elnevezett paraméterek áttekinthetőbbek, és nem függnek a sorrendtől:

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

Nullable kimeneti paraméterek kezelése

Ellenőrizd a NULL értékeket, amikor tárolt eljárásokból származó kimeneti paramétereket keressz:

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

Az SET NOCOUNT ON használata tárolt eljárásokban

A jobb teljesítmény és a tisztább eredménykezelés érdekében győződjön meg róla, hogy a tárolt eljárások a következőképpen tartalmazzák:

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

Példa: Teljes munkafolyamat

Íme egy gyakorlati példa, amely egy tárolt eljárást hív, visszanyeri a kimeneti értékeket, és kezeli a hibákat:

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)

Generált kulcsokat szerezz OUTPUT INSERTED használatával

Az identitásérték INSERT objektumból történő lekérdezéséhez (tárolt eljárással vagy anélkül) a(z) SCOPE_IDENTITY() helyett használja a(z) OUTPUT INSERTED elemet. Ez a megközelítés ugyanabban az eredményhalmazban adja vissza az értéket:

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

Ez a minta bármely azonosító oszloptal rendelkező táblánál működik, és nem igényel tárolt eljárást.

Nem támogatott szolgáltatások

callproc()

A mssql-python illesztőprogram NotSupportedError kivételt vált ki, ha meghívod a cursor.callproc() függvényt. Használd cursor.execute("{CALL ...}") vagy cursor.execute("EXECUTE ...") helyette, ahogy a cikkben is látható.

Táblázatértékű paraméterek (TVP-k)

A táblaértékű paraméterek nem támogatottak a jelenlegi (1.11.0) mssql-pythonverzióban. Ha sorokat kell átadni egy tárolt eljárásnak, használj alternatívákat:

  • Először behelyezd egy ideiglenes táblába, majd olvasd el onnan a tárolt eljárást.
  • Az adatok átmeneti táblába történő betöltéséhez használja a következőt: bulkcopy().
  • Adj át egy JSON-karakterláncot, majd elemezd az eljáráson belül a(z) OPENJSON elemmel.