Quickstart: Verbinding maken met een SQL-database vanuit een Jupyter Notebook

Gebruik in deze quickstart Jupyter Notebook in Visual Studio Code om snel zakelijke inzichten af te leiden. Gebruik de mssql-python driver van Python om verbinding te maken met je SQL-database, lees de data en formatteer deze vervolgens voor gebruik in e-mails, rapporten en presentaties.

Het mssql-python stuurprogramma vereist geen externe afhankelijkheden op Windows-computers. Het stuurprogramma installeert alles wat het nodig heeft met één pip installatie, zodat u de nieuwste versie van het stuurprogramma voor nieuwe scripts kunt gebruiken zonder dat andere scripts die u niet hoeft te upgraden en te testen, worden onderbroken.

documentatie | mssql-python-broncode | Pakket (PyPI) | Visual Studio Code

Vereiste voorwaarden

Vereisten voor het besturingssysteem installeren

Installeer eenmalige vereisten voor het besturingssysteem. Windows-gebruikers kunnen deze stap overslaan. Voor volledige platformdetails, zie Install mssql-python.

apk add libtool krb5-libs krb5-dev libstdc++

Een SQL-database maken

Maak een SQL-database aan of maak verbinding met een van de volgende platforms:

Het project maken en de code uitvoeren

Een nieuw project maken

  1. Open een opdrachtprompt in uw ontwikkelingsmap. Als je er geen hebt, maak dan een nieuwe map aan, zoals python of scripts. Vermijd mappen op je OneDrive, want synchronisatie kan het beheer van je virtuele omgeving verstoren.

  2. Maak een nieuw project met uv.

    uv init jupyter-notebook-qs
    cd jupyter-notebook-qs
    

Afhankelijkheden toevoegen

Installeer in dezelfde map de mssql-python, python-dotenv, rich, pandas en matplotlib pakketten. Voeg vervolgens ipykernel en uv toe als dev-afhankelijkheden. VS Code heeft ipykernel nodig om notebookcellen uit te voeren en uv om pakketten vanuit je notebookcellen te beheren.

uv add mssql-python python-dotenv rich pandas matplotlib
uv add --dev ipykernel
uv add --dev uv

Visual Studio Code starten

Voer in dezelfde map de volgende opdracht uit.

code .

Pyproject.toml bijwerken

  1. Open het pyproject.toml bestand in de editor. Dit bestand bevat de metadata van je project.

  2. Werk de description waarde bij.

    description = "A quick example using the mssql-python driver and Jupyter Notebooks."
    
  3. Sla het bestand op en sluit het.

De verbindingsreeks opslaan

  1. Open het .gitignore bestand en voeg een uitsluiting toe voor .env bestanden. Je dossier zou vergelijkbaar moeten zijn met het volgende voorbeeld.

    # Python-generated files
    __pycache__/
    *.py[oc]
    build/
    dist/
    wheels/
    *.egg-info
    
    # Virtual environments
    .venv
    
    # Connection strings and secrets
    .env
    
  2. Opslaan en sluiten .gitignore.

  3. Maak in de huidige map een nieuw bestand met de naam .env.

  4. Voeg in het .env bestand een vermelding toe voor de verbindingsreeks met de naam SQL_CONNECTION_STRING. Vervang de tijdelijke aanduidingen door de werkelijke waarden.

    SQL_CONNECTION_STRING="Server=<server>;Database=<database>;Encrypt=yes;TrustServerCertificate=no;Authentication=ActiveDirectoryInteractive"
    

    De verbindingsreeks hangt af van het type SQL-database waarmee je verbinding maakt. Voor Azure SQL Database of SQL Database in Fabric gebruik je de ODBC-verbindingsreeks van het tabblad verbindingsreekss en pas je het authenticatietype aan voor jouw situatie. Voor meer informatie over de syntaxis van verbindingsreeks, zie Connection strings voor mssql-python.

    Aanbeveling

    In macOS werken beide ActiveDirectoryInteractive en ActiveDirectoryDefault voor Microsoft Entra-verificatie. ActiveDirectoryInteractive u wordt gevraagd u aan te melden telkens wanneer u het script uitvoert. Om herhaalde aanmeldprompts te vermijden, log je één keer in met het Azure CLI-commandoaz login en gebruik ActiveDirectoryDefault. ActiveDirectoryDefault Hergebruikt de gecachte inloggegevens.

