Gyűjtemény lekérése

  • Cikk

Ha egy GET-t hajt végre egy adott gyűjtemény-erőforráson, lekéri a gyűjtemény tulajdonságait.

Megjegyzés

Ezek az API-referenciacikkek bemutatják, hogyan hozhat létre erőforrásokat az Azure Cosmos DB adatsík API-val. Az adatsík API-val olyan alapvető beállításokat konfigurálhat, mint például az indexelési szabályzat, a partíciókulcsok ugyanúgy, mint a Cosmos DB SDK-k esetében. Ha teljes körű szolgáltatástámogatásra van szüksége az összes Azure Cosmos DB-erőforráshoz, javasoljuk, hogy használja a Cosmos DB erőforrás-szolgáltatót.

Kérés

Metódus Kérés URI-ja Leírás
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} A(z) {databaseaccount} az előfizetése alatt létrehozott Azure Cosmos DB-fiók neve. A(z) {db-id} érték az adatbázis felhasználó által létrehozott neve/azonosítója, nem pedig a rendszer által létrehozott azonosító (rid). A(z) {coll-id} érték a gyűjtemény neve.

Fejlécek

Az összes Cosmos DB-kérés által használt fejlécekhez tekintse meg az Azure Cosmos DB REST-kérések gyakori fejléceit .

Törzs

Nincsenek.

Reagálás

A Gyűjtemény lekérése a gyűjtemény törzsét adja vissza a Cosmos DB-ben megőrzött módon, valamint a gyűjtemény kvótáját és használatát jelentésként tartalmazó válaszfejléceket.

Fejlécek

Az összes Cosmos DB-válasz által visszaadott fejlécekhez tekintse meg az Azure Cosmos DB REST-válaszfejléceit .

Állapotkódok

Az alábbi táblázat a művelet által visszaadott gyakori állapotkódokat sorolja fel. Az állapotkódok teljes listáját lásd: HTTP-állapotkódok.

HTTP-állapotkód Leírás
200 Ok A művelet sikeres volt.
404 Nem található A gyűjtemény már nem erőforrás, azaz a gyűjtemény törölve lett.

Törzs

Tulajdonság Leírás
id Ez az új gyűjteményt azonosító egyedi név.
_Megszabadulni Ez egy rendszer által létrehozott tulajdonság. Az erőforrás-azonosító (_rid) egy egyedi azonosító, amely az erőforrás-modell erőforrás-verménként is hierarchikus. Belsőleg használják az engedélyerőforrás elhelyezésére és navigációjára.
_Ts Ez egy rendszer által létrehozott tulajdonság. Meghatározza az erőforrás utolsó frissített időbélyegét. Az érték egy időbélyeg.
_Önálló Ez egy rendszer által létrehozott tulajdonság. Ez az erőforrás egyedi címezhető URI-ja.
_Etag Ez egy rendszer által létrehozott tulajdonság, amely az optimista egyidejűség-vezérléshez szükséges erőforrás-etagot jelöli.
_Bizonylat Ez egy rendszer által létrehozott tulajdonság, amely meghatározza a dokumentum-erőforrás címzhető elérési útját.
_sprocs Ez egy rendszer által létrehozott tulajdonság, amely meghatározza a tárolt eljárások (sprocs) erőforrásának címezhető elérési útját.
_Eseményindítók Ez egy rendszer által létrehozott tulajdonság, amely meghatározza az eseményindítók erőforrásának címezhető elérési útját.
_udfs Ez egy rendszer által létrehozott tulajdonság, amely meghatározza a felhasználó által definiált függvények (udfs) erőforrásának címezhető elérési útját.
_Konfliktusok Ez egy rendszer által létrehozott tulajdonság, amely meghatározza az ütközések erőforrásának címezhető elérési útját. Egy gyűjteményen belüli erőforráson végzett művelet során, ha ütközés történik, a felhasználók megvizsgálhatják az ütköző erőforrásokat egy GET művelet végrehajtásával az ütközések URI-útvonalán.
indexelésPolicy Ez a gyűjtemény indexelési házirend-beállításai.

Tulajdonságok az Indexelési szabályzat alatt

Tulajdonság Leírás
automatikus Azt jelzi, hogy az automatikus indexelés be van-e kapcsolva vagy ki van-e kapcsolva. Az alapértelmezett érték Igaz, így minden dokumentum indexelve van. Ha hamis értékre állítja az értéket, az lehetővé teszi az indexelési útvonalak manuális konfigurálását.
indexelésMode Alapértelmezés szerint az indexelési mód Konzisztens. Ez azt jelenti, hogy az indexelés szinkron módon történik a dokumentumok beszúrása, cseréje vagy törlése során. Ha azt szeretné, hogy az indexelés aszinkron módon történjen, állítsa az indexelési módot lusta értékre.
includedPaths Az indexelendő dokumentumútvonalakat tartalmazó tömb. Alapértelmezés szerint két elérési út található: a / elérési út, amely meghatározza, hogy az összes dokumentumútvonalat indexelni kell, és a _ts elérési utat, amely indexel egy időbélyegtartomány összehasonlításához.

A tömb elemén belül.

Tulajdonságok a Belefoglalt elérési út területen

