Získání kolekce

Článek
08/05/2023

Provedení operace GET pro konkrétní prostředek kolekce načte vlastnosti kolekce.

Poznámka

Tyto články s referenčními informacemi o rozhraní API ukazují, jak vytvářet prostředky pomocí rozhraní API roviny dat služby Azure Cosmos DB. S rozhraním API roviny dat můžete nakonfigurovat základní možnosti, jako jsou zásady indexování, klíče oddílů podobně jako u sad SDK služby Cosmos DB. Pokud potřebujete úplnou podporu funkcí pro všechny prostředky Azure Cosmos DB, doporučujeme použít poskytovatele prostředků Cosmos DB.

Žádost

Metoda	Identifikátor URI žádosti	Popis
GET	https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}	{databaseaccount} je název účtu služby Azure Cosmos DB vytvořeného v rámci vašeho předplatného. Hodnota {db-id} je uživatelem vygenerované jméno/ID databáze, nikoli systémem generované ID (RID). Hodnota {coll-id} je název kolekce.

Hlavičky

Projděte si běžné hlavičky požadavků REST služby Azure Cosmos DB pro hlavičky, které se používají ve všech požadavcích služby Cosmos DB.

Text

Žádné

Odpověď

Funkce Get Collection vrátí tělo kolekce jako trvalé ve službě Cosmos DB spolu s hlavičkami odpovědi, které hlásí kvótu a využití kolekce.

Hlavičky

Projděte si běžné hlavičky odpovědi REST služby Azure Cosmos DB pro hlavičky, které vrací všechny odpovědi služby Cosmos DB.

Stavové kódy

Následující tabulka obsahuje seznam běžných stavových kódů vrácených touto operací. Úplný seznam stavových kódů najdete v tématu Stavové kódy HTTP.

Stavový kód HTTP	Popis
200 Ok	Operace byla úspěšná.
404 Nenalezeno	Kolekce už není prostředek, to znamená, že kolekce byla odstraněna.

Text

Vlastnost	Popis
id	Jedná se o jedinečný název, který identifikuje novou kolekci.
_Zbavit	Jedná se o systémem vygenerovanou vlastnost. ID prostředku (_rid) je jedinečný identifikátor, který je také hierarchický podle zásobníku prostředků v modelu prostředků. Používá se interně k umístění a navigaci prostředku oprávnění.
_Ts	Jedná se o systémem vygenerovanou vlastnost. Určuje časové razítko poslední aktualizace prostředku. Hodnota je časové razítko.
_Vlastní	Jedná se o systémem vygenerovanou vlastnost. Jedná se o jedinečný adresovatelný identifikátor URI prostředku.
_Etag	Jedná se o systémem vygenerovanou vlastnost představující etag prostředku vyžadovanou pro optimistické řízení souběžnosti.
_Doc	Jedná se o systémem vygenerovanou vlastnost, která určuje adresovatelnou cestu prostředku dokumentů.
_sprocs	Jedná se o systémem vygenerovanou vlastnost, která určuje adresovatelnou cestu prostředku uložených procedur (sprocs).
_Aktivační události	Jedná se o systémem vygenerovanou vlastnost, která určuje adresovatelnou cestu prostředku triggerů.
_Udf	Jedná se o systémem vygenerovanou vlastnost, která určuje adresovatelnou cestu k prostředku uživatelem definovaných funkcí (UDFs).
_Konflikty	Jedná se o systémem vygenerovanou vlastnost, která určuje adresovatelnou cestu konfliktního prostředku. Pokud během operace s prostředkem v rámci kolekce dojde ke konfliktu, můžou uživatelé zkontrolovat konfliktní prostředky provedením příkazu GET na cestě URI konfliktů.
zásady indexování	Jedná se o nastavení zásad indexování pro kolekci.

Vlastnosti v rámci zásad indexování

Vlastnost	Popis
automatická	Určuje, jestli je automatické indexování zapnuté nebo vypnuté. Výchozí hodnota je True, takže se všechny dokumenty indexují. Nastavení hodnoty na False by umožnilo ruční konfiguraci cest indexování.
indexingMode	Ve výchozím nastavení je režim indexování konzistentní. To znamená, že indexování probíhá synchronně během vkládání, nahrazování nebo odstraňování dokumentů. Pokud chcete, aby indexování probíhalo asynchronně, nastavte režim indexování na líný.
includedPaths	Pole obsahující cesty k dokumentu, které mají být indexovány. Ve výchozím nastavení jsou zahrnuty dvě cesty: cesta /, která určuje, že se mají indexovat všechny cesty k dokumentu, a _ts cesta, která indexuje pro porovnání rozsahů časových razítek. Uvnitř elementu v poli.

Vlastnosti v zahrnuté cestě

Vlastnost	Popis
Cestu	Cesta, pro kterou se chování indexování vztahuje. Cesty indexu začínají kořenovým znakem (/) a obvykle končí operátorem se zástupným znakem otazníku (?), což označuje, že předpona může mít více možných hodnot. Pokud například chcete zobrazit příkaz SELECT * FROM Families F WHERE F.familyName = "Andersen", musíte zahrnout cestu indexu pro /familyName/? v zásadách indexu kolekce. Cesty indexu mohou také použít zástupný operátor * k určení chování pro cesty rekurzivně pod předponou. Například /payload/* lze použít k vyloučení všeho v rámci vlastnosti datové části z indexování.
Datatype	Jedná se o datový typ, pro který se chování indexování používá. Může to být Řetězec, Číslo, Bod, Mnohoúhelník nebo LineString. Logické hodnoty a hodnoty null se automaticky indexují.
Druhu	Typ indexu. Indexy hash jsou užitečné pro porovnávání rovnosti, zatímco indexy rozsahů jsou užitečné pro rovnost, porovnávání rozsahů a řazení. Prostorové indexy jsou užitečné pro prostorové dotazy.
Přesnost	Přesnost indexu. Pro maximální přesnost lze nastavit hodnotu -1 nebo 1–8 pro Číslo a 1–100 pro Řetězec. Neplatí pro datové typy Point, Polygon a LineString .

Vlastnosti v části Klíč oddílu

Vlastnost	Popis
Cesty	Pole cest, pomocí kterých lze data v kolekci rozdělit. Cesty nesmí obsahovat zástupný znak ani koncové lomítko. Například vlastnost JSON AccountNumber je určená jako /AccountNumber. Pole musí obsahovat pouze jednu hodnotu.
Druhu	Algoritmus použitý k dělení. Podporuje se pouze hodnota Hash .

{  
  "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říklad

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/"  
}

Sdílet prostřednictvím

Získání kolekce

Žádost

Hlavičky

Text

Odpověď

Hlavičky

Stavové kódy

Text

Příklad

Viz také

Další materiály