Een Jupyter Notebook maken

  1. Selecteer Bestand en vervolgens Nieuw bestand en Jupyter Notebook in de lijst. Er wordt een nieuw notitieblok geopend.

  2. Selecteer Bestand, vervolgens Opslaan als... en geef uw nieuwe notitieblok een naam.

  3. Voeg de volgende imports toe in de eerste cel.

    from os import getenv
    from mssql_python import connect
    from dotenv import load_dotenv
    from rich.console import Console
    from rich.table import Table
    import pandas as pd
    import matplotlib.pyplot as plt
    
  4. Gebruik de knop + Markdown boven aan het notitieblok om een nieuwe Markdown-cel toe te voegen.

  5. Voeg de volgende tekst toe aan de nieuwe Markdown-cel.

    ## Define queries for use later
    
  6. Selecteer het vinkje op de celwerkbalk of gebruik de sneltoetsen Ctrl+Enter of Shift+Enter om de Markdown-cel weer te geven.

  7. Gebruik de knop + Code boven aan het notitieblok om een nieuwe codecel toe te voegen.

  8. Voeg de volgende code toe aan de nieuwe codecel.

    SQL_QUERY_ORDERS_BY_CUSTOMER = """
    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;
    """
    
    SQL_QUERY_SPEND_BY_CATEGORY = """
    SELECT TOP 10
        pc.Name AS ProductCategory,
        SUM(sod.OrderQty * sod.UnitPrice) AS Spend
    FROM SalesLT.SalesOrderDetail AS sod
    INNER JOIN SalesLT.SalesOrderHeader AS soh
        ON sod.SalesOrderID = soh.SalesOrderID
    INNER JOIN SalesLT.Product AS p
        ON sod.ProductID = p.ProductID
    INNER JOIN SalesLT.ProductCategory AS pc
        ON p.ProductCategoryID = pc.ProductCategoryID
    GROUP BY pc.Name
    ORDER BY Spend;
    """
    

Resultaten weergeven in een tabel

  1. Gebruik de knop + Markdown boven aan het notitieblok om een nieuwe Markdown-cel toe te voegen.

  2. Voeg de volgende tekst toe aan de nieuwe Markdown-cel.

    ## Print orders by customer and display in a table
    
  3. Selecteer het vinkje op de celwerkbalk of gebruik de sneltoetsen Ctrl+Enter of Shift+Enter om de Markdown-cel weer te geven.

  4. Gebruik de knop + Code boven aan het notitieblok om een nieuwe codecel toe te voegen.

  5. Voeg de volgende code toe aan de nieuwe codecel.

    load_dotenv()
    with connect(getenv("SQL_CONNECTION_STRING")) as conn: # type: ignore
        with conn.cursor() as cursor:
            cursor.execute(SQL_QUERY_ORDERS_BY_CUSTOMER)
            if cursor:
                table = Table(title="Orders by Customer")
                # https://rich.readthedocs.io/en/stable/appendix/colors.html
                table.add_column("Customer ID", style="bright_blue", justify="center")
                table.add_column("Company Name", style="bright_white", justify="left")
                table.add_column("Order Count", style="bold green", justify="right")
    
                records = cursor.fetchall()
    
                for r in records:
                    table.add_row(f"{r.CustomerID}", f"{r.CompanyName}", f"{r.OrderCount}")
    
                Console().print(table)
    
  6. Gebruik de knop Alle opdrachten uitvoeren bovenaan het notebook om alle opdrachten in het notebook uit te voeren.

  7. Selecteer de jupyter-notebook-qs-kernel wanneer hierom wordt gevraagd.

Resultaten weergeven in een grafiek

  1. Bekijk de output van de vorige cel. U ziet nu een tabel met drie kolommen en vijf rijen.

  2. Gebruik de knop + Markdown boven aan het notitieblok om een nieuwe Markdown-cel toe te voegen.

  3. Voeg de volgende tekst toe aan de nieuwe Markdown-cel.

    ## Display spend by category in a horizontal bar chart
    
  4. Selecteer het vinkje op de celwerkbalk of gebruik de sneltoetsen Ctrl+Enter of Shift+Enter om de Markdown-cel weer te geven.

  5. Gebruik de knop + Code boven aan het notitieblok om een nieuwe codecel toe te voegen.

  6. Voeg de volgende code toe aan de nieuwe codecel.

    with connect(getenv("SQL_CONNECTION_STRING")) as conn: # type: ignore
        data = pd.read_sql_query(SQL_QUERY_SPEND_BY_CATEGORY, conn)
        # Set the style - use print(plt.style.available) to see all options
        plt.style.use('seaborn-v0_8-notebook')
        plt.barh(data['ProductCategory'], data['Spend'])
    
  7. Gebruik de knop Cel uitvoeren of Ctrl+Alt+Enter voer de cel uit.

  8. Bekijk de grafiek.