Ganti Dokumen
Azure Cosmos DB adalah database multi-model yang didistribusikan secara global dengan dukungan untuk beberapa API. Artikel ini membahas SQL API untuk Azure Cosmos DB.
Operasi menggantikan Replace Document seluruh konten dokumen.
Minta
| Metode | Meminta URI | Deskripsi |
|---|---|---|
| TEMPATKAN | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} | Perhatikan bahwa {databaseaccount} adalah nama akun 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. Nilai {doc-id} adalah id dokumen yang akan diganti. |
Header
Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Cosmos DB. Header penting untuk permintaan ini adalah:
| Header | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| x-ms-indexing-direktif | Opsional | String | Nilai yang dapat diterima adalah Sertakan atau Kecualikan. Sertakan menyertakan dokumen dalam jalur pengindeksan sementara Kecualikan menghilangkan dokumen dari pengindeksan. |
| x-ms-documentdb-partitionkey | Opsional | Array | Nilai kunci partisi untuk dokumen yang akan dihapus. Diperlukan jika dan harus ditentukan hanya jika koleksi dibuat dengan definisi partitionKey . |
| If-Match | Opsional | String | Digunakan untuk membuat kondisi operasi untuk konkurensi optimis. Artinya, dokumen diperbarui hanya jika etag yang ditentukan cocok dengan versi saat ini dalam database. Nilai harus diatur ke nilai etag sumber daya. |
Isi
| Properti | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| id | Diperlukan | String | Ini adalah properti yang dapat diatur pengguna. Ini adalah nama unik untuk mengidentifikasi dokumen, yaitu, tidak ada dua dokumen yang harus berbagi ID yang sama. ID tidak boleh melebihi 255 karakter. |
| <kustom> | Diperlukan | JSON | JSON yang ditentukan pengguna apa pun. |
{
"id": "_SalesOrder5",
"AccountNumber": "NewUser01",
"PurchaseOrderNumber": "PO18009186470",
"OrderDate": "2016-03-29T02:03:07.3526153Z",
"Total": 5.95,
"_rid": "d9RzAJRFKgwEAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA==/",
"_etag": "\"0000de86-0000-0000-0000-56f9e25c0000\"",
"_ts": 1459216988,
"_attachments": "attachments/",
"shippedDate": "2016-03-29T02:03:07.4680723Z",
"foo": "bar"
}
Respons
Ganti Dokumen mengembalikan isi dokumen yang diperbarui.
Header
Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Cosmos DB. Header respons penting untuk Ganti Dokumen adalah sebagai berikut:
| Header | Jenis | Deskripsi |
|---|---|---|
| x-ms-request-charge | Telepon | Jumlah unit permintaan yang digunakan oleh operasi. |
| x-ms-session-token | String | Token string yang digunakan dengan konsistensi tingkat sesi. Klien harus menyimpan nilai ini dan mengaturnya untuk permintaan baca berikutnya untuk konsistensi sesi. |
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 | Isi JSON tidak valid. Periksa tanda kurung keriting atau tanda kutipan yang hilang. |
| 404 Tidak Ditemukan | Dokumen sudah tidak ada lagi, yaitu dokumen dihapus. |
| 409 Konflik | Id yang disediakan untuk dokumen baru telah diambil oleh dokumen yang sudah ada. |
| Entitas 413 Terlalu Besar | Ukuran dokumen dalam permintaan melampaui ukuran dokumen yang diizinkan dalam permintaan. |
Isi
| Properti | Deskripsi |
|---|---|
| _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 etag sumber daya yang diperlukan untuk kontrol konkurensi optimis. |
| _Lampiran | Ini adalah properti yang dihasilkan sistem yang menentukan jalur yang dapat diatasi untuk sumber daya lampiran. |
{
"id": "_SalesOrder5",
"AccountNumber": "NewUser01",
"PurchaseOrderNumber": "PO18009186470",
"OrderDate": "2016-03-29T02:03:07.3526153Z",
"Total": 5.95,
"_rid": "d9RzAJRFKgwEAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA==/",
"_etag": "\"0000df86-0000-0000-0000-56f9e25c0000\"",
"_ts": 1459216988,
"_attachments": "attachments/",
"shippedDate": "2016-03-29T02:03:07.4680723Z",
"foo": "bar"
}
Contoh
PUT https://querydemo.documents.azure.com/dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA== HTTP/1.1
x-ms-documentdb-partitionkey: []
x-ms-date: Tue, 29 Mar 2016 02:03:07 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dP7DBdb6lXOnL55kXRL2L%2frt3PE8kybJCIT%2ffViY7UhU%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=777; x-ms-session-token=777
Content-Length: 405
Expect: 100-continue
{
"id": "_SalesOrder5",
"AccountNumber": "NewUser01",
"PurchaseOrderNumber": "PO18009186470",
"OrderDate": "2016-03-29T02:03:07.3526153Z",
"Total": 5.95,
"_rid": "d9RzAJRFKgwEAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA==/",
"_etag": "\"0000de86-0000-0000-0000-56f9e25c0000\"",
"_ts": 1459216988,
"_attachments": "attachments/",
"shippedDate": "2016-03-29T02:03:07.4680723Z",
"foo": "bar"
}
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/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA==
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Fri, 25 Mar 2016 21:55:47.482 GMT
etag: "0000df86-0000-0000-0000-56f9e25c0000"
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;
x-ms-resource-usage: documentSize=0;documentsSize=3;collectionSize=3;
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb/colls/testcoll
x-ms-quorum-acked-lsn: 777
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 10.67
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: a86cddb9-75f6-423e-8d42-f6b5ac817209
x-ms-session-token: 0:778
Set-Cookie: x-ms-session-token#0=778; Domain=querydemo.documents.azure.com; Path=/dbs/d9RzAA==/colls/d9RzAJRFKgw=
Set-Cookie: x-ms-session-token=778; Domain=querydemo.documents.azure.com; Path=/dbs/d9RzAA==/colls/d9RzAJRFKgw=
x-ms-gatewayversion: version=1.6.52.5
Date: Tue, 29 Mar 2016 02:03:07 GMT
{
"id": "_SalesOrder5",
"AccountNumber": "NewUser01",
"PurchaseOrderNumber": "PO18009186470",
"OrderDate": "2016-03-29T02:03:07.3526153Z",
"Total": 5.95,
"_rid": "d9RzAJRFKgwEAAAAAAAAAA==",
"_self": "dbs/d9RzAA==/colls/d9RzAJRFKgw=/docs/d9RzAJRFKgwEAAAAAAAAAA==/",
"_etag": "\"0000df86-0000-0000-0000-56f9e25c0000\"",
"_ts": 1459216988,
"_attachments": "attachments/",
"shippedDate": "2016-03-29T02:03:07.4680723Z",
"foo": "bar"
}