Azure Cosmos DB-kötések az Azure Functions 1.x-hez

Az alábbi példa egy folyamatban lévő C# függvényt mutat be, amelyet akkor hív meg a rendszer, amikor beszúrások vagy frissítések vannak a megadott adatbázisban és gyűjteményben.

using Microsoft.Azure.Documents;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using System.Collections.Generic;

namespace CosmosDBSamplesV1
{
    public static class CosmosTrigger
    {
        [FunctionName("CosmosTrigger")]
        public static void Run([CosmosDBTrigger(
            databaseName: "ToDoItems",
            collectionName: "Items",
            ConnectionStringSetting = "CosmosDBConnection",
            LeaseCollectionName = "leases",
            CreateLeaseCollectionIfNotExists = true)]IReadOnlyList<Document> documents,
            TraceWriter log)
        {
            if (documents != null && documents.Count > 0)
            {
                log.Info($"Documents modified: {documents.Count}");
                log.Info($"First document Id: {documents[0].Id}");
            }
        }
    }
}

Az alábbi példa egy Azure Cosmos DB-eseményindító-kötést mutat be egy function.json fájlban és egy JavaScript-függvényben , amely a kötést használja. A függvény naplóüzeneteket ír az Azure Cosmos DB-rekordok módosításakor.

A kötési adatok a function.json fájlban:

{
    "type": "cosmosDBTrigger",
    "name": "documents",
    "direction": "in",
    "leaseCollectionName": "leases",
    "connectionStringSetting": "<connection-app-setting>",
    "databaseName": "Tasks",
    "collectionName": "Items",
    "createLeaseCollectionIfNotExists": true
}

A JavaScript-kód a következő:

    module.exports = async function (context, documents) {
        context.log('First document Id modified : ', documents[0].id);
    }

A folyamatban lévő C# osztálykódtárakhoz használja a CosmosDBTrigger attribútumot.

Az attribútum konstruktora az adatbázis nevét és a gyűjtemény nevét veszi fel. Ezekről a beállításokról és a konfigurálható egyéb tulajdonságokról az Eseményindító – konfiguráció című témakörben talál további információt. Íme egy CosmosDBTrigger attribútum- példa egy metódus-aláírásban:

    [FunctionName("DocumentUpdates")]
    public static void Run(
        [CosmosDBTrigger("database", "collection", ConnectionStringSetting = "myCosmosDB")]
    IReadOnlyList<Document> documents,
        TraceWriter log)
    {
        ...
    }

A teljes példáért tekintse meg az Eseményindító – C# példát.

Az attribútumokat a JavaScript nem támogatja.

Ez a szakasz a következő példákat tartalmazza:

• Üzenetsor-eseményindító, azonosító keresése a JSON-ból
• HTTP-eseményindító, azonosító keresése lekérdezési sztringből
• HTTP-eseményindító, azonosító keresése útvonaladatokból
• HTTP-eseményindító, azonosító keresése útvonaladatokból az SqlQuery használatával
• HTTP-eseményindító, több dokumentum lekérése az SqlQuery használatával
• HTTP-eseményindító, több dokumentum lekérése a DocumentClient használatával

A példák egy egyszerű ToDoItem típusra vonatkoznak:

namespace CosmosDBSamplesV1
{
    public class ToDoItem
    {
        public string Id { get; set; }
        public string Description { get; set; }
    }
}

Üzenetsor-eseményindító, azonosító keresése a JSON-ból

Az alábbi példa egy C# függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy JSON-objektumot tartalmazó üzenetsor-üzenet aktiválja. Az üzenetsor-eseményindító a JSON-t egy névvel ellátott ToDoItemLookupobjektumba elemzi, amely tartalmazza a keresendő azonosítót. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

namespace CosmosDBSamplesV1
{
    public class ToDoItemLookup
    {
        public string ToDoItemId { get; set; }
    }
}

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;

