Liste (ReadFeed) Belgeleri

Makale
07/19/2023

Belirli bir koleksiyonun belge kaynağı üzerinde (belgeler URI yolu) get işlemi gerçekleştirmek, koleksiyonun altındaki belgelerin listesini döndürür. ReadFeed, tüm belgeleri veya yalnızca koleksiyondaki belgelerde yapılan artımlı değişiklikleri almak için kullanılabilir.

İstek

Yöntem	İstek URI'si	Açıklama
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	değerinin `{databaseaccount}` , aboneliğiniz altında oluşturulan Azure Cosmos DB hesabının adı olduğunu unutmayın. `{db-id}` Değer veritabanının kimliği, {coll-id} değeri ise koleksiyonun adıdır.

Üst Bilgiler

Tüm Cosmos DB istekleri tarafından kullanılan üst bilgiler için bkz. Yaygın Azure Cosmos DB REST isteği üst bilgileri. ReadFeed Belgesi için önemli yanıt üst bilgileri şunlardır:

Üst bilgi	Gerekli	Tür	Description
`x-ms-max-item-count`	İsteğe Bağlı	Sayı	Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.
`x-ms-continuation`	İsteğe Bağlı	Dize	Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen bir dize belirteci. İstemciler, x-ms-continuation istek üst bilgisi bu değere ayarlanmış isteği yeniden ileterek sonuçların sonraki sayfasını alabilir.
`x-ms-consistency-level`	İsteğe Bağlı	Dize	Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru). Geçersiz kılma, hesabın yapılandırılan tutarlılık düzeyinden aynı veya daha zayıf olmalıdır.
`x-ms-session-token`	İsteğe Bağlı	Dize	Oturum düzeyi tutarlılığı ile kullanılan dize belirteci. İstemcilerin oturum tutarlılığı için okuma istekleri sırasında bu üst bilginin en son okuma değerini yansıtması gerekir.
`A-IM`	İsteğe Bağlı	Dize	olarak ayarlanmalıdır `Incremental feed`veya aksi takdirde atlanmalıdır. REST API sürümünden `2016-07-11` itibaren kullanılabilir.
`If-None-Match`	İsteğe Bağlı	Dize	Üst bilgi yok: Baştan itibaren tüm değişiklikleri döndürür (koleksiyon oluşturma) "*": koleksiyondaki verilerde yapılan tüm yeni değişiklikleri döndürür <etag>: Koleksiyon ETag'i olarak ayarlanırsa, bu mantıksal zaman damgasından bu yana yapılan tüm değişiklikleri döndürür. REST API sürümünden `2016-07-11` itibaren kullanılabilir.
`x-ms-documentdb-partitionkeyrangeid`	İsteğe Bağlı	Dize	Verileri okumak için bölüm anahtarı aralığı kimliği. REST API sürümünden `2016-07-11` itibaren kullanılabilir.

Gövde

Yok.

Yanıt

Koleksiyonda depolanan bir belge dizisi döndürür.

Üst Bilgiler

Tüm Cosmos DB yanıtları tarafından döndürülen üst bilgiler için bkz. Genel Azure Cosmos DB REST yanıt üst bilgileri. Önemli yanıt üst bilgileri şunlardır:

Üst bilgi Tür Description

x-ms-continuation Dize İşlemden ek sonuçlar getirmek için bir belirteç döndürür. İstemci, yürütmeyi sürdürmek için isteği bu değeri içeren üst bilgiyle x-ms-continuation request yeniden gönderebilir.

x-ms-request-charge Sayı İşlem tarafından kullanılan istek birimi sayısı.

Üst bilgi	Tür	Description
`x-ms-continuation`	Dize	İşlemden ek sonuçlar getirmek için bir belirteç döndürür. İstemci, yürütmeyi sürdürmek için isteği bu değeri içeren üst bilgiyle `x-ms-continuation request` yeniden gönderebilir.
`x-ms-request-charge`	Sayı	İşlem tarafından kullanılan istek birimi sayısı.
`etag`	Dize	Yanıtta döndürülen son belgenin mantıksal sıra numarası (LSN). artımlı ReadDocumentFeed, bu değer If-None-Match içinde yeniden yayımlanarak sürdürülebilir.

etag

Dize

Yanıtta döndürülen son belgenin mantıksal sıra numarası (LSN).

artımlı ReadDocumentFeed, bu değer If-None-Match içinde yeniden yayımlanarak sürdürülebilir.

Durum kodları

Aşağıdaki tabloda bu işlem tarafından döndürülen genel durum kodları listelenmektedir. Durum kodlarının tam listesi için bkz. HTTP Durum Kodları.

HTTP durum kodu	Açıklama
200 Tamam	İşlem başarılı oldu.
400 Hatalı İstek	x-ms-consistency düzeyinde ayarlanan geçersiz kılma, hesap oluşturma sırasında ayarlanandan daha güçlüdür. Örneğin, tutarlılık düzeyi Oturum ise geçersiz kılma Güçlü veya Sınırlanmış olamaz.

Gövde

Özellik	Açıklama
`_rid`	Bu, belgelerin bulunduğu koleksiyon için sistem tarafından oluşturulan kaynak kimliğidir.
`_count`	Bu, liste işlemi tarafından döndürülen belge sayısıdır.
`Documents`	İşlem tarafından döndürülen belge dizisi.

Belgenin Özellikleri

Özellik	Açıklama
`id`	Bu, belgeyi tanımlayan benzersiz addır; diğer bir deyişle, iki belge aynı `id`öğesini paylaşamıyor. `id` 255 karakteri aşmamalıdır.
<custom>	Kullanıcı tanımlı herhangi bir JSON.
`_rid`	Bu, sistem tarafından oluşturulan bir özelliktir. Kaynak kimliği (`_rid`), kaynak modelinde kaynak yığını başına da hiyerarşik olan benzersiz bir tanımlayıcıdır. Belge kaynağının yerleştirilmesi ve gezinti için uygulama tarafından kullanılır.
`_ts`	Bu, sistem tarafından oluşturulan bir özelliktir. Kaynağın son güncelleştirilmiş zaman damgasını belirtir. Değer bir zaman damgasıdır.
`_self`	Bu, sistem tarafından oluşturulan bir özelliktir. Kaynak için benzersiz adreslenebilir URI'dir.
`_etag`	Bu, iyimser eşzamanlılık denetimi için gereken kaynağı `etag` belirten sistem tarafından oluşturulan bir özelliktir.
`_attachments`	Bu, ekler kaynağı için adreslenebilir yolu belirten sistem tarafından oluşturulan bir özelliktir.

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

Örnek

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  
}

Aracılığıyla paylaş

Liste (ReadFeed) Belgeleri

İstek

Üst Bilgiler

Gövde

Yanıt

Üst Bilgiler

Durum kodları

Gövde

Örnek

Ayrıca Bkz.

Ek kaynaklar