Lijstdocumenten (Leesfeed)

Artikel
07/19/2023

Als u een GET uitvoert op de documentresource van een bepaalde verzameling, dat wil zeggen het docs-URI-pad, wordt een lijst met documenten onder de verzameling geretourneerd. ReadFeed kan worden gebruikt om alle documenten op te halen, of alleen de incrementele wijzigingen in documenten in de verzameling.

Aanvraag

Methode	Aanvraag-URI	Beschrijving
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Houd er rekening mee dat de `{databaseaccount}` naam is van het Azure Cosmos DB-account dat is gemaakt onder uw abonnement. De `{db-id}` waarde is de id van de database en de waarde {coll-id} is de naam van de verzameling.

Kopteksten

Zie Algemene Azure Cosmos DB REST-aanvraagheaders voor headers die worden gebruikt door alle Cosmos DB-aanvragen. De belangrijke antwoordheaders voor het ReadFeed-document zijn de volgende:

Header	Vereist	Type	Beschrijving
`x-ms-max-item-count`	Optioneel	Aantal	Een geheel getal dat het maximum aantal items aangeeft dat per pagina moet worden geretourneerd.
`x-ms-continuation`	Optioneel	Tekenreeks	Een tekenreekstoken dat wordt geretourneerd voor query's en leesfeedbewerkingen als er meer resultaten moeten worden gelezen. Clients kunnen de volgende pagina met resultaten ophalen door de aanvraag opnieuw in te dienen met de aanvraagheader x-ms-continuation ingesteld op deze waarde.
`x-ms-consistency-level`	Optioneel	Tekenreeks	Dit is de overschrijving van het consistentieniveau. De geldige waarden zijn: Sterk, Gebonden, Sessie of Uiteindelijk (in volgorde van sterk naar zwakste). De overschrijving moet hetzelfde of zwakker zijn dan het geconfigureerde consistentieniveau van het account.
`x-ms-session-token`	Optioneel	Tekenreeks	Een tekenreekstoken dat wordt gebruikt met consistentie op sessieniveau. Clients moeten de meest recente leeswaarde van deze header herhalen tijdens leesaanvragen voor sessieconsistentie.
`A-IM`	Optioneel	Tekenreeks	Moet worden ingesteld op `Incremental feed`of anders worden weggelaten. Beschikbaar vanaf REST API-versie `2016-07-11` .
`If-None-Match`	Optioneel	Tekenreeks	Geen koptekst: retourneert alle wijzigingen vanaf het begin (verzameling maken) *: retourneert alle nieuwe wijzigingen in gegevens in de verzameling <etag>: als deze is ingesteld op een verzameling-ETag, worden alle wijzigingen geretourneerd die zijn aangebracht sinds die logische tijdstempel. Beschikbaar vanaf REST API-versie `2016-07-11` .
`x-ms-documentdb-partitionkeyrangeid`	Optioneel	Tekenreeks	De id van het partitiesleutelbereik voor het lezen van gegevens. Beschikbaar vanaf REST API-versie `2016-07-11` .

Hoofdtekst

Geen.

Antwoord

Retourneert een matrix met documenten die zijn opgeslagen in de verzameling.

Kopteksten

Zie Algemene Azure Cosmos DB REST-antwoordheaders voor headers die worden geretourneerd door alle Cosmos DB-antwoorden. De belangrijke antwoordheaders zijn:

Header Type Beschrijving

x-ms-continuation Tekenreeks Retourneert een token om extra resultaten van de bewerking op te halen. De client kan de aanvraag opnieuw indienen met de x-ms-continuation request header die deze waarde bevat om de uitvoering te hervatten.

x-ms-request-charge Aantal Het aantal aanvraageenheden dat door de bewerking wordt verbruikt.

Header	Type	Beschrijving
`x-ms-continuation`	Tekenreeks	Retourneert een token om extra resultaten van de bewerking op te halen. De client kan de aanvraag opnieuw indienen met de `x-ms-continuation request` header die deze waarde bevat om de uitvoering te hervatten.
`x-ms-request-charge`	Aantal	Het aantal aanvraageenheden dat door de bewerking wordt verbruikt.
`etag`	Tekenreeks	Het logische volgnummer (LSN) van het laatste document dat in het antwoord is geretourneerd. Incrementele ReadDocumentFeed kan worden hervat door deze waarde opnieuw te verzenden in If-None-Match.

etag

Tekenreeks

Het logische volgnummer (LSN) van het laatste document dat in het antwoord is geretourneerd.

Incrementele ReadDocumentFeed kan worden hervat door deze waarde opnieuw te verzenden in If-None-Match.

Statuscodes

De volgende tabel bevat algemene statuscodes die door deze bewerking worden geretourneerd. Zie HTTP-statuscodes voor een volledige lijst met statuscodes.

HTTP-statuscode	Beschrijving
200 OK	De bewerking is geslaagd.
400 Ongeldige aanvraag	De onderdrukkingsset op x-ms-consistentieniveau is sterker dan de instelling die is ingesteld tijdens het maken van het account. Als het consistentieniveau bijvoorbeeld Sessie is, kan de onderdrukking niet Sterk of Gebonden zijn.

Hoofdtekst

Eigenschap	Beschrijving
`_rid`	Dit is de door het systeem gegenereerde resource-id voor de verzameling waarin de documenten zich bevinden.
`_count`	Dit is het aantal documenten dat door de lijstbewerking wordt geretourneerd.
`Documents`	De matrix met documenten die door de bewerking worden geretourneerd.

Eigenschappen van document

Eigenschap	Beschrijving
`id`	Dit is de unieke naam waarmee het document wordt aangeduid, dat wil zeggen dat geen twee documenten dezelfde `id`kunnen delen. De `id` mag niet langer zijn dan 255 tekens.
<aangepast>	Elke door de gebruiker gedefinieerde JSON.
`_rid`	Dit is een door het systeem gegenereerde eigenschap. De resource-id (`_rid`) is een unieke id die ook hiërarchisch is volgens de resourcestack in het resourcemodel. De id wordt intern gebruikt voor het plaatsen van en navigeren naar de documentresource.
`_ts`	Dit is een door het systeem gegenereerde eigenschap. Hiermee geeft u de laatst bijgewerkte tijdstempel van de resource op. De waarde is een tijdstempel.
`_self`	Dit is een door het systeem gegenereerde eigenschap. Dit is de unieke adresseerbare URI voor de resource.
`_etag`	Dit is een door het systeem gegenereerde eigenschap die de resource `etag` aangeeft die is vereist voor optimistisch gelijktijdigheidsbeheer.
`_attachments`	Dit is een door het systeem gegenereerde eigenschap waarmee het adresseerbare pad voor de bijlagenresource wordt opgegeven.

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

Voorbeeld

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  
}

Delen via

Lijstdocumenten (Leesfeed)

Aanvraag

Kopteksten

Hoofdtekst

Antwoord

Kopteksten

Statuscodes

Hoofdtekst

Voorbeeld

Zie ook

Aanvullende resources