Mendapatkan Koleksi
Melakukan GET pada sumber daya koleksi tertentu mengambil properti untuk koleksi.
Catatan
Artikel referensi API ini menunjukkan cara membuat sumber daya menggunakan API sarana data Azure Cosmos DB. Dengan API sarana data, Anda dapat mengonfigurasi opsi dasar seperti kebijakan pengindeksan, kunci partisi seperti yang Anda dapat dengan Cosmos DB SDK. Jika Anda memerlukan dukungan fitur lengkap untuk semua sumber daya Azure Cosmos DB, sebaiknya gunakan Penyedia Sumber Daya Cosmos DB.
Minta
| Metode | Meminta URI | Deskripsi |
|---|---|---|
| GET | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id} | {databaseaccount} adalah nama akun Azure Cosmos DB yang dibuat di bawah langganan Anda. Nilai {db-id} adalah nama/ID database yang dihasilkan pengguna, bukan ID yang dihasilkan sistem (rid). Nilai {coll-id} adalah nama koleksi. |
Header
Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Cosmos DB.
Isi
Tidak ada.
Respons
Get Collection mengembalikan isi koleksi seperti yang bertahan di Cosmos DB bersama dengan header respons yang melaporkan kuota dan penggunaan koleksi.
Header
Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Cosmos DB.
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. |
| 404 Tidak Ditemukan | Koleksi bukan lagi sumber daya, yaitu koleksi dihapus. |
Isi
| Properti | Deskripsi |
|---|---|
| id | Ini adalah nama unik yang mengidentifikasi koleksi baru. |
| _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 izin. |
| _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 mewakili etag sumber daya yang diperlukan untuk kontrol konkurensi optimis. |
| _Doc | Ini adalah properti yang dihasilkan sistem yang menentukan jalur sumber daya dokumen yang dapat diatasi. |
| _sprocs | Ini adalah properti yang dihasilkan sistem yang menentukan jalur yang dapat diatasi dari sumber daya prosedur tersimpan (sprocs). |
| _Memicu | Ini adalah properti yang dihasilkan sistem yang menentukan jalur sumber daya pemicu yang dapat diatasi. |
| _udfs | Ini adalah properti yang dihasilkan sistem yang menentukan jalur yang dapat diatasi dari sumber daya fungsi yang ditentukan pengguna (udfs). |
| _Konflik | Ini adalah properti yang dihasilkan sistem yang menentukan jalur sumber daya konflik yang dapat diatasi. Selama operasi pada sumber daya dalam koleksi, jika konflik terjadi, pengguna dapat memeriksa sumber daya yang bertentangan dengan melakukan GET pada jalur URI yang bertentangan. |
| indexingPolicy | Ini adalah pengaturan kebijakan pengindeksan untuk pengumpulan. |
Properti di bawah Kebijakan Pengindeksan
| Properti | Deskripsi |
|---|---|
| Otomatis | Menunjukkan apakah pengindeksan otomatis aktif atau nonaktif. Nilai defaultnya adalah True, sehingga semua dokumen diindeks. Mengatur nilai ke False akan memungkinkan konfigurasi manual jalur pengindeksan. |
| indexingMode | Secara default, mode pengindeksan Konsisten. Ini berarti bahwa pengindeksan terjadi secara sinkron selama penyisipan, penggantian, atau penghapusan dokumen. Agar pengindeksan terjadi secara asinkron, atur mode pengindeksan menjadi malas. |
| includedPaths | Array yang berisi jalur dokumen yang akan diindeks. Secara default, dua jalur disertakan: jalur / yang menentukan bahwa semua jalur dokumen diindeks, dan jalur _ts, yang mengindeks perbandingan rentang tanda waktu. Dalam elemen dalam array. |
Properti di bawah Jalur yang Disertakan
| Properti | Deskripsi |
|---|---|
| jalur | Jalur tempat perilaku pengindeksan berlaku. Jalur indeks dimulai dengan root (/) dan biasanya diakhiri dengan operator wildcard tanda tanya (?), yang menunjukkan bahwa ada beberapa nilai yang mungkin untuk awalan. Misalnya, untuk melayani SELECT * FROM Family F WHERE F.familyName = "Andersen", Anda harus menyertakan jalur indeks untuk /familyName/? dalam kebijakan indeks koleksi. Jalur indeks juga dapat menggunakan operator kartubebas * untuk menentukan perilaku jalur secara rekursif di bawah awalan. Misalnya, /payload/* dapat digunakan untuk mengecualikan semuanya di bawah properti payload dari pengindeksan. |
| dataType | Ini adalah jenis data tempat perilaku pengindeksan diterapkan. Dapat berupa String, Number, Point, Polygon, atau LineString. Boolean dan null secara otomatis diindeks |
| jenis | Jenis indeks. Indeks hash berguna untuk perbandingan kesetaraan sementara indeks Rentang berguna untuk kesetaraan, perbandingan rentang, dan pengurutan. Indeks spasial berguna untuk kueri spasial. |
| Presisi | Presisi indeks. Dapat diatur ke -1 untuk presisi maksimum atau antara 1-8 untuk Angka, dan 1-100 untuk String. Tidak berlaku untuk jenis data Point, Polygon, dan LineString . |
Properti di bawah Kunci Partisi
| Properti | Deskripsi |
|---|---|
| jalur | Array jalur yang menggunakan data mana dalam koleksi yang dapat dipartisi. Jalur tidak boleh berisi kartubebas atau garis miring berikutnya. Misalnya, properti JSON "AccountNumber" ditentukan sebagai "/AccountNumber". Array hanya boleh berisi satu nilai. |
| jenis | Algoritma yang digunakan untuk pemartisian. Hanya Hash yang didukung. |
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}
Contoh
GET https://querydemo.documents.azure.com/dbs/testdb/colls HTTP/1.1
x-ms-offer-throughput: 1000
x-ms-date: Mon, 28 Mar 2016 21:02:12 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP8r7%2fEZnOxv2wQr2smp4G1tCH9PkOkIZscHqsqdn6y4%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
Content-Length: 235
Expect: 100-continue
HTTP/1.1 201 Created
Cache-Control: no-store, no-cache
Pragma: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Mon, 28 Mar 2016 20:10:13.601 GMT
etag: "00005600-0000-0000-0000-56f99bd50000"
collection-partition-index: 0
collection-service-index: 24
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb
x-ms-quorum-acked-lsn: 6
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 4.95
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: fbc3f36d-15d5-45fa-8f19-8579945451f8
x-ms-session-token: 0:7
Set-Cookie: x-ms-session-token#0=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
Set-Cookie: x-ms-session-token=7; Domain=querydemo.documents.azure.com; Path=/dbs/1tAvAA==/colls/1tAvAP4XWww=
x-ms-gatewayversion: version=1.6.52.5
Date: Mon, 28 Mar 2016 21:02:13 GMT
{
"id": "testcoll",
"indexingPolicy": {
"indexingMode": "consistent",
"automatic": true,
"includedPaths": [
{
"path": "/*",
"indexes": [
{
"kind": "Range",
"dataType": "String",
"precision": -1
},
{
"kind": "Range",
"dataType": "Number",
"precision": -1
}
]
}
],
"excludedPaths": []
},
"partitionKey": {
"paths": [
"/AccountNumber"
],
"kind": "Hash"
},
"_rid": "1tAvAP4XWww=",
"_ts": 1459198933,
"_self": "dbs/1tAvAA==/colls/1tAvAP4XWww=/",
"_etag": "\"00005600-0000-0000-0000-56f99bd50000\"",
"_docs": "docs/",
"_sprocs": "sprocs/",
"_triggers": "triggers/",
"_udfs": "udfs/",
"_conflicts": "conflicts/"
}