Esegui query con mssql-python

Il driver mssql-python fornisce metodi di cursore per l'esecuzione di query SQL, query parametrizzate, operazioni batch e istruzioni preparate.

Esecuzione di query di base

Usa il metodo execute() di un cursore per eseguire istruzioni 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()

Query con parametri

Usare sempre query con parametri per evitare sql injection. Il paramstyle predefinito del driver è pyformat (segnaposto nominati), ma supporta anche qmark (segnaposto posizionali). Usare qmark per le sequenze di escape ODBC {CALL}.

Formato Pyformat (predefinito)

Usa segnaposto nominati con la sintassi %(name)s e passa un dizionario:

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

Stile Qmark

Usa segnaposto posizionali con ? e passa una tupla o una lista:

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

Il driver rileva automaticamente lo stile dei parametri in base alla tua query SQL e ai tipi di parametri.

INSERT, UPDATE, DELETE operazioni

Per le istruzioni di modifica dei dati, usa query parametrizzate e effettua il commit della transazione:

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

Esecuzione batch con executemany()

Usa executemany() per inserire più righe in modo efficiente. Il driver utilizza l'associazione dei parametri per colonna per prestazioni elevate:

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

Con lo stile 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()

Esecuzione batch di più istruzioni

Usa batch_execute() sulla connessione per eseguire più istruzioni diverse in una singola chiamata:

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

Istruzioni preparate

Il driver prepara le query di default (use_prepare=True). Quando esegui la stessa stringa SQL più volte sullo stesso cursore, il driver riutilizza automaticamente l'istruzione preparata nelle chiamate successive:

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

Per saltare la preparazione e usare invece l'esecuzione diretta:

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

Esecuzione a livello di connessione

Per query semplici e singole, usa execute() direttamente sulla connessione:

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

Procedure memorizzate

Chiama procedure memorizzate usando EXECUTE o la sintassi di escape ODBC {CALL} . Per informazioni sui parametri di output, su molteplici set di risultati e schemi di transazione, vedi Stored procedures.

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

Impostare le dimensioni degli input

Usare setinputsizes() per dichiarare esplicitamente i tipi di parametri, il che può migliorare le prestazioni per operazioni batch:

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

Note

Non tutte le costanti di tipo SQL funzionano con setinputsizes(). SQL_WVARCHAR e SQL_INTEGER sono affidabili. Per i valori decimali, usa l'inferenza automatica dei tipi del driver invece di SQL_DECIMAL, che ha un problema noto (GitHub #503).

Gestione degli errori

Racchiudi le operazioni del database in blocchi 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()

Procedure consigliate

  1. Usa sempre query parametrizzate per prevenire l'iniezione SQL.
  2. Usa bulk copy per inserimenti in blocco invece di chiamate multiple a execute().
  3. Effettua il commit esplicito delle transazioni quando disabiliti l'autocommit.
  4. Chiudi cursori e connessioni quando è finito per liberare risorse.
  5. Usa i gestori di contesto per la pulizia automatica delle risorse:
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