Snabbstart: Ansluta med drivrutinen mssql-python för Python

I den här snabbstarten ansluter du ett Python-skript till en databas som du skapade och läste in med exempeldata. Du använder mssql-python drivrutinen för Python för att ansluta till databasen och utföra grundläggande åtgärder, till exempel att läsa och skriva data.

Drivrutinen mssql-python kräver inga externa beroenden på Windows-datorer. Drivrutinen installerar allt som behövs med en enda pip installation, så att du kan använda den senaste versionen av drivrutinen för nya skript utan att bryta andra skript som du inte har tid att uppgradera och testa.

mssql-python-dokumentation | mssql-python-källkod | Paket (PyPi) | Visual Studio Code

Förutsättningar

• Python 3

  • Om du inte redan har Python installerar du Pakethanteraren python runtime och Python Package Index (PyPI) från python.org.

  • Föredrar du att slippa använda din egen miljö? Öppna som en devcontainer med hjälp av GitHub Codespaces.

    

• (Valfritt) Azure Command-Line Interface (CLI)

• En databas på SQL Server, Azure SQL Database eller SQL Database i Fabric med AdventureWorks2022 exempelschemat och en giltig anslutningssträng.

Inställningar

Följ de här stegen för att konfigurera utvecklingsmiljön för att utveckla ett program med hjälp av Python-drivrutinen mssql-python .

Installera mssql-python-paketet

mssql-python Hämta paketet från PyPI.

1. Öppna en kommandotolk i en tom katalog.

2. Installera mssql-python-paketet.

   • Windows
   • Alpin
   • Debian/Ubuntu
   • RHEL
   • SUSE
   • openSUSE
   • macOS

   pip install mssql-python
   

Installera python-dotenv-paket

Hämta python-dotenv från PyPI.

1. Installera paketet i python-dotenv samma katalog.

   pip install python-dotenv
   

Kontrollera installerade paket

Du kan använda kommandoradsverktyget PyPI för att kontrollera att dina avsedda paket är installerade.

1. Kontrollera listan över installerade paket med pip list.

   pip list
   

Skapa en SQL-databas

Den här snabbstarten kräver AdventureWorks2022 Lightweight-schemat på Microsoft SQL Server, SQL Database i Fabric eller Azure SQL Database.

Kör koden

• Skapa en ny fil
• Utföra en sökfråga
• Infoga en rad som en transaktion

Skapa en ny fil

1. Skapa en ny fil med namnet app.py.

2. Lägg till en moduldokumentation.

   """
   Connects to a SQL database using mssql-python
   """
   

3. Importera paket, inklusive mssql-python.

   from os import getenv
   from dotenv import load_dotenv
   from mssql_python import connect
   

4. mssql-python.connect Använd funktionen för att ansluta till en SQL-databas.

   load_dotenv()
   conn = connect(getenv("SQL_CONNECTION_STRING"))
   

5. I den aktuella katalogen skapar du en ny fil med namnet .env.

6. I .env-filen lägger du till ett inlägg för anslutningssträngen med namnet SQL_CONNECTION_STRING. Ersätt exemplet här med det faktiska anslutningssträngsvärdet.

   SQL_CONNECTION_STRING="Server=<server_name>;Database={<database_name>};Encrypt=yes;TrustServerCertificate=no;Authentication=ActiveDirectoryInteractive"
   

   Tips/Råd

   Anslutningssträngen som används här beror till stor del på vilken typ av SQL-databas du ansluter till. Om du ansluter till en Azure SQL Database eller en SQL-databas i Fabric använder du ODBC-anslutningssträngen från fliken Anslutningssträngar. Du kan behöva justera autentiseringstypen beroende på ditt scenario. Mer information om anslutningssträngar och deras syntax finns i referens för anslutningssträngssyntax.

Köra en fråga

Använd en SQL-frågesträng för att köra en fråga och parsa resultatet.

1. Skapa en variabel för SQL-frågesträngen.

   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. Använd cursor.execute för att hämta en resultatuppsättning från en fråga mot databasen.

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

   Anmärkning

   Den här funktionen accepterar i princip alla frågor och returnerar en resultatuppsättning, som kan itereras över med hjälp av cursor.fetchone().

3. Använd cursor.fetchall med en foreach loop för att hämta alla poster från databasen. Skriv sedan ut posterna.

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

4. Sparaapp.py filen.

1. Öppna en terminal och testa programmet.

   python app.py
   

   Här är de förväntade resultaten.

   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
   

Infoga en rad som en transaktion

Kör en INSERT-instruktion på ett säkert sätt och skicka parametrar. Att skicka parametrar som värden skyddar ditt program från SQL-inmatningsattacker .

1. Lägg till en import för randrange från random biblioteket överst i app.py.

   from random import randrange
   

2. I slutet av app.py lägg till kod för att generera ett slumpmässigt produktnummer.

   productNumber = randrange(1000)
   

   Tips/Råd

   Om du genererar ett slumpmässigt produktnummer här kan du köra det här exemplet flera gånger.

3. Skapa en SQL-instruktionssträng.

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

4. Kör instruktionen med cursor.execute.

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

5. Hämta det enskilda resultatet med , cursor.fetchoneskriv ut resultatets unika identifierare och checka sedan in åtgärden som en transaktion med hjälp av connection.commit.

   result = cursor.fetchone()
   print(f"Inserted Product ID : {result['ProductID']}")
   conn.commit()
   

   Tips/Råd

   Du kan också använda connection.rollback för att återställa transaktionen.

6. Stäng markören och anslutningen med hjälp av cursor.close och connection.close.

   cursor.close()
   conn.close()
   

7. app.py filen och testa programmet igen.

   python app.py
   

   Här är de förväntade resultaten.

   Inserted Product ID : 1001
   

Nästa steg

mssql-python Besök GitHub-drivrutinslagringsplatsen för drivrutiner för fler exempel för att bidra med idéer eller rapportera problem.