Lista dokument (ReadFeed)

Artikel
07/19/2023

När du utför en GET på dokumentresursen i en viss samling, dvs. dokument-URI-sökvägen, returneras en lista med dokument under samlingen. ReadFeed kan användas för att hämta alla dokument eller bara de inkrementella ändringarna av dokument i samlingen.

Förfrågan

Metod	URI för förfrågan	Beskrivning
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Observera att är namnet på det Azure Cosmos DB-konto som `{databaseaccount}` skapats under din prenumeration. Värdet `{db-id}` är ID för databasen och värdet {coll-id} är namnet på samlingen.

Sidhuvuden

Se Vanliga REST-begärandehuvuden för Azure Cosmos DB för rubriker som används av alla Cosmos DB-begäranden. De viktiga svarshuvudena för ReadFeed Document är följande:

Huvud	Krävs	Typ	Description
`x-ms-max-item-count`	Valfritt	Tal	Ett heltal som anger det maximala antalet objekt som ska returneras per sida.
`x-ms-continuation`	Valfritt	Sträng	En strängtoken som returneras för frågor och läsflödesåtgärder om det finns fler resultat att läsa. Klienter kan hämta nästa sida med resultat genom att skicka begäran på nytt med rubriken för x-ms-continuation-begäran inställd på det här värdet.
`x-ms-consistency-level`	Valfritt	Sträng	Det här är åsidosättningen på konsekvensnivå. Giltiga värden är: Stark, Begränsad, Session eller Slutlig (i den ordning som är starkast till svagast). Åsidosättningen måste vara samma eller svagare än kontots konfigurerade konsekvensnivå.
`x-ms-session-token`	Valfritt	Sträng	En strängtoken som används med konsekvens på sessionsnivå. Klienter måste upprepa det senaste läsvärdet för det här huvudet under läsbegäranden för sessionskonsekvens.
`A-IM`	Valfritt	Sträng	Måste anges till `Incremental feed`eller utelämnas på annat sätt. Tillgänglig från REST API-versionen `2016-07-11` och senare.
`If-None-Match`	Valfritt	Sträng	Inget sidhuvud: returnerar alla ändringar från början (samlingsskapande) "*": returnerar alla nya ändringar av data i samlingen <etag>: Om det är inställt på en samlings-ETag returneras alla ändringar som gjorts sedan den logiska tidsstämpeln. Tillgänglig från REST API-versionen `2016-07-11` och senare.
`x-ms-documentdb-partitionkeyrangeid`	Valfritt	Sträng	Partitionsnyckelns intervall-ID för att läsa data. Tillgänglig från REST API-versionen `2016-07-11` och senare.

Brödtext

Inga.

Svarsåtgärder

Returnerar en matris med dokument som lagras i samlingen.

Sidhuvuden

Se Vanliga AZURE Cosmos DB REST-svarshuvuden för rubriker som returneras av alla Cosmos DB-svar. De viktiga svarshuvudena är:

Huvud Typ Description

x-ms-continuation Sträng Returnerar en token för att hämta ytterligare resultat från åtgärden. Klienten kan skicka begäran igen med x-ms-continuation request huvudet som innehåller det här värdet för att återuppta körningen.

x-ms-request-charge Tal Antalet enheter för begäran som förbrukas av åtgärden.

Huvud	Typ	Description
`x-ms-continuation`	Sträng	Returnerar en token för att hämta ytterligare resultat från åtgärden. Klienten kan skicka begäran igen med `x-ms-continuation request` huvudet som innehåller det här värdet för att återuppta körningen.
`x-ms-request-charge`	Tal	Antalet enheter för begäran som förbrukas av åtgärden.
`etag`	Sträng	Det logiska sekvensnumret (LSN) för det senaste dokumentet som returnerades i svaret. inkrementell ReadDocumentFeed kan återupptas genom att det här värdet skickas på nytt i If-None-Match.

etag

Sträng

Det logiska sekvensnumret (LSN) för det senaste dokumentet som returnerades i svaret.

inkrementell ReadDocumentFeed kan återupptas genom att det här värdet skickas på nytt i If-None-Match.

Statuskoder

I följande tabell visas vanliga statuskoder som returneras av den här åtgärden. En fullständig lista över statuskoder finns i HTTP-statuskoder.

HTTP-statuskod	Beskrivning
200 OK	Åtgärden lyckades.
400 Felaktig begäran	Åsidosättningsuppsättningen på x-ms-consistency-level är starkare än den som angavs när kontot skapades. Om konsekvensnivån till exempel är Session kan åsidosättningen inte vara stark eller begränsad.

Brödtext

Egenskap	Beskrivning
`_rid`	Det här är det systemgenererade resurs-ID:t för samlingen där dokumenten finns.
`_count`	Det här är antalet dokument som returneras av liståtgärden.
`Documents`	Matrisen med dokument som returneras av åtgärden.

Egenskaper för dokument

Egenskap	Beskrivning
`id`	Det här är det unika namnet som identifierar dokumentet, dvs. inga två dokument kan dela samma `id`. Får `id` inte överstiga 255 tecken.
<anpassad>	Användardefinierad JSON.
`_rid`	Det här är en systemgenererad egenskap. Resurs-ID :t (`_rid`) är en unik identifierare som också är hierarkisk per resursstacken i resursmodellen. Den används internt för placering och navigering i dokumentresursen.
`_ts`	Det här är en systemgenererad egenskap. Den anger resursens senast uppdaterade tidsstämpel. Värdet är en tidsstämpel.
`_self`	Det här är en systemgenererad egenskap. Det är den unika adresserbara URI:n för resursen.
`_etag`	Det här är en systemgenererad egenskap som anger den resurs `etag` som krävs för optimistisk samtidighetskontroll.
`_attachments`	Det här är en systemgenererad egenskap som anger den adresserbara sökvägen för resursen för bifogade filer.

{  
  "_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  
}

Exempel

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  
}

Dela via

Lista dokument (ReadFeed)

Förfrågan

Sidhuvuden

Brödtext

Svarsåtgärder

Sidhuvuden

Statuskoder

Brödtext

Exempel

Se även

Ytterligare resurser