步驟 3：使用 pyodbc 連線到 SQL 的概念證明

文章
03/07/2024

這個概念證明範例會使用 pyodbc 來連線至 SQL 資料庫。此範例假設您使用 AdventureWorksLT 範例資料庫。

注意

這個範例只應被視為一個概念證明。為了清楚起見，已將範例程式碼簡化，而其不一定代表 Microsoft 建議的最佳做法。

必要條件

Python 3
- 如果您還沒有 Python，請從 python.org 安裝 Python 執行階段和 Python 套件索引 (PyPI) 套件管理員。
- 偏好不使用您自己的環境？使用 GitHub Codespaces 以 devcontainer 開啟。
  - .
來自 PyPI 的 pyodbc 套件。
安裝 Microsoft ODBC Driver 18 for SQL Server
SQL 資料庫和認證。

連線和查詢資料

使用您的認證連線至資料庫。

建立名為 app.py 的新檔案。

新增模組 docstring。

"""
Connects to a SQL database using pyodbc
"""

匯入 pyodbc 套件。
```
import pyodbc
```

為連線認證建立變數。

SERVER = '<server-address>'
DATABASE = '<database-name>'
USERNAME = '<username>'
PASSWORD = '<password>'

使用字串內插補點建立連接字串變數。

connectionString = f'DRIVER={{ODBC Driver 18 for SQL Server}};SERVER={SERVER};DATABASE={DATABASE};UID={USERNAME};PWD={PASSWORD}'

使用 pyodbc.connect 函式連線至 SQL 資料庫。
```
conn = pyodbc.connect(connectionString) 
```

執行查詢

使用 SQL 查詢字串來執行查詢並剖析結果。

建立 SQL 查詢字串的變數。

SQL_QUERY = """
SELECT 
TOP 5 c.CustomerID, 
c.CompanyName, 
COUNT(soh.SalesOrderID) AS OrderCount 
FROM 
SalesLT.Customer AS c 
LEFT OUTER JOIN SalesLT.SalesOrderHeader AS soh ON c.CustomerID = soh.CustomerID 
GROUP BY 
c.CustomerID, 
c.CompanyName 
ORDER BY 
OrderCount DESC;
"""

使用 cursor.execute 從資料庫查詢擷取結果集。
```
cursor = conn.cursor()
cursor.execute(SQL_QUERY)
```
注意

這個函式基本上會接受任何查詢並傳回結果集，您可以使用 cursor.fetchone() 反覆查詢結果集。

使用 cursor.fetchall 搭配 foreach 迴圈，以從資料庫取得所有記錄。然後列印記錄。

records = cursor.fetchall()
for r in records:
    print(f"{r.CustomerID}\t{r.OrderCount}\t{r.CompanyName}")

儲存app.py 檔案。

開啟終端機，並測試應用程式。

python app.py

29485   1       Professional Sales and Service
29531   1       Remarkable Bike Store
29546   1       Bulk Discount Store
29568   1       Coalition Bike Company
29584   1       Futuristic Bikes

插入一個資料列作為交易

在此範例中，您會安全地執行 INSERT 陳述式，並傳遞參數。將參數作為值傳遞，可協助您的應用程式防禦 SQL 插入式攻擊。

從 random 程式庫匯入 randrange。
```
from random import randrange
```
產生隨機的產品數字。
```
productNumber = randrange(1000)
```
提示

在這裡產生隨機的產品數字可確保您能多次執行此範例。

建立 SQL 陳述式字串。

SQL_STATEMENT = """
INSERT SalesLT.Product (
Name, 
ProductNumber, 
StandardCost, 
ListPrice, 
SellStartDate
) OUTPUT INSERTED.ProductID 
VALUES (?, ?, ?, ?, CURRENT_TIMESTAMP)
"""

使用 cursor.execute 執行陳述式。

cursor.execute(
    SQL_STATEMENT,
    f'Example Product {productNumber}', 
    f'EXAMPLE-{productNumber}', 
    100,
    200
)

使用 cursor.fetchval 擷取單一結果的第一行，列印結果的唯一識別碼，然後使用 connection.commit 提交作業為異動。
```
resultId = cursor.fetchval()
print(f"Inserted Product ID : {resultId}")
conn.commit()
```
提示

您可以選擇性地使用 connection.rollback 來回復異動。
使用 cursor.close 和 connection.close 關閉資料指標和關係。
```
cursor.close()
conn.close()
```
儲存app.py 檔案，然後再次測試應用程式
```
python app.py
```
```
Inserted Product ID : 1001
```

下一步

Python 開發人員中心。