步骤 3:使用 pyodbc 连接到 SQL 的概念证明

此示例概念证明用于 pyodbc 连接到 SQL 数据库。 此示例假设你使用的是 AdventureWorksLT 示例数据库

注意

应只将此示例视为概念证明。 为清楚起见,示例代码已简化,不一定代表 Microsoft 建议的最佳做法。

先决条件

连接和查询数据

使用凭据连接到数据库。

  1. 创建名为 app.py 的新文件。

  2. 添加模块 docstring。

    """
    Connects to a SQL database using pyodbc
    """
    
  3. 导入 pyodbc 包。

    import pyodbc
    
  4. 为连接凭据创建变量。

    SERVER = '<server-address>'
    DATABASE = '<database-name>'
    USERNAME = '<username>'
    PASSWORD = '<password>'
    
  5. 使用字符串内插创建连接字符串变量。

    connectionString = f'DRIVER={{ODBC Driver 18 for SQL Server}};SERVER={SERVER};DATABASE={DATABASE};UID={USERNAME};PWD={PASSWORD}'
    
  6. 使用 pyodbc.connect 函数连接到 SQL 数据库。

    conn = pyodbc.connect(connectionString) 
    

执行查询

使用 SQL 查询字符串执行查询并分析结果。

  1. 为 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;
    """
    
  2. 使用 cursor.execute 从数据库查询中检索结果集。

    cursor = conn.cursor()
    cursor.execute(SQL_QUERY)
    

    注意

    此函数实质上接受任意查询,并返回可使用 cursor.fetchone() 循环访问的结果集。

  3. cursor.fetchall 循环一起使用 foreach,从数据库中获取所有记录。 然后打印记录。

    records = cursor.fetchall()
    for r in records:
        print(f"{r.CustomerID}\t{r.OrderCount}\t{r.CompanyName}")
    
  4. 保存 app.py 文件。

  5. 打开终端并测试应用程序。

    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 注入攻击

  1. randrange 库导入 random

    from random import randrange
    
  2. 生成随机的产品编号。

    productNumber = randrange(1000)
    

    提示

    在此处生成随机的产品编号可确保可以多次运行此示例。

  3. 创建 SQL 语句字符串。

    SQL_STATEMENT = """
    INSERT SalesLT.Product (
    Name, 
    ProductNumber, 
    StandardCost, 
    ListPrice, 
    SellStartDate
    ) OUTPUT INSERTED.ProductID 
    VALUES (?, ?, ?, ?, CURRENT_TIMESTAMP)
    """
    
  4. 使用 cursor.execute 执行该语句。

    cursor.execute(
        SQL_STATEMENT,
        f'Example Product {productNumber}', 
        f'EXAMPLE-{productNumber}', 
        100,
        200
    )
    
  5. 使用 cursor.fetchval 提取单个结果的第一列,打印结果的唯一标识符,然后使用 connection.commit 将该操作作为事务提交。

    resultId = cursor.fetchval()
    print(f"Inserted Product ID : {resultId}")
    conn.commit()
    

    提示

    也可选择使用 connection.rollback 回滚该事务。

  6. 使用 cursor.closeconnection.close 关闭游标和连接。

    cursor.close()
    conn.close()
    
  7. 保存 app.py 文件并再次测试应用程序

    python app.py
    
    Inserted Product ID : 1001
    

后续步骤