Melakukan Patch 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 melakukan Patch Document
pembaruan tingkat jalur untuk file/properti tertentu dalam satu dokumen.
Minta
Metode | Meminta URI | Deskripsi |
---|---|---|
PATCH | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{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 yang berisi dokumen. Id adalah nilai {id} dalam dokumen |
Header
Lihat Header permintaan Rest Azure Cosmos DB umum untuk header yang digunakan oleh semua permintaan Azure Cosmos DB.
Header | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-documentdb-partitionkey | Opsional | Array | Nilai kunci partisi untuk dokumen yang akan di-patch. Harus disertakan jika dan hanya jika koleksi dibuat dengan definisi partitionKey . |
Isi
Properti | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
Operasi | Diperlukan | Array | Patch mendukung operasi tunggal, atau beberapa, yang harus diteruskan sebagai array |
Operasi tunggal
{
"operations": [
{
"op": "set",
"path": "/Parents/0/FamilyName",
"value": "Bob"
}
]
}
Beberapa operasi
{
"operations":[
{
"op":"add",
"path":"/Parents/0/ZipCode",
"value":80000
},
{
"op": "set",
"path": "/Parents/0/FamilyName",
"value": "Bob"
}
]
}
Operasi Patch Kondisional
{
"condition":"from c where c.Address.ZipCode ='98101' ",
"operations":[
{
"op":"replace",
"path":"/Address/ZipCode",
"value":98107
}
]
}
Respons
Mengembalikan isi dokumen yang di-patch.
Header
Lihat Header respons Rest Azure Cosmos DB umum untuk header yang dikembalikan oleh semua respons Azure Cosmos DB.
Properti | 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. |
Lokasi Konten | String | URL konten patch yang sedang diteruskan. |
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. |
Prasyarat 412 Gagal | Pra-kondisi yang ditentukan tidak terpenuhi |
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 yang memiliki URI 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": "Andersen.1",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": "Bob",
"FirstName": "Thomas"
},
{
"FamilyName": null,
"FirstName": "Mary Kay"
}
],
"Children": [
{
"FamilyName": null,
"FirstName": "Henriette Thaulow",
"Gender": "female",
"Grade": 5,
"Pets": [
{
"GivenName": "Fluffy"
}
]
}
],
"Address": {
"State": "WA",
"County": "King",
"City": "Seattle"
},
"IsRegistered": false,
"_rid": "2pFqAMMTYY8BAAAAAAAAAA==",
"_self": "dbs/2pFqAA==/colls/2pFqAMMTYY8=/docs/2pFqAMMTYY8BAAAAAAAAAA==/",
"_etag": "\"00000000-0000-0000-d40e-691edfa901d7\"",
"_attachments": "attachments/",
"_ts": 1636313638
}
Contoh
PATCH https://querydemo.documents.azure.com/dbs/FamilyDatabase/colls/FamilyContainer/docs/Andersen.1 HTTP/1.1
x-ms-documentdb-partitionkey: ["Andersen"]
x-ms-date: Tue, 29 Mar 2016 02:28:29 GMT
Authorization: type%3dmaster%26ver%3d1.0%26sig%3d92WMAkQv0Zu35zpKZD%2bcGSH%2b2SXd8HGxHIvJgxhO6%2fs%3d
Content-Type:application/json_patch+json
Cache-Control: no-cache
User-Agent: Microsoft.Azure.DocumentDB/2.16.12
x-ms-version: 2015-12-16
Accept: application/json
Host: querydemo.documents.azure.com
Cookie: x-ms-session-token#0=602; x-ms-session-token=602
Content-Length: calculated when request is sent
Connection: keep-alive
{"operations":[{ "op" :"set", "path":"/Parents/0/FamilyName","value":"Bob" }]}
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/FamilyDatabase/colls/FamilyContainer/docs/Andersen.1
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-last-state-change-utc: Fri, 25 Mar 2016 22:39:02.501 GMT
etag: "00003200-0000-0000-0000-56f9e84d0000"
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;
x-ms-resource-usage: documentSize=0;documentsSize=1;collectionSize=1;
x-ms-schemaversion: 1.1
x-ms-alt-content-path: dbs/testdb/colls/testcoll
x-ms-quorum-acked-lsn: 602
x-ms-current-write-quorum: 3
x-ms-current-replica-set-size: 4
x-ms-request-charge: 12.38
x-ms-serviceversion: version=1.6.52.5
x-ms-activity-id: 856acd38-320d-47df-ab6f-9761bb987668
x-ms-session-token: 0:603
Set-Cookie: x-ms-session-token#0=603; Domain=querydemo.documents.azure.com; Path=/dbs/1KtjAA==/colls/1KtjAImkcgw=
Set-Cookie: x-ms-session-token=603; Domain=querydemo.documents.azure.com; Path=/dbs/1KtjAA==/colls/1KtjAImkcgw=
x-ms-gatewayversion: version=1.6.52.5
Date: Tue, 29 Mar 2016 02:28:30 GMT
{
"id": "Andersen.1",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": "Bob",
"FirstName": "Thomas"
},
{
"FamilyName": null,
"FirstName": "Mary Kay"
}
],
"Children": [
{
"FamilyName": null,
"FirstName": "Henriette Thaulow",
"Gender": "female",
"Grade": 5,
"Pets": [
{
"GivenName": "Fluffy"
}
]
}
],
"Address": {
"State": "WA",
"County": "King",
"City": "Seattle"
},
"IsRegistered": false,
"_rid": "2pFqAMMTYY8BAAAAAAAAAA==",
"_self": "dbs/2pFqAA==/colls/2pFqAMMTYY8=/docs/2pFqAMMTYY8BAAAAAAAAAA==/",
"_etag": "\"00000000-0000-0000-d464-a585d94d01d7\"",
"_attachments": "attachments/",
"_ts": 1636350676
}