Delete Document
Azure Cosmos DB is a globally distributed multi-model database with support for multiple APIs. This article covers the SQL API for Azure Cosmos DB.
The Delete Document
operation deletes an existing document in a collection.
Request
Method | Request URI | Description |
---|---|---|
DELETE | https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-id} | Note that the {databaseaccount} is the name of the Azure Cosmos DB account created under your subscription. |
Headers
See Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests.
Header | Required | Type | Description |
---|---|---|---|
x-ms-documentdb-partitionkey |
Optional | Array | The partition key value for the document to be deleted. Must be included if and only if the collection is created with a partitionKey definition. |
Body
None.
Response
The service returns an empty response body.
Headers
See Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses. The important response headers for Delete Document are the following:
Property | Type | Description |
---|---|---|
x-ms-request-charge |
Number | The number of request units consumed by the operation. |
x-ms-session-token |
String | A string token used with session level consistency. Clients must save this value and set it for subsequent read requests for session consistency. |
Status codes
The following table lists common status codes returned by this operation. For a full list of status codes, see HTTP Status Codes.
HTTP status code | Description |
---|---|
204 No Content | The delete operation was successful. |
404 Not Found | The document is not found. |
Body
None.
Example
DELETE https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs/SalesOrder3 HTTP/1.1
x-ms-documentdb-partitionkey: ["Account1"]
x-ms-date: Tue, 29 Mar 2016 02:03:07 GMT
authorization: type%3dmaster%26ver%3d1.0%26sig%3dvR4ZglipsSQvOX176KTSLz7G21rfxS784sxfUEae4N0%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=775; x-ms-session-token=775
Content-Length: 0
HTTP/1.1 204 No Content
Cache-Control: no-store, no-cache
Pragma: no-cache
Content-Length: 0
Content-Type: application/json
Content-Location: https://querydemo.documents.azure.com/dbs/testdb/colls/testcoll/docs/SalesOrder3
Server: Microsoft-HTTPAPI/2.0
Strict-Transport-Security: max-age=31536000
x-ms-resource-quota: documentSize=10240;documentsSize=10485760;collectionSize=10485760;
x-ms-resource-usage: documentSize=0;documentsSize=2;collectionSize=2;
x-ms-alt-content-path: dbs/testdb/colls/testcoll
x-ms-content-path: d9RzAJRFKgw=
x-ms-request-charge: 9.33
x-ms-activity-id: 01b5b7fc-824d-4945-b6ce-4eb3532584a1
x-ms-session-token: 0:776
Set-Cookie: x-ms-session-token#0=776; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
Set-Cookie: x-ms-session-token=776; Domain=querydemo.documents.azure.com; Path=/dbs/testdb/colls/testcoll
Date: Tue, 29 Mar 2016 02:03:07 GMT