Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Ovladač mssql-python poskytuje kurzorové objekty pro provádění dotazů, zpracování více sad výsledků a efektivní správu paměti.
Základy kurzoru
Vytváření a používání kurzorů
Volejte conn.cursor() pro vytvoření kurzoru, poté použijte execute() a načítajte metody pro spouštění dotazů a získávání výsledků:
import mssql_python
conn = mssql_python.connect(
"Server=<server>.database.windows.net;"
"Database=<database>;"
"Authentication=ActiveDirectoryDefault;"
"Encrypt=yes"
)
# Create cursor
cursor = conn.cursor()
# Execute query
cursor.execute("SELECT TOP 10 Name, ListPrice FROM Production.Product")
# Process results
for row in cursor:
print(row.Name)
# Close cursor when done
cursor.close()
Vzor správce kontextu
Použijte with příkaz k implementaci správce kontextu pro automatické čištění:
with mssql_python.connect(connection_string) as conn:
with conn.cursor() as cursor:
cursor.execute("SELECT TOP 10 Name, ListPrice FROM Production.Product")
products = cursor.fetchall()
# Cursor automatically closed on exit
# Connection automatically closed on exit
Více kurzorů
Important
Ovladač mssql-python nepodporuje více aktivních výsledkových sad (MARS). Můžete vytvořit více kurzorů na jednom spojení, ale pouze jeden kurzor může mít aktivní dotaz najednou. Vždy načti všechny výsledky z kurzoru před provedením operace pomocí jiného kurzoru ve stejném připojení.
conn = mssql_python.connect(connection_string)
# Multiple cursors on same connection
cursor1 = conn.cursor()
cursor2 = conn.cursor()
# Fetch results completely from cursor1 before using cursor2
cursor1.execute("SELECT TOP 5 ProductID, Name FROM Production.Product")
products = cursor1.fetchall()
cursor2.execute("SELECT TOP 5 ProductCategoryID, Name FROM Production.ProductCategory")
categories = cursor2.fetchall()
cursor1.close()
cursor2.close()
Pokud potřebujete spouštět dotazy současně, použijte místo toho samostatná připojení:
conn1 = mssql_python.connect(connection_string)
conn2 = mssql_python.connect(connection_string)
cursor1 = conn1.cursor()
cursor2 = conn2.cursor()
cursor1.execute("SELECT TOP 5 ProductID, Name FROM Production.Product")
cursor2.execute("SELECT TOP 5 ProductCategoryID, Name FROM Production.ProductCategory")
products = cursor1.fetchall()
categories = cursor2.fetchall()
cursor1.close()
cursor2.close()
conn1.close()
conn2.close()
Strategie načítání
Načtení všech vs. iterativní načtení
Použijte fetchall() k načtení celé sady výsledků najednou do paměti, nebo k iteraci přes kurzor a zpracování řádků jeden po druhém bez bufferování.
# Fetch all at once - loads entire result into memory
cursor.execute("SELECT * FROM Production.Product")
all_products = cursor.fetchall()
print(f"Loaded {len(all_products)} products")
# Iterative fetch - memory efficient
cursor.execute("SELECT * FROM Production.Product")
count = 0
for row in cursor:
count += 1
print(f"Processed {count} products")
Aportování po dávkách
Použijte fetchmany() s dávkovou velikostí pro zpracování velkých výsledků v částech bez nutnosti načítat vše do paměti.
def process_batch(rows):
# Example: print each row. Replace with your own logic.
for row in rows:
print(row)
def fetch_in_batches(cursor, batch_size: int = 1000):
"""Fetch results in batches to manage memory."""
while True:
batch = cursor.fetchmany(batch_size)
if not batch:
break
yield batch
cursor.execute("SELECT * FROM LargeTable")
for batch in fetch_in_batches(cursor, batch_size=5000):
process_batch(batch)
print(f"Processed batch of {len(batch)} rows")
Použijte fetchval pro jednotlivé hodnoty
Použití fetchval() pro skalární dotazy, které vracejí jedinou hodnotu. Vrátí první sloupec prvního řádku.
# Efficient for scalar queries
cursor.execute("SELECT COUNT(*) FROM Production.Product")
count = cursor.fetchval() # Returns single value directly
cursor.execute("SELECT MAX(ListPrice) FROM Production.Product")
max_price = cursor.fetchval()
Více výsledkových sad
Zpracujte více sad výsledků
Použijte nextset() k přechodu z aktuální sady výsledků na další po načtení všech řádků z předchozí sady výsledků.
# Query returns multiple results
cursor.execute("""
SELECT TOP 3 CustomerID, AccountNumber FROM Sales.Customer;
SELECT TOP 3 SalesOrderID, OrderDate FROM Sales.SalesOrderHeader;
SELECT TOP 3 ProductID, Name FROM Production.Product;
""")
# First result set
print("Customers:")
customers = cursor.fetchall()
for c in customers:
print(f" {c.AccountNumber}")
# Move to second result set
if cursor.nextset():
print("Orders:")
orders = cursor.fetchall()
for o in orders:
print(f" Order #{o.SalesOrderID}")
# Move to third result set
if cursor.nextset():
print("Products:")
products = cursor.fetchall()
for p in products:
print(f" {p.Name}")
Iterujte všechny množiny výsledků
Opakujte, dokud nextset() nevrátí False, abyste zpracovali všechny množiny výsledků z jednoho volání execute:
def process_all_result_sets(cursor):
"""Process all result sets from a query."""
result_sets = []
while True:
# Fetch current result set
rows = cursor.fetchall()
result_sets.append(rows)
# Try to move to next result set
if not cursor.nextset():
break
return result_sets
cursor.execute("""
SELECT TOP 3 ProductID, Name FROM Production.Product ORDER BY ProductID;
SELECT TOP 3 SalesOrderID, TotalDue FROM Sales.SalesOrderHeader ORDER BY SalesOrderID;
""")
all_results = process_all_result_sets(cursor)
print(f"Retrieved {len(all_results)} result sets")
Zkontrolujte, zda existují další množiny výsledků
V cyklu kontrolujte návratovou hodnotu nextset(), abyste zpracovali všechny sady výsledků, aniž byste předem věděli, kolik jich je:
cursor.execute("""
SELECT COUNT(*) AS ProductCount FROM Production.Product;
SELECT COUNT(*) AS PersonCount FROM Person.Person;
""")
result_num = 1
while True:
count = cursor.fetchval()
print(f"Result set {result_num}: {count}")
result_num += 1
if not cursor.nextset():
break
Popis kurzoru
Přistupujte k metadatům sloupců
Po provedení dotazu obsahuje cursor.description sekvenci sedmiprvkových n-tic — pro každý sloupec jednu — s názvem, typovým kódem, zobrazovanou velikostí, vnitřní velikostí, přesností, měřítkem a nulovatelností:
cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 10")
# Get column information
for col in cursor.description:
print(f"Column: {col[0]}, Type: {col[1]}")
# description structure: (name, type_code, display_size, internal_size,
# precision, scale, null_ok)
Vytvořte dynamické obslužné rutiny výsledků
Vytvořte obsluhu výsledků, která funguje s libovolným dotazem, tak že za běhu sestaví seznam sloupců z cursor.description:
def query_to_dicts(cursor) -> list[dict]:
"""Convert query results to list of dictionaries."""
columns = [col[0] for col in cursor.description]
return [dict(zip(columns, row)) for row in cursor.fetchall()]
cursor.execute("SELECT ProductID, Name, ListPrice FROM Production.Product WHERE ProductID < 10")
products = query_to_dicts(cursor)
for p in products:
print(p["Name"])
Řešení dotazů bez výsledků
cursor.description je None po příkazech jiných než SELECT, například INSERT, UPDATE a DELETE. Zkontrolujte to před zavoláním metod načítání:
cursor.execute("CREATE TABLE #UpdDemo (Name NVARCHAR(50), Price DECIMAL(10,2), CategoryID INT)")
cursor.execute("INSERT INTO #UpdDemo VALUES ('Widget', 10.0, 5), ('Gadget', 20.0, 5)")
cursor.execute("UPDATE #UpdDemo SET Price = Price * 1.1 WHERE CategoryID = 5")
# description is None for non-SELECT statements
if cursor.description is None:
print(f"Updated {cursor.rowcount} rows")
else:
results = cursor.fetchall()
Počet řádků
Sledovat ovlivněné řádky
Po INSERT, UPDATE, nebo DELETE, cursor.rowcount vrátí počet řádků ovlivněných tímto tvrzením:
cursor.execute("CREATE TABLE #RowDemo (Name NVARCHAR(50), Stock INT)")
cursor.execute("INSERT INTO #RowDemo VALUES ('A', 0), ('B', 5), ('C', 0)")
cursor.execute("UPDATE #RowDemo SET Stock = -1 WHERE Stock = 0")
print(f"Rows affected: {cursor.rowcount}")
cursor.execute("DELETE FROM #RowDemo WHERE Stock = -1")
print(f"Deleted {cursor.rowcount} rows")
Práce s neznámým počtem řádků
# Some operations might not return row count
cursor.execute("EXEC dbo.uspGetEmployeeManagers @BusinessEntityID = 5")
if cursor.rowcount == -1:
print("Row count not available")
else:
print(f"Affected {cursor.rowcount} rows")
Přeskočit řádky
Použijte skip jako alternativu k stránkování
cursor.skip() posune pozici kurzoru bez načtení řádků. Pro velké datové sady preferujte OFFSET-FETCH stránkování na úrovni SQL pro lepší výkon:
def get_page_using_skip(cursor, page: int, page_size: int):
"""Get a page of results using skip."""
cursor.execute("SELECT * FROM Production.Product ORDER BY ProductID")
# Skip rows from previous pages
cursor.skip((page - 1) * page_size)
# Fetch this page
return cursor.fetchmany(page_size)
# Get page 3
page_3 = get_page_using_skip(cursor, page=3, page_size=20)
Note
Pro velké datové sady používejte stránkování na úrovni SQL (OFFSET-FETCH) místo přeskakování na straně klienta, protože je to efektivnější.
Diagnostické zprávy
Přístup k cursor.messages
Atribut ukládá messages informační zprávy generované během vykonávání SQL příkazu, jak je popsáno v PEP 249. Tyto zprávy zahrnují výstupy z PRINT příkazů a RAISERROR s úrovní závažnosti pod 11.
Atribut je seznam n-tic, kde každá n-tice obsahuje kód typu zprávy a text zprávy:
conn = mssql_python.connect(connection_string, autocommit=True)
cursor = conn.cursor()
cursor.execute("PRINT 'Hello world!'")
print(cursor.messages)
Output:
[('[01000] (0)', '[Microsoft][ODBC Driver 18 for SQL Server][SQL Server]Hello world!')]
Text zprávy obsahuje informace o předponě ovladače, protože ovladač načítá zprávy jako diagnostické záznamy prostřednictvím SQLGetDiagRec.
Zachycování zpráv ze uložených procedur
Po spuštění si přečtěte cursor.messages, abyste získali veškerý výstup PRINT nebo informativní zprávy serveru z předchozího příkazu:
cursor.execute("EXECUTE dbo.uspGetEmployeeManagers @BusinessEntityID = 5")
results = cursor.fetchall()
# Check for any informational messages
if cursor.messages:
for msg_type, msg_text in cursor.messages:
print(f"Server message: {msg_text}")
Správa paměti
Efektivní zpracování velkých výsledků
Načítejte dávkově pomocí fetchmany(), abyste mohli zpracovávat tabulky, které jsou příliš velké na to, aby bylo možné je načíst do paměti najednou:
def process_large_table(cursor, batch_size: int = 10000):
"""Process large result set without loading all into memory."""
cursor.execute("SELECT * FROM VeryLargeTable")
total_processed = 0
while True:
rows = cursor.fetchmany(batch_size)
if not rows:
break
for row in rows:
process_row(row)
total_processed += len(rows)
print(f"Progress: {total_processed} rows processed")
return total_processed
Zpracování založené na generátoru
Zabalte dávkové načítání do generátoru, abyste mohli zpracovávat po jednom řádku a zároveň zachovat konstantní využití paměti bez ohledu na velikost sady výsledků:
def row_generator(cursor, batch_size: int = 1000):
"""Generate rows from cursor without loading all."""
while True:
rows = cursor.fetchmany(batch_size)
if not rows:
break
for row in rows:
yield row
cursor.execute("SELECT * FROM LargeTable")
for row in row_generator(cursor, batch_size=5000):
# Process one row at a time
print(row) # Replace with your own row-handling logic
Kurzory zavírejte neprodleně
Vždy zavírejte kurzory v bloku finally , abyste uvolnili serverové zdroje, i když nastane výjimka:
def get_product(conn, product_id: int):
"""Get product and properly close cursor."""
cursor = conn.cursor()
try:
cursor.execute(
"SELECT * FROM Production.Product WHERE ProductID = %(id)s",
{"id": product_id}
)
return cursor.fetchone()
finally:
cursor.close()
Správa stavu kurzoru
Zkontrolujte, jestli kurzor obsahuje data
Ověřte, zda dotaz vrací nějaké řádky, tím, že zkontrolujete, zda fetchone() vrací None:
cursor.execute("SELECT ProductID, Name FROM Production.Product WHERE ProductID = 999")
row = cursor.fetchone()
if row is None:
print("Product not found")
else:
print(f"Found: {row.Name}")
Opakované použití kurzorů
Jeden kurzor může provádět více dotazů za sebou. Každé execute() volání nahrazuje předchozí sadu výsledků:
cursor = conn.cursor()
# Execute multiple queries with same cursor
cursor.execute("SELECT TOP 5 * FROM Sales.Customer")
customers = cursor.fetchall()
cursor.execute("SELECT TOP 5 * FROM Production.Product")
products = cursor.fetchall()
cursor.execute("SELECT TOP 5 * FROM Sales.SalesOrderHeader")
orders = cursor.fetchall()
cursor.close()
Osvědčené postupy
Vzor: Třída pomocníka kurzoru
Zapouzdřete správu životního cyklu kurzoru do pomocné třídy, abyste omezili opakující se kód v celé aplikaci:
class CursorManager:
"""Helper for managing cursor lifecycle."""
def __init__(self, connection):
self.conn = connection
def execute_and_fetch(self, query: str, params: dict = None) -> list:
"""Execute query and return all results."""
cursor = self.conn.cursor()
try:
cursor.execute(query, params or {})
return cursor.fetchall()
finally:
cursor.close()
def execute_scalar(self, query: str, params: dict = None):
"""Execute query and return single value."""
cursor = self.conn.cursor()
try:
cursor.execute(query, params or {})
return cursor.fetchval()
finally:
cursor.close()
def execute_non_query(self, query: str, params: dict = None) -> int:
"""Execute non-SELECT and return row count."""
cursor = self.conn.cursor()
try:
cursor.execute(query, params or {})
return cursor.rowcount
finally:
cursor.close()
# Usage
db = CursorManager(conn)
products = db.execute_and_fetch("SELECT TOP 5 Name FROM Production.Product")
count = db.execute_scalar("SELECT COUNT(*) FROM Production.Product")
db.execute_non_query("CREATE TABLE #Logs (LogID INT, Age INT)")
db.execute_non_query("INSERT INTO #Logs VALUES (1, 45), (2, 20), (3, 60)")
affected = db.execute_non_query("DELETE FROM #Logs WHERE Age > 30")
Nenechávejte kurzor otevřený
Kurzor, který není explicitně zavřený, uchovává serverové zdroje, dokud se spojení neuzavře. Používejte try/finally pro zajištění úklidu:
# Bad: cursor left open
def get_data_bad(conn):
cursor = conn.cursor()
cursor.execute("SELECT * FROM Data")
return cursor.fetchall()
# Cursor never closed!
# Good: always close cursor
def get_data_good(conn):
cursor = conn.cursor()
try:
cursor.execute("SELECT * FROM Data")
return cursor.fetchall()
finally:
cursor.close()
Přizpůsobte životnost kurzoru operaci
Vytvořte krátkodobé kurzory pro jednotlivé operace. Stejný kurzor použijte pouze pro sekvenci souvisejících operací:
# Short-lived cursor for simple query
def get_user_count(conn) -> int:
cursor = conn.cursor()
try:
cursor.execute("SELECT COUNT(*) FROM Person.Person")
return cursor.fetchval()
finally:
cursor.close()
# Reuse cursor for related operations
def update_inventory(conn, items: list):
cursor = conn.cursor()
try:
for item in items:
cursor.execute(
"UPDATE Inventory SET Quantity = %(qty)s WHERE ProductID = %(id)s",
item
)
conn.commit()
finally:
cursor.close()