namespace CosmosDBSamplesV1
{
    public static class DocByIdFromJSON
    {
        [FunctionName("DocByIdFromJSON")]
        public static void Run(
            [QueueTrigger("todoqueueforlookup")] ToDoItemLookup toDoItemLookup,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{ToDoItemId}")]ToDoItem toDoItem,
            TraceWriter log)
        {
            log.Info($"C# Queue trigger function processed Id={toDoItemLookup?.ToDoItemId}");

            if (toDoItem == null)
            {
                log.Info($"ToDo item not found");
            }
            else
            {
                log.Info($"Found ToDo item, Description={toDoItem.Description}");
            }
        }
    }
}

HTTP-eseményindító, azonosító keresése lekérdezési sztringből

Az alábbi példa egy C# függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy olyan HTTP-kérés aktiválja, amely egy lekérdezési sztringgel adja meg a keresendő azonosítót. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using System.Net;
using System.Net.Http;

namespace CosmosDBSamplesV1
{
    public static class DocByIdFromQueryString
    {
        [FunctionName("DocByIdFromQueryString")]
        public static HttpResponseMessage Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]HttpRequestMessage req,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{Query.id}")] ToDoItem toDoItem,
            TraceWriter log)
        {
            log.Info("C# HTTP trigger function processed a request.");
            if (toDoItem == null)
            {
                log.Info($"ToDo item not found");
            }
            else
            {
                log.Info($"Found ToDo item, Description={toDoItem.Description}");
            }
            return req.CreateResponse(HttpStatusCode.OK);
        }
    }
}

HTTP-eseményindító, azonosító keresése útvonaladatokból

Az alábbi példa egy C# függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy HTTP-kérés aktiválja, amely útvonaladatokat használ a keresendő azonosító megadásához. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using System.Net;
using System.Net.Http;

namespace CosmosDBSamplesV1
{
    public static class DocByIdFromRouteData
    {
        [FunctionName("DocByIdFromRouteData")]
        public static HttpResponseMessage Run(
            [HttpTrigger(
                AuthorizationLevel.Anonymous, "get", "post",
                Route = "todoitems/{id}")]HttpRequestMessage req,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                Id = "{id}")] ToDoItem toDoItem,
            TraceWriter log)
        {
            log.Info("C# HTTP trigger function processed a request.");

            if (toDoItem == null)
            {
                log.Info($"ToDo item not found");
            }
            else
            {
                log.Info($"Found ToDo item, Description={toDoItem.Description}");
            }
            return req.CreateResponse(HttpStatusCode.OK);
        }
    }
}

Bemeneti példák kihagyása

HTTP-eseményindító, azonosító keresése útvonaladatokból az SqlQuery használatával

Az alábbi példa egy C# függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy HTTP-kérés aktiválja, amely útvonaladatokat használ a keresendő azonosító megadásához. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using System.Collections.Generic;
using System.Net;
using System.Net.Http;

namespace CosmosDBSamplesV1
{
    public static class DocByIdFromRouteDataUsingSqlQuery
    {
        [FunctionName("DocByIdFromRouteDataUsingSqlQuery")]
        public static HttpResponseMessage Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post",
                Route = "todoitems2/{id}")]HttpRequestMessage req,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                SqlQuery = "select * from ToDoItems r where r.id = {id}")] IEnumerable<ToDoItem> toDoItems,
            TraceWriter log)
        {
            log.Info("C# HTTP trigger function processed a request.");
            foreach (ToDoItem toDoItem in toDoItems)
            {
                log.Info(toDoItem.Description);
            }
            return req.CreateResponse(HttpStatusCode.OK);
        }
    }
}

Bemeneti példák kihagyása

HTTP-eseményindító, több dokumentum lekérése az SqlQuery használatával

Az alábbi példa egy C# függvényt mutat be, amely lekéri a dokumentumok listáját. A függvényt HTTP-kérés aktiválja. A lekérdezés az SqlQuery attribútumtulajdonságban van megadva.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using System.Collections.Generic;
using System.Net;
using System.Net.Http;

namespace CosmosDBSamplesV1
{
    public static class DocsBySqlQuery
    {
        [FunctionName("DocsBySqlQuery")]
        public static HttpResponseMessage Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]
                HttpRequestMessage req,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection",
                SqlQuery = "SELECT top 2 * FROM c order by c._ts desc")]
                IEnumerable<ToDoItem> toDoItems,
            TraceWriter log)
        {
            log.Info("C# HTTP trigger function processed a request.");
            foreach (ToDoItem toDoItem in toDoItems)
            {
                log.Info(toDoItem.Description);
            }
            return req.CreateResponse(HttpStatusCode.OK);
        }
    }
}

