Data API az Azure DocumentDB-hez (előzetes verzió)

Az Azure DocumentDB-hez készült Data API egy https-felület, amellyel a fejlesztők adatbázis-illesztőprogram nélkül férhetnek hozzá és kezelhetik az adataikat. Leegyszerűsíti az adatműveleteket azáltal, hogy engedélyezi a vezérlősík- és aggregációs műveleteket HTTP-kéréseken keresztül. Ez az API ideális webalkalmazásokhoz, és biztonságos és méretezhető hozzáférést biztosít az adatbázisokhoz.

A Data API engedélyezése az Azure DocumentDB-ben

Ezt a funkciót az Azure Portal, az Azure CLI vagy egy ARM-sablon használatával engedélyezheti vagy tilthatja le.

A Data API engedélyezésének lépései az Azure Portalon

  1. Ugrás az Azure Portalra

    • portal.azure.com

  2. Menjen az Azure DocumentDB klaszterére

  3. Nyissa meg a "Szolgáltatások" panelt

  4. Kattintson a "Data API" ablakra

  5. Kattintson az "Engedélyezés" gombra

  6. Az eredmény ellenőrzése

    • A "Szolgáltatások" panelen mostantól a "Data API" "Be" értékként jelenik meg.

A Data API engedélyezésének lépései a fürtön az ARM-sablon segítségével

  1. Kapcsolati karakterlánc lekérése:

    • Kérje le a fürt kapcsolati karakterláncát az Azure Portalról.

  2. Hitelesítési jogkivonat lekérése:

    • Futtassa a következő parancsokat a Windows PowerShellben: 
      az login
az account get-access-token --resource-type arm

  3. PATCH-kérés küldése:

    • Használja az Azure Portal kapcsolati sztringét, és küldjön egy PATCH-kérést a következőkkel:
      • Hitelesítési jogkivonat: Használja a PowerShellből lekért jogkivonatot.
      • Törzs: 
        {
  "properties": {
    "dataApi": {
      "mode": "Enabled"
    }
  }
}

  4. Az eredmény ellenőrzése:

    • Győződjön meg arról, hogy a válasz adatcsomagja tartalmazza a következőt "dataApi": {"mode": "Enabled"}.
    • Ha a "Data API nem támogatott ezen a fürtön" hibaüzenet jelenik meg, vegye figyelembe, hogy csak az újonnan kiépített fürtök támogatják a Data API-t.

Fürtkonfiguráció frissítése

Kérelem

Módszer:PATCH
Végpont:https://eastus2euap.management.azure.com/subscriptions/<subscriptionId>/resourceGroups/<resourceGroup>/providers/Microsoft.DocumentDB/mongoClusters/<ClusterName>?api-version=2024-10-01-preview

Kérés tartalma

{
  "properties": {
    "dataApi": {
      "mode": "Enabled"
    }
  }
}

Kapcsolati sztring beszerzése

A fürt kapcsolati karakterláncának beszerzéséhez kövesse az alábbi lépéseket:

  1. Navigáljon az Ön által létrehozott fürtre.
  2. Válassza a Beállítások lehetőséget , és válassza a Kapcsolati sztringek lehetőséget.
  3. Másolja ki a megadott Data API-végpontot .

A Data API használata

Vizsgáljuk meg a támogatott műveleteket, a Data API használatát.

Aggregate

Ezzel a paranccsal összesítési műveletet hajthat végre egy gyűjteményen.

curl {cluster-name}.data.mongocluster.cosmos.azure.com:443/data/v1/action/aggregate -H "Content-Type: application/ejson" -H "Accept:application/ejson" -d '{"database" : "testDB", "collection" : "testCollection", "pipeline" : [{"$limit" : 500}]}' --user "{username}:{password}"

{ "documents" : [ { "_id" : { "$oid" : "680957492551581200c73bf8" }, "name" : "Sample Document", "createdAt" : { "$date" : { "$numberLong" : "1745442633506" } }, "tags" : [ "test", "mongo", "sample" ] } ] }

Adatbázisok listázása

Listázza a megadott fürt összes adatbázisát.

curl {cluster-name}.data.global.mongocluster.cosmos.azure.com:443/data/v1/action/listDatabases -H "Content-Type: application/ejson" -H "Accept:application/ejson" -d '{}' --user "{username}:{password}"

{ "databases" : [ { "name" : "testDB", "sizeOnDisk" : { "$numberInt" : "0" }, "empty" : false }, { "name" : "test", "sizeOnDisk" : { "$numberInt" : "0" }, "empty" : false } ], "totalSize" : { "$numberInt" : "0" }, "ok" : { "$numberDouble" : "1.0" } }

Listagyűjtemények

Egy adott adatbázis összes gyűjteményének listázása.

curl {cluster-name}.data.global.mongocluster.cosmos.azure.com:443/data/v1/action/listCollections -H "Content-Type: application/ejson" -H "Accept:application/ejson" -d '{"database": "newDB"}' --user "{username}:{password}"

{ "collections" : [ { "name" : "testCollection", "type" : "collection", "options" : {  }, "info" : { "readOnly" : false, "uuid" : { "$binary" : { "base64" : "mNh96KepTm+NtLtALGxDiw==", "subType" : "04" } } }, "idIndex" : { "v" : { "$numberInt" : "2" }, "name" : "_id_", "key" : { "_id" : { "$numberInt" : "1" } } } } ] }

Séma lekérése

Egy adott adatbázis sémaadatainak lekérése.

Az .md fájl formázott verziója:

curl {cluster-name}.data.mongocluster.cosmos.azure.com:443/data/v1/action/getSchema -H "Content-Type: application/ejson" -H "Accept:application/ejson" -d '{"database" : "testDB", "collection" : "testCollection"}' --user "{username}:{password}"

{ "_id" : { "bsonType" : "objectId" }, "name" : { "bsonType" : "string" }, "createdAt" : { "bsonType" : "date" }, "tags" : { "bsonType" : "array" } }

Limitations

  • Az újonnan létrehozott fürtön működik a Data API.
  • A Data API nem támogatja az újrafelhasználható hozzáférési jogkivonatokkal való hozzáférést.
  • Csak az adatsík-összesítést és a korlátozott vezérlősík-műveleteket támogatja.
  • Last updated on