Membuat 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 Create Document membuat dokumen baru dalam koleksi.
Minta
| Metode | Meminta URI | Deskripsi |
|---|---|---|
| POSTING | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs | {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. |
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-is-upsert | Opsional | Boolean | Jika diatur ke true, Cosmos DB membuat dokumen dengan ID (dan nilai kunci partisi jika ada) jika tidak ada, atau memperbarui dokumen jika ada. |
| x-ms-indexing-direktif | Opsional | String | Nilai yang dapat diterima adalah Sertakan atau Kecualikan. - Sertakan menambahkan dokumen ke indeks. - Mengecualikan menghilangkan dokumen dari pengindeksan. Default untuk perilaku pengindeksan ditentukan oleh nilai properti otomatis dalam kebijakan pengindeksan untuk koleksi. |
Isi
| Properti | Diperlukan | Jenis | Deskripsi |
|---|---|---|---|
| id | Diperlukan | String | Ini adalah ID unik yang mengidentifikasi dokumen, yaitu, tidak ada dua dokumen yang harus berbagi id yang sama. Id tidak boleh melebihi 255 karakter. Bidang ID secara otomatis ditambahkan saat dokumen dibuat tanpa menentukan nilai ID. Namun, Anda selalu dapat memperbarui nilai ID dengan menetapkan nilai kustom ke nilai tersebut di isi permintaan. |
| <kustom> | Diperlukan | JSON | JSON yang ditentukan pengguna apa pun. |
{
"id": "AndersenFamily",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": null,
"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": true
}
Respons
Mengembalikan isi dokumen yang dibuat.
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. |
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 |
|---|---|
| 201 Dibuat | Operasi berhasil. |
| 400 Permintaan Buruk | Isi JSON tidak valid. |
| 403 Terlarang | Operasi tidak dapat diselesaikan karena batas penyimpanan partisi telah tercapai. |
| 409 Konflik | ID yang disediakan untuk dokumen baru telah diambil oleh dokumen yang sudah ada. |
| Entitas 413 Terlalu Besar | Ukuran dokumen dalam permintaan melebihi ukuran dokumen yang diizinkan. |
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": "AndersenFamily",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": null,
"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": true,
"_rid": "1KtjAImkcgwBAAAAAAAAAA==",
"_self": "dbs/1KtjAA==/colls/1KtjAImkcgw=/docs/1KtjAImkcgwBAAAAAAAAAA==/",
"_etag": "\"00003200-0000-0000-0000-56f9e84d0000\"",
"_ts": 1459218509,
"_attachments": "attachments/"
}
Contoh
POST https://querydemo.documents.azure.com/dbs/1KtjAA==/colls/1KtjAImkcgw=/docs 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
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=602; x-ms-session-token=602
Content-Length: 344
Expect: 100-continue
{
"id": "AndersenFamily",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": null,
"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": true
}
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: 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": "AndersenFamily",
"LastName": "Andersen",
"Parents": [
{
"FamilyName": null,
"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": true,
"_rid": "1KtjAImkcgwBAAAAAAAAAA==",
"_self": "dbs/1KtjAA==/colls/1KtjAImkcgw=/docs/1KtjAImkcgwBAAAAAAAAAA==/",
"_etag": "\"00003200-0000-0000-0000-56f9e84d0000\"",
"_ts": 1459218509,
"_attachments": "attachments/"
}