Freigeben über

Erstellen einer Python-Konsolen-App mit Azure DocumentDB

Dieser Leitfaden führt Sie durch das Erstellen einer Python-Konsolenanwendung zum Herstellen einer Verbindung mit einem Azure DocumentDB-Cluster. Sie konfigurieren Ihre Entwicklungsumgebung, authentifizieren sich mithilfe des azure.identity Pakets aus dem Azure SDK für Python und führen Vorgänge wie Erstellen, Abfragen und Aktualisieren von Dokumenten aus.

Voraussetzungen

  • Ein Azure-Abonnement

    • Wenn Sie nicht über ein Azure-Abonnement verfügen, erstellen Sie ein kostenloses Konto

  • Ein vorhandener Azure DocumentDB-Cluster

    • Wenn Sie keinen Cluster haben, erstellen Sie einen neuen Cluster.

  • Microsoft Entra-Authentifizierung ist für den Cluster konfiguriert, wobei Ihrer Identität die root Rolle zugewiesen wurde.

  • Neueste Version von Python.

Konfigurieren der Konsolenanwendung

Erstellen Sie als Nächstes ein neues Konsolenanwendungsprojekt, und importieren Sie die erforderlichen Bibliotheken, um sich bei Ihrem Cluster zu authentifizieren.

  1. Erstellen Sie ein neues Verzeichnis für Ihr Projekt, und richten Sie eine virtuelle Umgebung ein.

    mkdir mongodb-app
cd mongodb-app
python -m venv .venv

  2. Aktivieren Sie die virtuelle Umgebung.

    # On Windows
.venv\Scripts\activate

# On macOS/Linux
source .venv/bin/activate

  3. Erstellen Sie eine neue Python-Datei für Ihre Anwendung.

    touch app.py

  4. Installieren Sie die Bibliothek für die azure.identity Azure-Authentifizierung.

    pip install azure.identity

  5. Installieren Sie den pymongo Treiber für Python.

    pip install pymongo

Herstellen einer Verbindung mit dem Cluster

Verwenden Sie nun die Azure.Identity Bibliothek, um ein TokenCredential zu erhalten, das Sie verwenden können, um sich mit Ihrem Cluster zu verbinden. Der offizielle MongoDB-Treiber verfügt über eine spezielle Schnittstelle, die implementiert werden muss, um Token von Microsoft Entra für die Verwendung beim Herstellen einer Verbindung mit dem Cluster abzurufen.

  1. Importieren Sie die erforderlichen Module oben in Ihrer Python-Datei.

    from azure.identity import DefaultAzureCredential
from pymongo import MongoClient
from pymongo.auth_oidc import OIDCCallback, OIDCCallbackContext, OIDCCallbackResult

  2. Erstellen Sie eine benutzerdefinierte Klasse, die die MongoDB OpenID Connect (OIDC)-Rückrufschnittstelle implementiert.

    class AzureIdentityTokenCallback(OIDCCallback):
    def __init__(self, credential):
        self.credential = credential

    def fetch(self, context: OIDCCallbackContext) -> OIDCCallbackResult:
        token = self.credential.get_token(
            "https://ossrdbms-aad.database.windows.net/.default").token
        return OIDCCallbackResult(access_token=token)

  3. Legen Sie die Clusternamenvariable fest.

    clusterName = "<azure-documentdb-cluster-name>"

  4. Erstellen Sie eine Instanz von DefaultAzureCredential, und richten Sie die Authentifizierungseigenschaften ein.

    credential = DefaultAzureCredential()
authProperties = {"OIDC_CALLBACK": AzureIdentityTokenCallback(credential)}

  5. Erstellen Sie einen MongoDB-Client, der mit der Microsoft Entra-Authentifizierung konfiguriert ist.

    client = MongoClient(
    f"mongodb+srv://{clusterName}.global.mongocluster.cosmos.azure.com/",
    connectTimeoutMS=120000,
    tls=True,
    retryWrites=True,
    authMechanism="MONGODB-OIDC",
    authMechanismProperties=authProperties
)

print("Client created")

Ausführen gängiger Vorgänge

Verwenden Sie schließlich die offizielle Bibliothek, um allgemeine Aufgaben mit Datenbanken, Sammlungen und Dokumenten auszuführen. Hier verwenden Sie die gleichen Klassen und Methoden, mit denen Sie mit MongoDB oder DocumentDB interagieren würden, um Ihre Sammlungen und Elemente zu verwalten.

  1. Rufen Sie einen Verweis auf Ihre Datenbank ab.

    database = client.get_database("<database-name>")

print("Database pointer created")

  2. Rufen Sie einen Verweis auf Ihre Sammlung ab.

    collection = database.get_collection("<container-name>")

print("Collection pointer created")

  3. Erstellen Sie ein Dokument und führen Sie ein Upsert in die Sammlung mit collection.update_one aus.

    new_document = {
    "_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "price": 850.00,
    "clearance": False,
}

filter = {
    "_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
}
payload = {
    "$set": new_document
}
result = collection.update_one(filter, payload, upsert=True)

  4. Verwenden Sie collection.find_one zum Abrufen eines bestimmten Dokuments aus der Sammlung.

    filter = {
    "_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards"
}
existing_document = collection.find_one(filter)
print(f"Read document _id:\t{existing_document['_id']}")

  5. Fragen Sie mit collection.find nach mehreren Dokumenten ab, die einem Filter entsprechen.

    filter = {
    "category": "gear-surf-surfboards"
}
matched_documents = collection.find(filter)

for document in matched_documents:
    print(f"Found document:\t{document}")

Verwandte Inhalte

  • Last updated on