Mencantumkan (ReadFeed) Dokumen

Artikel
07/19/2023

Melakukan GET pada sumber daya dokumen dari koleksi tertentu, yaitu jalur URI dokumen, mengembalikan daftar dokumen di bawah koleksi. ReadFeed dapat digunakan untuk mengambil semua dokumen, atau hanya perubahan bertahap pada dokumen dalam koleksi.

Minta

Metode	Meminta URI	Deskripsi
GET	`https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs`	Perhatikan bahwa `{databaseaccount}` adalah nama akun Azure Cosmos DB yang dibuat di bawah langganan Anda. Nilainya `{db-id}` adalah id database dan nilai {coll-id} adalah nama koleksi.

Header

Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Cosmos DB. Header respons penting untuk Dokumen ReadFeed adalah sebagai berikut:

Header	Diperlukan	Jenis	Deskripsi
`x-ms-max-item-count`	Opsional	Telepon	Bilangan bulat yang menunjukkan jumlah maksimum item yang akan dikembalikan per halaman.
`x-ms-continuation`	Opsional	String	Token string dikembalikan untuk kueri dan operasi read-feed jika ada lebih banyak hasil yang akan dibaca. Klien dapat mengambil halaman hasil berikutnya dengan mengirimkan ulang permintaan dengan header permintaan x-ms-continuation yang diatur ke nilai ini.
`x-ms-consistency-level`	Opsional	String	Ini adalah penimpaan tingkat konsistensi. Nilai yang valid adalah: Kuat, Terikat, Sesi, atau Akhirnya (dalam urutan terkuat hingga terlemah). Penimpaan harus sama atau lebih lemah dari tingkat konsistensi akun yang dikonfigurasi.
`x-ms-session-token`	Opsional	String	Token string yang digunakan dengan konsistensi tingkat sesi. Klien harus menggemakan nilai baca terbaru header ini selama permintaan baca untuk konsistensi sesi.
`A-IM`	Opsional	String	Harus diatur ke `Incremental feed`, atau dihilangkan sebaliknya. Tersedia dari versi `2016-07-11` REST API dan seterusnya.
`If-None-Match`	Opsional	String	Tidak ada header: mengembalikan semua perubahan dari awal (pembuatan koleksi) "*": mengembalikan semua perubahan baru pada data dalam koleksi <etag>: Jika diatur ke ETag koleksi, mengembalikan semua perubahan yang dibuat sejak tanda waktu logis tersebut. Tersedia dari versi `2016-07-11` REST API dan seterusnya.
`x-ms-documentdb-partitionkeyrangeid`	Opsional	String	ID rentang kunci partisi untuk membaca data. Tersedia dari versi `2016-07-11` REST API dan seterusnya.

Isi

Tidak ada.

Respons

Mengembalikan array dokumen yang disimpan dalam koleksi.

Header

Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Cosmos DB. Header respons penting adalah:

Header Jenis Deskripsi

x-ms-continuation String Mengembalikan token untuk mengambil hasil tambahan dari operasi. Klien dapat mengirim ulang permintaan dengan header yang x-ms-continuation request berisi nilai ini untuk melanjutkan eksekusi.

x-ms-request-charge Telepon Jumlah unit permintaan yang digunakan oleh operasi.

Header	Jenis	Deskripsi
`x-ms-continuation`	String	Mengembalikan token untuk mengambil hasil tambahan dari operasi. Klien dapat mengirim ulang permintaan dengan header yang `x-ms-continuation request` berisi nilai ini untuk melanjutkan eksekusi.
`x-ms-request-charge`	Telepon	Jumlah unit permintaan yang digunakan oleh operasi.
`etag`	String	Nomor urutan logis (LSN) dari dokumen terakhir yang dikembalikan dalam respons. ReadDocumentFeed inkremental dapat dilanjutkan dengan mengirimkan ulang nilai ini di If-None-Match.

etag

String

Nomor urutan logis (LSN) dari dokumen terakhir yang dikembalikan dalam respons.

ReadDocumentFeed inkremental dapat dilanjutkan dengan mengirimkan ulang nilai ini di If-None-Match.

Kode status

Tabel berikut mencantumkan kode status umum yang dikembalikan oleh operasi ini. Untuk daftar lengkap kode status, lihat Kode Status HTTP.

Kode status HTTP	Deskripsi
200 OK	Operasi berhasil.
400 Permintaan Buruk	Pengambilalihan yang ditetapkan dalam x-ms-consistency-level lebih kuat daripada yang ditetapkan selama pembuatan akun. Misalnya, jika tingkat konsistensi adalah Sesi, penimpaan tidak boleh Kuat atau Terikat.

Isi

Properti	Deskripsi
`_rid`	Ini adalah ID sumber daya yang dihasilkan sistem untuk koleksi tempat dokumen berada.
`_count`	Ini adalah jumlah dokumen yang dikembalikan oleh operasi daftar.
`Documents`	Array dokumen yang dikembalikan oleh operasi.

Properti Dokumen

Properti	Deskripsi
`id`	Ini adalah nama unik yang mengidentifikasi dokumen, yaitu tidak ada dua dokumen yang dapat berbagi yang sama `id`. `id` tidak boleh melebihi 255 karakter.
<kustom>	JSON yang ditentukan pengguna apa pun.
`_rid`	Ini adalah properti yang dihasilkan sistem. ID sumber daya (`_rid`) adalah pengidentifikasi unik yang juga hierarkis per tumpukan sumber daya pada model sumber daya. Ini digunakan secara internal untuk penempatan dan navigasi sumber daya dokumen.
`_ts`	Ini adalah properti yang dihasilkan sistem. Ini menentukan tanda waktu terakhir yang diperbarui dari sumber daya. Nilainya adalah tanda waktu.
`_self`	Ini adalah properti yang dihasilkan sistem. Ini adalah URI unik yang dapat diatasi untuk sumber daya.
`_etag`	Ini adalah properti yang dihasilkan sistem yang menentukan sumber daya `etag` yang diperlukan untuk kontrol konkurensi optimis.
`_attachments`	Ini adalah properti yang dihasilkan sistem yang menentukan jalur yang dapat diatasi untuk sumber daya lampiran.

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

Contoh

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  
}

Mencantumkan (ReadFeed) Dokumen

Minta

Header

Isi

Respons

Header

Kode status

Isi

Contoh

Lihat juga

Sumber Daya Tambahan: