Seznam dokumentů (ReadFeed)

Článek
08/05/2023

Provedení příkazu GET pro prostředek dokumentů konkrétní kolekce, tj. cesta identifikátoru URI docs, vrátí seznam dokumentů v kolekci. ReadFeed se dá použít k načtení všech dokumentů nebo jenom přírůstkových změn dokumentů v kolekci.

Žádost

Metoda	Identifikátor URI žádosti	Popis
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Všimněte si, že je `{databaseaccount}` název účtu Služby Azure Cosmos DB vytvořeného v rámci vašeho předplatného. Hodnota `{db-id}` je ID databáze a hodnota {coll-id} je název kolekce.

Hlavičky

Viz Běžné hlavičky požadavků REST služby Azure Cosmos DB pro hlavičky, které používají všechny požadavky služby Cosmos DB. Důležité hlavičky odpovědi pro dokument ReadFeed jsou následující:

Hlavička	Požaduje se	Typ	Description
`x-ms-max-item-count`	Volitelné	Číslo	Celé číslo označující maximální počet položek, které se mají vrátit na stránku.
`x-ms-continuation`	Volitelné	Řetězec	Token řetězce vrácený pro dotazy a operace pro čtení, pokud je potřeba přečíst další výsledky. Klienti můžou načíst další stránku výsledků opětovným odesláním požadavku s hlavičkou požadavku x-ms-continuation nastavenou na tuto hodnotu.
`x-ms-consistency-level`	Volitelné	Řetězec	Toto je přepsání úrovně konzistence. Platné hodnoty jsou: Silná, Ohraničená, Relace nebo Konečná (v pořadí od nejsilnějších po nejslabší). Přepsání musí být stejné nebo slabší než nakonfigurovaná úroveň konzistence účtu.
`x-ms-session-token`	Volitelné	Řetězec	Token řetězce používaný s konzistencí na úrovni relace. Klienti musí během požadavků na čtení z důvodu konzistence relací opakovat nejnovější hodnotu čtení této hlavičky.
`A-IM`	Volitelné	Řetězec	Musí být nastaven na `Incremental feed`hodnotu nebo jinak vynechán. K dispozici od verze `2016-07-11` rozhraní REST API.
`If-None-Match`	Volitelné	Řetězec	Bez záhlaví: Vrátí všechny změny od začátku (vytvoření kolekce). *: Vrátí všechny nové změny dat v kolekci. <etag>: Pokud je nastavená značka ETag kolekce, vrátí všechny změny provedené od logického časového razítka. K dispozici od verze `2016-07-11` rozhraní REST API.
`x-ms-documentdb-partitionkeyrangeid`	Volitelné	Řetězec	ID rozsahu klíčů oddílu pro čtení dat. K dispozici od verze `2016-07-11` rozhraní REST API.

Text

Žádné

Odpověď

Vrátí pole dokumentů uložených v kolekci.

Hlavičky

Viz Běžné hlavičky odpovědi REST služby Azure Cosmos DB pro hlavičky, které jsou vráceny všemi odpověďmi služby Cosmos DB. Důležité hlavičky odpovědi jsou:

Hlavička Typ Description

x-ms-continuation Řetězec Vrátí token pro načtení dalších výsledků z operace. Klient může znovu odeslat požadavek s hlavičkou x-ms-continuation request obsahující tuto hodnotu, aby se obnovilo provádění.

x-ms-request-charge Číslo Počet jednotek požadavků spotřebovaných operací.

Hlavička	Typ	Description
`x-ms-continuation`	Řetězec	Vrátí token pro načtení dalších výsledků z operace. Klient může znovu odeslat požadavek s hlavičkou `x-ms-continuation request` obsahující tuto hodnotu, aby se obnovilo provádění.
`x-ms-request-charge`	Číslo	Počet jednotek požadavků spotřebovaných operací.
`etag`	Řetězec	Logické pořadové číslo (LSN) posledního dokumentu vráceného v odpovědi. přírůstkové ReadDocumentFeed lze obnovit opětovným odesláním této hodnoty v if-none-match.

etag

Řetězec

Logické pořadové číslo (LSN) posledního dokumentu vráceného v odpovědi.

přírůstkové ReadDocumentFeed lze obnovit opětovným odesláním této hodnoty v if-none-match.

Stavové kódy

Následující tabulka uvádí běžné stavové kódy vrácené 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á.
400 – Chybný požadavek	Přepsání nastavené na úrovni x-ms-consistency-level je silnější než nastavení nastavené při vytváření účtu. Pokud je například úroveň konzistence Relace, nemůže být přepsání silné nebo ohraničené.

Text

Vlastnost	Popis
`_rid`	Toto je SYSTÉM generované ID prostředku pro kolekci, ve které se nacházejí dokumenty.
`_count`	Jedná se o počet dokumentů vrácených operací seznamu.
`Documents`	Pole dokumentů vrácených operací.

