Auflisten von Dokumenten (ReadFeed)

  • Artikel

Durch das Ausführen einer GET-Anforderung für die Dokumentressource einer bestimmten Auflistung (also für den URI-Pfad docs) wird eine Liste der Dokumente unter der Auflistung zurückgegeben. ReadFeed kann verwendet werden, um alle Dokumente oder nur die inkrementellen Änderungen an Dokumenten innerhalb der Sammlung abzurufen.

Anforderung

Methode Anforderungs-URI BESCHREIBUNG
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs Beachten Sie, dass der {databaseaccount} Name des Azure Cosmos DB-Kontos ist, das unter Ihrem Abonnement erstellt wurde. Der {db-id} Wert ist id der Datenbank und {coll-id} der Name der Auflistung.

Header

Informationen zu Headern, die von allen Cosmos DB-Anforderungen verwendet werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Anforderungsheader . Die wichtigsten Antwortheader für ReadFeed Document lauten wie folgt:

Header Erforderlich type BESCHREIBUNG
x-ms-max-item-count Optional Number Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen.
x-ms-continuation Optional String Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. Clients können die nächste Seite der Ergebnisse abrufen, indem sie die Anforderung erneut übermitteln, wobei der Anforderungsheader x-ms-continuation auf diesen Wert festgelegt ist.
x-ms-consistency-level Optional String Dies ist die Überschreibung der Konsistenzebene. Die gültigen Werte sind: Strong, Bounded, Session oder Eventual (in der Reihenfolge der stärksten bis schwächsten). Die Außerkraftsetzung muss identisch oder schwächer als die konfigurierte Konsistenzebene des Kontos sein.
x-ms-session-token Optional String Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. Clients müssen den letzten Lesewert dieses Headers bei Leseanforderungen für Sitzungskonsistenz wiederholen.
A-IM Optional String Muss auf Incremental feedfestgelegt werden oder andernfalls ausgelassen werden. Verfügbar ab REST-API-Version 2016-07-11 .
If-None-Match Optional String

Kein Header: Gibt alle Änderungen von Beginn an (Sammlungserstellung) zurück

"*": Gibt alle neuen Änderungen an Daten in der Sammlung zurück

<etag>: Wenn sie auf ein Sammlungs-ETag festgelegt ist, werden alle Änderungen zurückgegeben, die seit diesem logischen Zeitstempel vorgenommen wurden.

Verfügbar ab REST-API-Version 2016-07-11 .
x-ms-documentdb-partitionkeyrangeid Optional String Die ID des Partitionsschlüsselbereichs zum Lesen von Daten. Verfügbar ab REST-API-Version 2016-07-11 .

Text

Keine.

Antwort

Gibt ein Array von Dokumenten zurück, die in der Auflistung gespeichert sind.

Header

Informationen zu Headern, die von allen Cosmos DB-Antworten zurückgegeben werden, finden Sie unter Allgemeine Azure Cosmos DB-REST-Antwortheader . Die wichtigsten Antwortheader sind:

Header type BESCHREIBUNG
x-ms-continuation String Gibt ein Token zurück, um zusätzliche Ergebnisse aus dem Vorgang abzurufen. Der Client kann die Anforderung erneut mit dem Header übermitteln, der x-ms-continuation request diesen Wert enthält, um die Ausführung fortzusetzen.
x-ms-request-charge Number Die Anzahl der vom Vorgang verbrauchten Anforderungseinheiten.
etag String

Die logische Sequenznummer (LSN) des letzten Dokuments, das in der Antwort zurückgegeben wurde.

Der inkrementelle ReadDocumentFeed kann durch erneutes Übermitteln dieses Werts in „If-None-Match“ fortgesetzt werden.

Statuscodes

In der folgenden Tabelle sind die allgemeinen Statuscodes aufgeführt, die von diesem Vorgang zurückgegeben werden. Eine vollständige Liste der status Codes finden Sie unter HTTP-Statuscodes.

HTTP-Statuscode BESCHREIBUNG
200 – OK Der Vorgang wurde durchgeführt.
400 – Ungültige Anforderung Die in "x-ms-consistency-level" festgelegte Konsistenzebene ist stärker als die während der Kontoerstellung festgelegte. Wenn die Konsistenzebene beispielsweise Session ist, kann die Außerkraftsetzung nicht Strong oder Bounded sein.

Body

Eigenschaft BESCHREIBUNG
_rid Dies ist die vom System generierte Ressourcen-ID für die Auflistung, in der sich die Dokumente befinden.
_count Dies ist die Anzahl der Dokumente, die vom Auflistungsvorgang zurückgegeben werden.
Documents Das Array von Dokumenten, das vom Vorgang zurückgegeben wird.

Eigenschaften des Dokuments

Eigenschaft BESCHREIBUNG
id Dies ist der eindeutige Name, der das Dokument identifiziert, d. h. keine zwei Dokumente können dieselbe idgemeinsam verwenden. Darf id 255 Zeichen nicht überschreiten.
<custom> Beliebiger benutzerdefinierter JSON-Code.
_rid Dies ist eine vom System generierte Eigenschaft. Die Ressourcen-ID (_rid) ist ein eindeutiger Bezeichner, der auch für den Ressourcenstapel im Ressourcenmodell hierarchisch ist. Sie wird intern für die Platzierung und Navigation der Dokumentressource verwendet.
_ts Dies ist eine vom System generierte Eigenschaft. Sie gibt den zuletzt aktualisierten Zeitstempel der Ressource an. Der Wert ist ein Zeitstempel.
_self Dies ist eine vom System generierte Eigenschaft. Es handelt sich um den eindeutigen, adressierbaren URI für die Ressource.
_etag Dies ist eine vom System generierte Eigenschaft, die die Ressource etag angibt, die für die Steuerung der optimistischen Parallelität erforderlich ist.
_attachments Dies ist eine vom System generierte Eigenschaft, die den adressierbaren Pfad der Anlagenressource angibt. 
{  
  "_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  
}

Beispiel

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  
}

Weitere Informationen