Szybki start: reagowanie na zmiany bazy danych w usłudze Azure Cosmos DB przy użyciu usługi Azure Functions

Ten artykuł obsługuje wersję 4 modelu programowania Node.js dla usługi Azure Functions.

Ten artykuł obsługuje wersję 2 modelu programowania Python dla Azure Functions.

• SDK .NET 8.0

• Rozszerzenie języka C# dla programu Visual Studio Code.

• Zestaw Java Development Kit, wersja 8, 11, 17 lub 21 (Linux).

• Narzędzie Apache Maven, wersja 3.0 lub nowsza.

• Pakiet rozszerzenia Java

• Node.js 22.x lub nowsze. Użyj polecenia node --version, aby sprawdzić swoją wersję.

• PowerShell 7.4

• środowisko uruchomieniowe .NET 8

• Rozszerzenie programu PowerShell dla programu Visual Studio Code.

• Wersje języka Python obsługiwane przez usługę Azure Functions. Aby uzyskać więcej informacji, zobacz How to install Python (Jak zainstalować język Python).

• Rozszerzenie języka Python dla programu Visual Studio Code.

• Rozszerzenie interfejsu wiersza polecenia dla deweloperów platformy Azure dla programu Visual Studio Code.

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-dotnet-azd-cosmosdb
   

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-java-azd-cosmosdb
   

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-javascript-azd-cosmosdb
   

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-powershell-azd-cosmosdb
   

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-typescript-azd-cosmosdb
   

1. W terminalu uruchom to azd init polecenie, aby utworzyć projekt lokalny na podstawie szablonu:

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

   To polecenie ściąga pliki projektu z repozytorium template i inicjuje projekt w nowym folderze. W azd środowisko służy do utrzymania unikalnego kontekstu wdrożenia dla aplikacji i możesz zdefiniować więcej niż jedno. Jest również częścią nazwy grupy zasobów utworzonej na platformie Azure.

2. Przejdź do katalogu projektu:

   cd functions-quickstart-python-azd-cosmosdb
   

Te zmienne środowiskowe konfigurują sposób, w jaki wyzwalacz monitoruje strumień zmian.

• COSMOS_CONNECTION__accountEndpoint: punkt końcowy konta usługi Cosmos DB
• COSMOS_DATABASE_NAME: nazwa bazy danych do monitorowania
• COSMOS_CONTAINER_NAME: nazwa kontenera do monitorowania

Te zmienne środowiskowe są tworzone zarówno na platformie Azure (ustawienia aplikacji funkcji), jak i lokalnie (local.settings.json) podczas azd provision operacji.

Zmienna COSMOS_CONNECTION środowiskowa konfiguruje punkt końcowy konta usługi Cosmos DB używany przez wyzwalacz. Ta zmienna środowiskowa jest tworzona zarówno w Azure (ustawienia aplikacji funkcji) jak i lokalnie (local.settings.json) podczas operacji azd provision. Nazwy baz danych i kontenerów są zdefiniowane w konfiguracji wyzwalacza.

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; }
    }
}

Pełny projekt szablonu można przejrzeć tutaj.

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());
        }
    }
}

Pełny projekt szablonu można przejrzeć tutaj.

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}`);
        }
    }
});

Pełny projekt szablonu można przejrzeć tutaj.

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
});

Pełny projekt szablonu można przejrzeć tutaj.

Wyzwalacz jest zdefiniowany w tym pliku function.json :

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

Poniższy kod jest wykonywany po uruchomieniu wyzwalacza:

param($InputDocuments, $TriggerMetadata)

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

Pełny projekt szablonu można przejrzeć tutaj.

import json
import logging
import os

import azure.functions as func

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",
    lease_container_name="leases",
    lease_container_prefix="py-latest-version",
    change_feed_mode=func.CosmosDBChangeFeedMode.LATEST_VERSION,
)
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.")


def _get_change_details(change: func.Document):
    payload = dict(change)
    current = payload.get("current")
    metadata = payload.get("metadata")
    current_document = current if isinstance(current, dict) else payload
    change_metadata = metadata if isinstance(metadata, dict) else {}

    operation_type = change_metadata.get("operationType", "unknown")
    document_id = (
        current_document.get("id")
        or change_metadata.get("id")
        or payload.get("id")
    )
    lsn = change_metadata.get("lsn") or payload.get("_lsn")
    time_to_live_expired = change_metadata.get("timeToLiveExpired", False)
    return operation_type, document_id, lsn, time_to_live_expired


@app.cosmos_db_trigger(
    arg_name="changes",
    container_name=os.environ.get("COSMOS_CONTAINER_NAME"),
    database_name=os.environ.get("COSMOS_DATABASE_NAME"),
    connection="COSMOS_CONNECTION",
    lease_container_name="leases",
    lease_container_prefix="py-full-fidelity",
    change_feed_mode=func.CosmosDBChangeFeedMode.ALL_VERSIONS_AND_DELETES,
)
def cosmos_full_fidelity_trigger(changes: func.DocumentList):
    logging.info("Python Cosmos DB full-fidelity trigger processed %d changes.", len(changes))

    for index, change in enumerate(changes):
        operation_type, document_id, lsn, time_to_live_expired = (
            _get_change_details(change)
        )
        logging.info(
            "FullFidelity change index=%d operation=%s id=%s lsn=%s",
            index,
            operation_type,
            document_id,
            lsn,
        )
        if time_to_live_expired:
            logging.info("Document %s was deleted because its TTL expired.", document_id)
        logging.info(
            "FullFidelity raw[%d]=%s",
            index,
            json.dumps(dict(change), default=str),
        )

Pełny projekt szablonu można przejrzeć tutaj.