Vlastnosti dokumentu

Vlastnost	Popis
`id`	Jedná se o jedinečný název, který identifikuje dokument, tj. žádné dva dokumenty nemohou sdílet stejný `id`dokument . Hodnota `id` nesmí být delší než 255 znaků.
<custom>	Libovolný soubor JSON definovaný uživatelem.
`_rid`	Jedná se o systém 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ě pro umístění a navigaci v tomto prostředku dokumentu.
`_ts`	Jedná se o systém vygenerovanou vlastnost. Určuje časové razítko poslední aktualizace prostředku. Hodnota je časové razítko.
`_self`	Jedná se o systém vygenerovanou vlastnost. Jedná se o jedinečný adresovatelný identifikátor URI prostředku.
`_etag`	Toto je systémově vygenerovaná vlastnost, která určuje prostředek `etag` potřebný pro optimistické řízení souběžnosti.
`_attachments`	Jedná se o systém vygenerovanou vlastnost, která určuje adresovatelnou cestu pro prostředek příloh.

{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

Příklad

GET https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs HTTP/1.1  
x-ms-max-item-count: 10  
x-ms-documentdb-query-enablecrosspartition: False  
x-ms-date: Tue, 29 Mar 2016 02:03:06 GMT  
authorization: type%3dmaster%26ver%3d1.0%26sig%3dlmte5%2bJR8gIvDubFWZ0W2cgec22LcFAkZgDZxqOBsOI%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  
Cookie: x-ms-session-token#0=772; x-ms-session-token=772

HTTP/1.1 200 Ok  
Cache-Control: no-store, no-cache  
Pragma: no-cache  
Transfer-Encoding: chunked  
Content-Type: application/json  
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs  
Server: Microsoft-HTTPAPI/2.0  
Strict-Transport-Security: max-age=31536000  
x-ms-last-state-change-utc: Sun, 27 Mar 2016 22:39:13.369 GMT  
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;  
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;  
x-ms-item-count: 2  
x-ms-schemaversion: 1.1  
x-ms-alt-content-path: dbs/testdb/colls/testcoll  
x-ms-content-path: d9RzAJRFKgw=  
x-ms-request-charge: 1  
x-ms-serviceversion: version=1.6.52.5  
x-ms-activity-id: 46e2e9a5-4917-4ff6-9be5-6f206c38bb6b  
x-ms-session-token: 0:772  
Set-Cookie: x-ms-session-token#0=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
Set-Cookie: x-ms-session-token=772; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll  
x-ms-gatewayversion: version=1.6.52.5  
Date: Tue, 29 Mar 2016 02:03:07 GMT  
  
{  
  "_rid": "d9RzAJRFKgw=",  
  "Documents": [  
    {  
      "id": "SalesOrder1",  
      "ponumber": "PO18009186470",  
      "OrderDate": "2005-07-01T00:00:00",  
      "ShippedDate": "0001-01-01T00:00:00",  
      "AccountNumber": "Account1",  
      "SubTotal": 419.4589,  
      "TaxAmount": 12.5838,  
      "Freight": 472.3108,  
      "TotalDue": 985.018,  
      "Items": [  
        {  
          "OrderQty": 1,  
          "ProductId": 760,  
          "UnitPrice": 419.4589,  
          "LineTotal": 419.4589  
        }  
      ],  
      "_rid": "d9RzAJRFKgwBAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwBAAAAAAAAAA==/",  
      "_etag": "\"0000d986-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    },  
    {  
      "id": "SalesOrder2",  
      "ponumber": "PO15428132599",  
      "OrderDate": "2005-07-01T00:00:00",  
      "DueDate": "2005-07-13T00:00:00",  
      "ShippedDate": "2005-07-08T00:00:00",  
      "AccountNumber": "Account2",  
      "SubTotal": 6107.0820,  
      "TaxAmt": 586.1203,  
      "Freight": 183.1626,  
      "TotalDue": 4893.3929,  
      "DiscountAmt": 1982.872,  
      "Items": [  
        {  
          "OrderQty": 3,  
          "ProductCode": "A-123",  
          "ProductName": "Product 1",  
          "CurrencySymbol": "$",  
          "CurrencyCode": "USD",  
          "UnitPrice": 17.1,  
          "LineTotal": 5.7  
        }  
      ],  
      "_rid": "d9RzAJRFKgwCAAAAAAAAAA==",  
      "_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwCAAAAAAAAAA==/",  
      "_etag": "\"0000da86-0000-0000-0000-56f9e25b0000\"",  
      "_ts": 1459216987,  
      "_attachments": "attachments/"  
    }  
  ],  
  "_count": 2  
}

Sdílet prostřednictvím

Seznam dokumentů (ReadFeed)

Žádost

Hlavičky

Text

Odpověď

Hlavičky

Stavové kódy

Text

Příklad

Viz také

Další materiály