修補文件

發行項
08/05/2023

Azure Cosmos DB 是全域散發的多模型資料庫，並可支援多個 API。本文涵蓋適用於 Azure Cosmos DB 的 SQL API。

此作業會 Patch Document 針對單一檔中的特定檔案/屬性執行路徑層級更新。

要求

方法	要求 URI	Description
PATCH	HTTPs://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{id}	{databaseaccount} 是您訂用帳戶下建立的 Azure Cosmos DB 帳戶名稱。 {db-id} 值是資料庫的使用者產生名稱/識別碼，而不是系統產生的識別碼 (rid) 。 {coll-id} 值是包含檔的集合名稱。識別碼是檔中 {id} 的值

標題

如需所有 Azure Cosmos DB 要求所使用的標頭，請參閱常見的 Azure Cosmos DB REST 要求標頭。

標頭	必要	類型	Description
x-ms-documentdb-partitionkey	選擇性	Array	要修補之檔的分割區索引鍵值。只有在使用 partitionKey 定義建立集合時，才必須包含。

主體

屬性	必要	類型	Description
操作	必要	Array	Patch 支援應該以陣列的形式傳遞的單一或多個作業

單一作業

{
  "operations": [
    {
      "op": "set",
      "path": "/Parents/0/FamilyName",
      "value": "Bob"
    }
  ]
}

多個作業

{
   "operations":[
      {
         "op":"add",
         "path":"/Parents/0/ZipCode",
         "value":80000
      },
       {
      "op": "set",
       "path": "/Parents/0/FamilyName",
       "value": "Bob"
      }
   ]
}

條件式修補作業

{
   "condition":"from c where c.Address.ZipCode ='98101' ",
   "operations":[
      {
         "op":"replace",
         "path":"/Address/ZipCode",
         "value":98107
      }
   ]
}

回應

傳回已修補檔的本文。

標題

如需所有 Azure Cosmos DB 回應所傳回的標頭，請參閱常見的 Azure Cosmos DB REST 回應標頭。

屬性	類型	Description
x-ms-request-charge	數字	作業所耗用的要求單位數目。
x-ms-session-token	String	搭配工作階段層級一致性使用的字串權杖。用戶端必須儲存此值，並針對會話一致性的後續讀取要求設定此值。
內容位置	String	所傳遞修補程式內容的 URL。

狀態碼

下表列出此作業所傳回的常見狀態碼。如需狀態碼的完整清單，請參閱 HTTP 狀態碼。

HTTP 狀態碼	Description
200 確定	作業成功。
400 不正確的要求	JSON 內文無效。
412 先決條件失敗	不符合指定的預先條件

主體

屬性	Description
_擺脫	它是系統產生的屬性。資源識別碼 (_rid) 是資源模型上每個資源堆疊的階層式唯一識別碼。它是在內部用來放置和導覽文件資源。
_Ts	它是系統產生的屬性。代表資源的上次更新時間戳記。值為時間戳記。
_自我	它是系統產生的屬性，具有資源的 URI。
_Etag	它是系統產生的屬性，指定開放式並行控制所需的資源 etag 。
_附件	它是系統產生的屬性，指定附件資源的可定址路徑。

{
    "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
}

範例

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
}

共用方式為

修補文件

要求

標題

主體

單一作業

多個作業

條件式修補作業

回應

標題

狀態碼

主體

範例

另請參閱

其他資源