Bemeneti példák kihagyása

HTTP-eseményindító, több dokumentum lekérése a DocumentClient (C#) használatával

Az alábbi példa egy C# függvényt mutat be, amely lekéri a dokumentumok listáját. A függvényt HTTP-kérés aktiválja. A kód az DocumentClient Azure Cosmos DB-kötés által biztosított példányt használja a dokumentumok listájának olvasásához. A DocumentClient példány írási műveletekhez is használható.

using Microsoft.Azure.Documents.Client;
using Microsoft.Azure.Documents.Linq;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Azure.WebJobs.Host;
using System;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;

namespace CosmosDBSamplesV1
{
    public static class DocsByUsingDocumentClient
    {
        [FunctionName("DocsByUsingDocumentClient")]
        public static async Task<HttpResponseMessage> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)]HttpRequestMessage req,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection")] DocumentClient client,
            TraceWriter log)
        {
            log.Info("C# HTTP trigger function processed a request.");

            Uri collectionUri = UriFactory.CreateDocumentCollectionUri("ToDoItems", "Items");
            string searchterm = req.GetQueryNameValuePairs()
                .FirstOrDefault(q => string.Compare(q.Key, "searchterm", true) == 0)
                .Value;

            if (searchterm == null)
            {
                return req.CreateResponse(HttpStatusCode.NotFound);
            }

            log.Info($"Searching for word: {searchterm} using Uri: {collectionUri.ToString()}");
            IDocumentQuery<ToDoItem> query = client.CreateDocumentQuery<ToDoItem>(collectionUri)
                .Where(p => p.Description.Contains(searchterm))
                .AsDocumentQuery();

            while (query.HasMoreResults)
            {
                foreach (ToDoItem result in await query.ExecuteNextAsync())
                {
                    log.Info(result.Description);
                }
            }
            return req.CreateResponse(HttpStatusCode.OK);
        }
    }
}

Ez a szakasz a következő példákat tartalmazza:

• Üzenetsor-eseményindító, azonosító keresése a JSON-ból
• HTTP-eseményindító, azonosító keresése lekérdezési sztringből
• HTTP-eseményindító, azonosító keresése útvonaladatokból
• Üzenetsor-eseményindító, több dokumentum lekérése az SqlQuery használatával

Üzenetsor-eseményindító, azonosító keresése a JSON-ból

Az alábbi példa egy Azure Cosmos DB bemeneti kötést mutat be egy function.json fájlban, valamint egy JavaScript-függvényt , amely a kötést használja. A függvény egyetlen dokumentumot olvas be, és frissíti a dokumentum szöveges értékét.

A kötési adatok a function.json fájlban:

{
    "name": "inputDocumentIn",
    "type": "documentDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "id" : "{queueTrigger_payload_property}",
    "partitionKey": "{queueTrigger_payload_property}",
    "connection": "MyAccount_COSMOSDB",
    "direction": "in"
},
{
    "name": "inputDocumentOut",
    "type": "documentDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "createIfNotExists": false,
    "partitionKey": "{queueTrigger_payload_property}",
    "connection": "MyAccount_COSMOSDB",
    "direction": "out"
}

A konfigurációs szakasz ezeket a tulajdonságokat ismerteti.

A JavaScript-kód a következő:

    // Change input document contents using Azure Cosmos DB input binding, using context.bindings.inputDocumentOut
    module.exports = async function (context) {
        context.bindings.inputDocumentOut = context.bindings.inputDocumentIn;
        context.bindings.inputDocumentOut.text = "This was updated!";
    };

HTTP-eseményindító, azonosító keresése lekérdezési sztringből

Az alábbi példa egy JavaScript-függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy olyan HTTP-kérés aktiválja, amely egy lekérdezési sztringgel adja meg a keresendő azonosítót. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

Íme a function.json fájl:

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "documentDB",
      "name": "toDoItem",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connection": "CosmosDBConnection",
      "direction": "in",
      "Id": "{Query.id}"
    }
  ],
  "disabled": true
}

