Share via

Dokumenty list (ReadFeed)

  • Artykuł

Wykonanie operacji GET dla zasobu dokumentów określonej kolekcji, tj. ścieżki identyfikatora URI dokumentacji, zwraca listę dokumentów w kolekcji. Funkcja ReadFeed może służyć do pobierania wszystkich dokumentów lub tylko przyrostowych zmian dokumentów w kolekcji.

Żądanie

Metoda Identyfikator URI żądania Opis
GET https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs Pamiętaj, że {databaseaccount} jest to nazwa konta usługi Azure Cosmos DB utworzonego w ramach subskrypcji. Wartość {db-id} jest identyfikatorem bazy danych, a wartość {coll-id} jest nazwą kolekcji.

Nagłówki

Zobacz Typowe nagłówki żądań REST usługi Azure Cosmos DB dla nagłówków , które są używane przez wszystkie żądania usługi Cosmos DB. Ważne nagłówki odpowiedzi dla dokumentu ReadFeed są następujące:

Nagłówek Wymagany Typ Opis
x-ms-max-item-count Opcjonalne Liczba Liczba całkowita wskazująca maksymalną liczbę elementów do zwrócenia na stronę.
x-ms-continuation Opcjonalne Ciąg Token ciągu zwracany dla zapytań i operacji źródła danych odczytu, jeśli jest więcej wyników do odczytania. Klienci mogą pobrać następną stronę wyników, ponownie przesyłając żądanie z nagłówkiem żądania x-ms-continuation ustawionym na tę wartość.
x-ms-consistency-level Opcjonalne Ciąg Jest to przesłonięcia na poziomie spójności. Prawidłowe wartości to: Silna, Powiązana, Sesja lub Ostateczna (w kolejności od najsilniejszych do najsłabszych). Przesłonięcia muszą być takie same lub słabsze niż skonfigurowany poziom spójności konta.
x-ms-session-token Opcjonalne Ciąg Token ciągu używany ze spójnością na poziomie sesji. Klienci muszą powtórzyć najnowszą wartość odczytu tego nagłówka podczas żądań odczytu w celu zapewnienia spójności sesji.
A-IM Opcjonalne Ciąg W przeciwnym razie musi być ustawiona wartość Incremental feed, lub pominięta. Dostępne od wersji 2016-07-11 interfejsu API REST.
If-None-Match Opcjonalne Ciąg

Brak nagłówka: zwraca wszystkie zmiany od początku (tworzenie kolekcji)

"*": zwraca wszystkie nowe zmiany danych w kolekcji

<etag>: jeśli ustawiono element ETag kolekcji, zwraca wszystkie zmiany wprowadzone od tego logicznego znacznika czasu.

Dostępne od wersji 2016-07-11 interfejsu API REST.
x-ms-documentdb-partitionkeyrangeid Opcjonalne Ciąg Identyfikator zakresu kluczy partycji do odczytywania danych. Dostępne od wersji 2016-07-11 interfejsu API REST.

Treść

Brak.

Reakcja

Zwraca tablicę dokumentów przechowywanych w kolekcji.

Nagłówki

Zobacz Typowe nagłówki odpowiedzi REST usługi Azure Cosmos DB dla nagłówków zwracanych przez wszystkie odpowiedzi usługi Cosmos DB. Ważne nagłówki odpowiedzi to:

Nagłówek Typ Opis
x-ms-continuation Ciąg Zwraca token, aby pobrać dodatkowe wyniki z operacji. Klient może ponownie przesłać żądanie z nagłówkiem zawierającym x-ms-continuation request tę wartość, aby wznowić wykonywanie.
x-ms-request-charge Liczba Liczba jednostek żądań używanych przez operację.
etag Ciąg

Numer sekwencji logicznej (LSN) ostatniego dokumentu zwrócony w odpowiedzi.

Incremental ReadDocumentFeed można wznowić, ponownie przesyłając tę wartość w polu If-None-Match.

Kody stanu

W poniższej tabeli wymieniono typowe kody stanu zwracane przez tę operację. Aby uzyskać pełną listę kodów stanu, zobacz Kody stanu HTTP.

Kod stanu HTTP Opis
200 OK Operacja zakończyła się pomyślnie.
400 Nieprawidłowe żądanie Przesłonięcia ustawione na poziomie spójności x-ms są silniejsze niż ten ustawiony podczas tworzenia konta. Jeśli na przykład poziom spójności to Sesja, przesłonięcia nie mogą być silne ani ograniczone.

Treść

Właściwość Opis
_rid Jest to identyfikator zasobu wygenerowany przez system dla kolekcji, w której znajdują się dokumenty.
_count Jest to liczba dokumentów zwracanych przez operację listy.
Documents Tablica dokumentów zwróconych przez operację.

Właściwości dokumentu

Właściwość Opis
id Jest to unikatowa nazwa identyfikująca dokument, tj. żadne dwa dokumenty nie mogą współużytkować tego samego iddokumentu. Długość id znaku nie może przekraczać 255 znaków.
<custom> Dowolny plik JSON zdefiniowany przez użytkownika.
_rid Jest to właściwość wygenerowana przez system. Identyfikator zasobu (_rid) to unikatowy identyfikator, który jest również hierarchiczny dla stosu zasobów w modelu zasobów. Jest on używany wewnętrznie do umieszczania zasobu dokumentu i nawigacji po nim.
_ts Jest to właściwość wygenerowana przez system. Określa ostatni zaktualizowany znacznik czasu zasobu. Wartość jest znacznikiem czasu.
_self Jest to właściwość wygenerowana przez system. Jest to unikatowy adresowy identyfikator URI zasobu.
_etag Jest to właściwość wygenerowana przez system, która określa zasób etag wymagany do optymistycznej kontroli współbieżności.
_attachments Jest to właściwość wygenerowana przez system, która określa ścieżkę adresową zasobu załączników. 
{  
  "_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  
}

Przykład

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  
}

Zobacz też