Tulajdonság Leírás
Elérési út Elérési út, amelyre az indexelési viselkedés vonatkozik. Az indexútvonalak a gyökérrel (/) kezdődnek, és általában a kérdőjel (?) helyettesítő karakter operátorával végződnek, és azt jelzik, hogy az előtagnak több lehetséges értéke is lehet. Ha például a SELECT * FROM Families F WHERE F.familyName = "Andersen" parancsot szeretné kiszolgálni, a /familyName/? a gyűjtemény indexszabályzatában.

Az index elérési útjai a * helyettesítő karakter operátorral is megadhatják az előtag alatti rekurzív elérési utak viselkedését. A /payload/* például a hasznos adat tulajdonság alatt lévő összes elem kizárására használható az indexelésből.
Adattípus Ez az az adattípus, amelyre az indexelési viselkedést alkalmazza a rendszer. Lehet sztring, szám, pont, sokszög vagy vonalsztring. A logikai értékeket és a null értékeket a rendszer automatikusan indexeli
Fajta Az index típusa. A kivonatindexek egyenlőségi összehasonlításokhoz hasznosak, míg a tartományindexek az egyenlőség, a tartomány-összehasonlítás és a rendezés szempontjából hasznosak. A térbeli indexek hasznosak térbeli lekérdezésekhez.
Precíziós Az index pontossága. A maximális pontossághoz -1, szám esetén 1–8, Sztring esetén pedig 1–100 értékre állítható be. Pont-, sokszög- és LineString-adattípusokhoz nem alkalmazható.

Tulajdonságok a Partíciókulcs területen

Tulajdonság Leírás
Görbék Olyan elérési utak tömbje, amelyek segítségével a gyűjteményen belüli adatok particionálhatók. Az elérési utak nem tartalmazhatnak helyettesítő karaktert vagy záró perjelet. Az "AccountNumber" JSON-tulajdonság például "/AccountNumber" néven van megadva. A tömbnek csak egyetlen értéket kell tartalmaznia.
Fajta A particionáláshoz használt algoritmus. Csak a kivonatok támogatottak. 
{  
  "id": "testcoll",  
  "indexingPolicy": {  
    "indexingMode": "consistent",  
    "automatic": true,  
    "includedPaths": [  
      {  
        "path": "/*",  
        "indexes": [  
          {  
            "kind": "Range",  
            "dataType": "String",  
            "precision": -1  
          },  
          {  
            "kind": "Range",  
            "dataType": "Number",  
            "precision": -1  
          }  
        ]  
      }  
    ],  
    "excludedPaths": []  
  },  
  "partitionKey": {  
    "paths": [  
      "/AccountNumber"  
    ],  
    "kind": "Hash"  
  },  
  "_rid": "1tAvAP4XWww=",  
  "_ts": 1459198933,  
  "_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",  
  "_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",  
  "_docs": "docs/",  
  "_sprocs": "sprocs/",  
  "_triggers": "triggers/",  
  "_udfs": "udfs/",  
  "_conflicts": "conflicts/"  
}

Példa

GET https://querydemo.documents.azure.com/dbs/testdb/colls HTTP/1.1  
x-ms-offer-throughput: 1000  
x-ms-date: Mon, 28 Mar 2016 21:02:12 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP8r7%2fEZnOxv2wQr2smp4G1tCH9PkOkIZscHqsqdn6y4%3d  
Cache-Control: no-cache  
User-Agent: Microsoft.Azure.Documents.Client/1.6.0.0  
x-ms-version: 2015-12-16  
Accept: application/json  
Host: querydemo.documents.azure.com  
Content-Length: 235  
Expect: 100-continue  
  

HTTP/1.1 201 Created  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Mon, 28 Mar 2016 20:10:13.601 GMT  
etag: "00005600-0000-0000-0000-56f99bd50000"  
collection-partition-index: 0  
collection-service-index: 24  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb  
x-ms-quorum-acked-lsn: 6  
x-ms-current-write-quorum: 3  
x-ms-current-replica-set-size: 4  
x-ms-request-charge: 4.95  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: fbc3f36d-15d5-45fa-8f19-8579945451f8  
x-ms-session-token: 0:7  
Set-Cookie: x-ms-session-token#0=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=  
Set-Cookie: x-ms-session-token=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=  
x-ms-gatewayversion: version=1.6.52.5  
Date: Mon, 28 Mar 2016 21:02:13 GMT  
  
{  
  "id": "testcoll",  
  "indexingPolicy": {  
    "indexingMode": "consistent",  
    "automatic": true,  
    "includedPaths": [  
      {  
        "path": "/*",  
        "indexes": [  
          {  
            "kind": "Range",  
            "dataType": "String",  
            "precision": -1  
          },  
          {  
            "kind": "Range",  
            "dataType": "Number",  
            "precision": -1  
          }  
        ]  
      }  
    ],  
    "excludedPaths": []  
  },  
  "partitionKey": {  
    "paths": [  
      "/AccountNumber"  
    ],  
    "kind": "Hash"  
  },  
  "_rid": "1tAvAP4XWww=",  
  "_ts": 1459198933,  
  "_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",  
  "_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",  
  "_docs": "docs/",  
  "_sprocs": "sprocs/",  
  "_triggers": "triggers/",  
  "_udfs": "udfs/",  
  "_conflicts": "conflicts/"  
}

Lásd még: