Quickstart: Reageren op databasewijzigingen in Azure Cosmos DB met behulp van Azure Functions

Dit artikel ondersteunt versie 4 van het Node.js programmeermodel voor Azure Functions.

Dit artikel ondersteunt versie 2 van het Python-programmeermodel voor Azure Functions.

• .NET 8.0 SDK

• C#-extensie voor Visual Studio Code.

• De Java Development Kit, versie 8, 11, 17 of 21 (Linux).

• Apache Maven, versie 3.0 of hoger.

• Het Java-uitbreidingspakket

• Node.js 22.x of hoger. Gebruik de opdracht node --version om uw versie te controleren.

• PowerShell 7.4

• .NET 8 runtime

• De PowerShell-extensie voor Visual Studio Code.

• Python-versies die worden ondersteund door Azure Functions. Zie Python installeren voor meer informatie.

• De Python-extensie voor Visual Studio Code.

• De Azure Developer CLI-extensie voor Visual Studio Code.

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-dotnet-azd-cosmosdb -e cosmosdbchanges-dotnet
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-dotnet-azd-cosmosdb
   

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-java-azd-cosmosdb -e cosmosdbchanges-java
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-java-azd-cosmosdb
   

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-javascript-azd-cosmosdb -e cosmosdbchanges-js
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-javascript-azd-cosmosdb
   

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-powershell-azd-cosmosdb -e cosmosdbchanges-ps
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-powershell-azd-cosmosdb
   

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-typescript-azd-cosmosdb -e cosmosdbchanges-ts
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-typescript-azd-cosmosdb
   

1. Voer vanuit een terminal deze azd init opdracht uit om een lokaal project te maken op basis van de sjabloon:

   azd init --template functions-quickstart-python-azd-cosmosdb -e cosmosdbchanges-py
   

   Met deze opdracht worden de projectbestanden opgehaald uit de template-opslagplaats en wordt het project geïnitialiseerd in een nieuwe map. In azdwordt de omgeving gebruikt om een unieke implementatiecontext voor uw app te onderhouden en kunt u meer dan één definiëren. Het maakt ook deel uit van de naam van de resourcegroep die u in Azure maakt.

2. Wijzig naar de projectmap:

   cd functions-quickstart-python-azd-cosmosdb
   

Deze omgevingsvariabelen configureren hoe de trigger de wijzigingenfeed bewaakt:

• COSMOS_CONNECTION__accountEndpoint: Het Eindpunt van het Cosmos DB-account
• COSMOS_DATABASE_NAME: De naam van de database die moet worden bewaakt
• COSMOS_CONTAINER_NAME: De naam van de container die moet worden bewaakt

Deze omgevingsvariabelen worden zowel in Azure (functie-app-instellingen) als lokaal (local.settings.json) gemaakt tijdens de azd provision bewerking.

De COSMOS_CONNECTION omgevingsvariabele configureert het Cosmos DB-accounteindpunt dat door de trigger wordt gebruikt. Deze omgevingsvariabele wordt zowel in Azure (functie-app-instellingen) als lokaal (local.settings.json) gemaakt tijdens de bewerking azd provision. De namen van de database en container worden gedefinieerd in de triggerconfiguratie.

using System;
using System.Collections.Generic;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;

namespace Company.Function
{
    public class CosmosTrigger
    {
        private readonly ILogger _logger;

        public CosmosTrigger(ILoggerFactory loggerFactory)
        {
            _logger = loggerFactory.CreateLogger<CosmosTrigger>();
        }

        [Function("cosmos_trigger")]
        public void Run([CosmosDBTrigger(
            databaseName: "%COSMOS_DATABASE_NAME%",
            containerName: "%COSMOS_CONTAINER_NAME%",
            Connection = "COSMOS_CONNECTION",
            LeaseContainerName = "leases",
            CreateLeaseContainerIfNotExists = true)] IReadOnlyList<MyDocument> input)
        {
            if (input != null && input.Count > 0)
            {
                _logger.LogInformation("Documents modified: " + input.Count);
                _logger.LogInformation("First document Id: " + input[0].id);
            }
        }
    }
    public class MyDocument
    {
        /// <summary>
        /// The unique identifier for the document.
        /// </summary>
        public required string id { get; set; }

        /// <summary>
        /// A text field in the document.
        /// </summary>
        public required string Text { get; set; }

        /// <summary>
        /// A numeric field in the document.
        /// </summary>
        public int Number { get; set; }

        /// <summary>
        /// A boolean field in the document.
        /// </summary>
        public bool Boolean { get; set; }
    }
}

U kunt het volledige sjabloonproject bekijken here.

package com.function;

import com.microsoft.azure.functions.ExecutionContext;
import com.microsoft.azure.functions.annotation.CosmosDBTrigger;
import com.microsoft.azure.functions.annotation.FunctionName;

public class CosmosTrigger {

    @FunctionName("cosmos_trigger")
    public void run(
        @CosmosDBTrigger(
            name = "input",
            databaseName = "%COSMOS_DATABASE_NAME%",
            containerName = "%COSMOS_CONTAINER_NAME%",
            connection = "COSMOS_CONNECTION",
            leaseContainerName = "leases",
            createLeaseContainerIfNotExists = true
        ) Object[] items,
        final ExecutionContext context
    ) {
        if (items != null && items.length > 0) {
            context.getLogger().info("Documents modified: " + items.length);
            context.getLogger().info("First document Id: " + items[0].toString());
        }
    }
}

U kunt het volledige sjabloonproject bekijken here.

const { app } = require('@azure/functions');

app.cosmosDB('cosmos_trigger', {
    connection: 'COSMOS_CONNECTION',
    databaseName: '%COSMOS_DATABASE_NAME%',
    containerName: '%COSMOS_CONTAINER_NAME%',
    leaseContainerName: 'leases',
    createLeaseContainerIfNotExists: true,
    handler: (documents, context) => {
        if (documents && documents.length > 0) {
            context.log(`Documents modified: ${documents.length}`);
            context.log(`First document Id: ${documents[0].id}`);
        }
    }
});

U kunt het volledige sjabloonproject bekijken here.

import { app, InvocationContext } from "@azure/functions";

export async function cosmos_trigger(documents: unknown[], context: InvocationContext): Promise<void> {
    context.log(`Cosmos DB function processed ${documents.length} documents`);

    if (documents && documents.length > 0) {
        for (const doc of documents) {
            context.log(`First document: ${JSON.stringify(doc)}`);
            if (doc && typeof doc === "object" && "id" in doc) {
                context.log(`First document id: ${(doc as { id?: string }).id}`);
            }
        }
    } else {
        context.log("No documents found.");
    }
}


app.cosmosDB('cosmos_trigger', {
    connection: 'COSMOS_CONNECTION',
    databaseName: 'documents-db',
    containerName: 'documents',
    createLeaseContainerIfNotExists: true,
    handler: cosmos_trigger
});

U kunt het volledige sjabloonproject bekijken here.

De trigger wordt gedefinieerd in dit function.json bestand:

{
  "bindings": [
    {
      "type": "cosmosDBTrigger",
      "name": "InputDocuments",
      "direction": "in",
      "databaseName": "%COSMOS_DATABASE_NAME%",
      "containerName": "%COSMOS_CONTAINER_NAME%",
      "connection": "COSMOS_CONNECTION",
      "leaseContainerName": "leases",
      "createLeaseContainerIfNotExists": true
    }
  ]
}

De volgende code wordt uitgevoerd wanneer de trigger wordt uitgevoerd:

param($InputDocuments, $TriggerMetadata)

if ($InputDocuments -and $InputDocuments.Count -gt 0) {
    Write-Host "Documents modified: $($InputDocuments.Count)"
    Write-Host "First document Id: $($InputDocuments[0].id)"
}

U kunt het volledige sjabloonproject bekijken here.

import os
import azure.functions as func
import logging

app = func.FunctionApp()


@app.cosmos_db_trigger(
    arg_name="documents",
    container_name=os.environ.get("COSMOS_CONTAINER_NAME"),
    database_name=os.environ.get("COSMOS_DATABASE_NAME"),
    connection="COSMOS_CONNECTION",
    create_lease_container_if_not_exists="true",
)
def cosmos_trigger(documents: func.DocumentList):
    logging.info("Python CosmosDB triggered.")
    logging.info(f"Documents modified: {len(documents)}")
    if documents:
        for doc in documents:
            logging.info(f"First document: {doc.to_json()}")
            logging.info(f"First document id: {doc.get('id')}")
    else:
        logging.info("No documents found.")

U kunt het volledige sjabloonproject bekijken here.