A JavaScript-kód a következő:

module.exports = async function (context, req, toDoItem) {
    context.log('JavaScript queue trigger function processed work item');
    if (!toDoItem)
    {
        context.log("ToDo item not found");
    }
    else
    {
        context.log("Found ToDo item, Description=" + toDoItem.Description);
    }
};

HTTP-eseményindító, azonosító keresése útvonaladatokból

Az alábbi példa egy JavaScript-függvényt mutat be, amely egyetlen dokumentumot kér le. A függvényt egy olyan HTTP-kérés aktiválja, amely egy lekérdezési sztringgel adja meg a keresendő azonosítót. Ez az azonosító egy dokumentum lekérésére ToDoItem szolgál a megadott adatbázisból és gyűjteményből.

Íme a function.json fájl:

{
  "bindings": [
    {
      "authLevel": "anonymous",
      "name": "req",
      "type": "httpTrigger",
      "direction": "in",
      "methods": [
        "get",
        "post"
      ],
      "route":"todoitems/{id}"
    },
    {
      "name": "$return",
      "type": "http",
      "direction": "out"
    },
    {
      "type": "documentDB",
      "name": "toDoItem",
      "databaseName": "ToDoItems",
      "collectionName": "Items",
      "connection": "CosmosDBConnection",
      "direction": "in",
      "Id": "{id}"
    }
  ],
  "disabled": false
}

A JavaScript-kód a következő:

module.exports = async function (context, req, toDoItem) {
    context.log('JavaScript queue trigger function processed work item');
    if (!toDoItem)
    {
        context.log("ToDo item not found");
    }
    else
    {
        context.log("Found ToDo item, Description=" + toDoItem.Description);
    }
};

Üzenetsor-eseményindító, több dokumentum lekérése az SqlQuery használatával

Az alábbi példa egy Azure Cosmos DB bemeneti kötést mutat be egy function.json fájlban, valamint egy JavaScript-függvényt , amely a kötést használja. A függvény egy SQL-lekérdezés által megadott több dokumentumot kér le egy üzenetsor-eseményindító használatával a lekérdezési paraméterek testreszabásához.

Az üzenetsor-eseményindító egy paramétert departmentIdbiztosít. Egy üzenetsor { "departmentId" : "Finance" } a pénzügyi részleg összes rekordját visszaadja.

A kötési adatok a function.json fájlban:

{
    "name": "documents",
    "type": "documentdb",
    "direction": "in",
    "databaseName": "MyDb",
    "collectionName": "MyCollection",
    "sqlQuery": "SELECT * from c where c.departmentId = {departmentId}",
    "connection": "CosmosDBConnection"
}

A konfigurációs szakasz ezeket a tulajdonságokat ismerteti.

A JavaScript-kód a következő:

    module.exports = async function (context, input) {
        var documents = context.bindings.documents;
        for (var i = 0; i < documents.length; i++) {
            var document = documents[i];
            // operate on each document
        }
    };

A folyamatban lévő C# osztálykódtárakban használja a DocumentDB attribútumot.

Az attribútum konstruktora az adatbázis nevét és a gyűjtemény nevét veszi fel. Ezekről a beállításokról és a konfigurálható egyéb tulajdonságokról az alábbi konfigurációs szakaszban tájékozódhat.

Az attribútumokat a JavaScript nem támogatja.

Ha a függvény sikeresen kilép, a bemeneti dokumentum nevesített bemeneti paraméterekkel végzett módosításai automatikusan megmaradnak.

A függvény kilépésekor a rendszer nem frissíti automatikusan a frissítéseket. Ehelyett használja context.bindings.<documentName>In és context.bindings.<documentName>Out végezze el a frissítéseket. Lásd a bemeneti példát.

Ez a szakasz a következő példákat tartalmazza:

• Üzenetsor-eseményindító, egy dokumentum írása
• Üzenetsor-eseményindító, dokumentumok írása a következő használatával: IAsyncCollector

A példák egy egyszerű ToDoItem típusra vonatkoznak:

namespace CosmosDBSamplesV1
{
    public class ToDoItem
    {
        public string Id { get; set; }
        public string Description { get; set; }
    }
}

Üzenetsor-eseményindító, egy dokumentum írása

Az alábbi példa egy C# függvényt mutat be, amely egy dokumentumot ad hozzá egy adatbázishoz a Queue Storage üzenetében megadott adatok használatával.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using System;

namespace CosmosDBSamplesV1
{
    public static class WriteOneDoc
    {
        [FunctionName("WriteOneDoc")]
        public static void Run(
            [QueueTrigger("todoqueueforwrite")] string queueMessage,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection")]out dynamic document,
            TraceWriter log)
        {
            document = new { Description = queueMessage, id = Guid.NewGuid() };

            log.Info($"C# Queue trigger function inserted one row");
            log.Info($"Description={queueMessage}");
        }
    }
}

Üzenetsor-eseményindító, dokumentumok írása az IAsyncCollector használatával

Az alábbi példa egy C# függvényt mutat be, amely dokumentumgyűjteményt ad hozzá egy adatbázishoz egy JSON üzenetben megadott adatok használatával.

using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using System.Threading.Tasks;

namespace CosmosDBSamplesV1
{
    public static class WriteDocsIAsyncCollector
    {
        [FunctionName("WriteDocsIAsyncCollector")]
        public static async Task Run(
            [QueueTrigger("todoqueueforwritemulti")] ToDoItem[] toDoItemsIn,
            [DocumentDB(
                databaseName: "ToDoItems",
                collectionName: "Items",
                ConnectionStringSetting = "CosmosDBConnection")]
                IAsyncCollector<ToDoItem> toDoItemsOut,
            TraceWriter log)
        {
            log.Info($"C# Queue trigger function processed {toDoItemsIn?.Length} items");

            foreach (ToDoItem toDoItem in toDoItemsIn)
            {
                log.Info($"Description={toDoItem.Description}");
                await toDoItemsOut.AddAsync(toDoItem);
            }
        }
    }
}

Az alábbi példa egy Azure Cosmos DB kimeneti kötést mutat be egy function.json fájlban, és egy JavaScript-függvényt , amely a kötést használja. A függvény egy üzenetsor bemeneti kötését használja egy üzenetsorhoz, amely a következő formátumban fogadja a JSON-t:

{
    "name": "John Henry",
    "employeeId": "123456",
    "address": "A town nearby"
}

A függvény minden rekordhoz az alábbi formátumban hozza létre az Azure Cosmos DB-dokumentumokat:

{
    "id": "John Henry-123456",
    "name": "John Henry",
    "employeeId": "123456",
    "address": "A town nearby"
}

A kötési adatok a function.json fájlban:

{
    "name": "employeeDocument",
    "type": "documentDB",
    "databaseName": "MyDatabase",
    "collectionName": "MyCollection",
    "createIfNotExists": true,
    "connection": "MyAccount_COSMOSDB",
    "direction": "out"
}

A konfigurációs szakasz ezeket a tulajdonságokat ismerteti.

A JavaScript-kód a következő:

    module.exports = async function (context) {

      context.bindings.employeeDocument = JSON.stringify({
        id: context.bindings.myQueueItem.name + "-" + context.bindings.myQueueItem.employeeId,
        name: context.bindings.myQueueItem.name,
        employeeId: context.bindings.myQueueItem.employeeId,
        address: context.bindings.myQueueItem.address
      });
    };

A folyamatban lévő C# osztálykódtárakban használja a DocumentDB attribútumot.

Az attribútum konstruktora az adatbázis nevét és a gyűjtemény nevét veszi fel. Ezekről a beállításokról és a konfigurálható egyéb tulajdonságokról további információt a Kimenet – konfiguráció című témakörben talál. Íme egy DocumentDB attribútum- példa egy metódus-aláírásban:

    [FunctionName("QueueToDocDB")]
    public static void Run(
        [QueueTrigger("myqueue-items", Connection = "AzureWebJobsStorage")] string myQueueItem,
        [DocumentDB("ToDoList", "Items", Id = "id", ConnectionStringSetting = "myCosmosDB")] out dynamic document)
    {
        ...
    }

Egy teljes példát a Kimenet című témakörben talál.

Az attribútumokat a JavaScript nem támogatja.