Belge değiştirmeReplace a Document

Azure Cosmos DB birden çok API desteği olan global olarak dağıtılmış, çok modelli bir veritabanıdır.Azure Cosmos DB is a globally distributed multi-model database with support for multiple APIs. Bu makale Azure Cosmos DB için SQL API’sini kapsar.This article covers the SQL API for Azure Cosmos DB.

Replace Documentİşlem, bir belgenin tüm içeriğinin yerini alır.The Replace Document operation replaces the entire content of a document.

İstekRequest

YöntemMethod İstek URI'siRequest URI DescriptionDescription
PUTPUT https://{databaseaccount}. Documents. Azure. com/DBS/{DB-ID}/colls/{coll-id}/docs/{doc-Name}https://{databaseaccount}.documents.azure.com/dbs/{db-id}/colls/{coll-id}/docs/{doc-name} {Databaseaccount} öğesinin aboneliğiniz altında oluşturulan Cosmos DB hesabının adı olduğunu unutmayın.Note that the {databaseaccount} is the name of the Cosmos DB account created under your subscription. {DB-id} değeri, sistem tarafından oluşturulan KIMLIK (RID) değil, veritabanının kullanıcı tarafından oluşturulan adıdır/kimliğidir.The {db-id} value is the user generated name/id of the database, not the system generated ID (rid). {Coll-id} değeri koleksiyonun adıdır.The {coll-id} value is the name of the collection. {Doc-Name} değeri, değiştirilmekte olan belgenin adıdır.The {doc-name} value is the name of the document to be replaced.

Üst BilgilerHeaders

Tüm Cosmos DB istekleri tarafından kullanılan üst bilgiler için bkz. ortak Azure Cosmos DB Rest istek üst bilgileri .See Common Azure Cosmos DB REST request headers for headers that are used by all Cosmos DB requests. Bu istek için önemli üstbilgiler şunlardır:The important headers for this request are:

Üst bilgiHeader GerekliRequired TürType DescriptionDescription
x-MS-Indexing-yönergesix-ms-indexing-directive İsteğe BağlıOptional DizeString Kabul edilebilir değerler dahil edilir veya hariç tutabilir.The acceptable values are Include or Exclude. Dahil etme , dizin oluşturma yolundaki belgeyi dizine alma Işleminden hariç tutar .Include includes the document in the indexing path while Exclude omits the document from indexing.
x-MS-DocumentDB-partitionkeyx-ms-documentdb-partitionkey İsteğe BağlıOptional DiziArray Silinecek belge için bölüm anahtarı değeri.The partition key value for the document to be deleted. Ve yalnızca koleksiyonun bir Partitionkey tanımıyla oluşturulması durumunda belirtilmesi gerekir.Required if and must be specified only if the collection is created with a partitionKey definition.
IF-MatchIf-Match İsteğe BağlıOptional DizeString İyimser eşzamanlılık için işlem koşullu yapmak için kullanılır.Used to make operation conditional for optimistic concurrency. Diğer bir deyişle, belge yalnızca belirtilen ETag, veritabanındaki geçerli sürümle eşleşiyorsa güncelleştirilir.That is, the document is updated only if the specified etag matches the current version in the database. Değer, kaynağın ETag değerine ayarlanmalıdır.The value should be set to the etag value of the resource.

GövdeBody

ÖzellikProperty GerekliRequired TürType DescriptionDescription
idid GerekliRequired DizeString Bu, Kullanıcı tarafından ayarlanabilir bir özelliktir.It is a user settable property. Bir belgeyi tanımlamak için benzersiz bir addır, yani iki belge aynı kimliğipaylaşmamalıdır.It is a unique name to identify a document, that is, no two documents should share the same ID. Kimliğin 255 karakteri aşmaması gerekir.The ID must not exceed 255 characters.
<custom> GerekliRequired JSONJSON Kullanıcı tanımlı tüm JSON.Any user-defined JSON.
{  
  "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"  
}  
  

YanıtResponse

Değiştirme belgesi, güncelleştirilmiş belge gövdesini döndürür.Replace Document returns the updated document body.

Üst BilgilerHeaders

Tüm Cosmos DB yanıtları tarafından döndürülen üst bilgiler için bkz. ortak Azure Cosmos DB Rest yanıt üst bilgileri .See Common Azure Cosmos DB REST response headers for headers that are returned by all Cosmos DB responses. Değiştirme belgesi için önemli yanıt üst bilgileri şunlardır:The important response headers for Replace Document are the following:

Üst bilgiHeader TürType DescriptionDescription
x-MS-istek ücretix-ms-request-charge SayıNumber İşlem tarafından tüketilen istek birimi sayısı.The number of request units consumed by the operation.
x-MS-Session-Tokenx-ms-session-token DizeString Oturum düzeyi tutarlılığı ile kullanılan bir dize belirteci.A string token used with session level consistency. İstemcilerin bu değeri kaydetmesi ve oturum tutarlılığı için sonraki okuma istekleri için ayarlaması gerekir.Clients must save this value and set it for subsequent read requests for session consistency.

Durum kodlarıStatus codes

Aşağıdaki tabloda, bu işlemin döndürdüğü yaygın durum kodları listelenmektedir.The following table lists common status codes returned by this operation. Durum kodlarının tam listesi için bkz. http durum kodları.For a full list of status codes, see HTTP Status Codes.

HTTP durum koduHTTP status code AçıklamaDescription
200 Tamam200 Ok İşlem başarılı oldu.The operation was successful.
400 Hatalı İstek400 Bad Request JSON gövdesi geçersiz.The JSON body is invalid. Eksik süslü ayraçları veya tırnakları denetleyin.Check for missing curly brackets or quotes.
404 Bulunamadı404 Not Found Belge artık yok, yani belge silinmiş.The document no longer exists, i.e. the document was deleted.
409 Çakışma409 Conflict Yeni belge için belirtilen kimlik, varolan bir belge tarafından alındı.The id provided for the new document has been taken by an existing document.
413 varlık çok büyük413 Entity Too Large İstekteki belge boyutu, bir istekteki izin verilen belge boyutunu aştı.The document size in the request exceeded the allowable document size in a request.

GövdeBody

ÖzellikProperty AçıklamaDescription
_rid_rid Sistem tarafından oluşturulan bir özelliktir.It is a system generated property. Kaynak KIMLIĞI (_rid), kaynak modelindeki kaynak yığınına göre de hiyerarşik olan benzersiz bir tanımlayıcıdır.The resource ID (_rid) is a unique identifier that is also hierarchical per the resource stack on the resource model. Belge kaynağının yerleştirilmesi ve gezinti için uygulama tarafından kullanılır.It is used internally for placement and navigation of the document resource.
_ts_ts Sistem tarafından oluşturulan bir özelliktir.It is a system generated property. Kaynağın son güncelleştirilme zaman damgasını belirtir.It specifies the last updated timestamp of the resource. Değer bir zaman damgası.The value is a timestamp.
_self_self Sistem tarafından oluşturulan bir özelliktir.It is a system generated property. Bu, kaynak için benzersiz adreslenebilir URI 'dir.It is the unique addressable URI for the resource.
_etag_etag İyimser eşzamanlılık denetimi için gereken kaynak ETag 'i belirten bir sistem tarafından oluşturulan özelliktir.It is a system generated property that specifies the resource etag required for optimistic concurrency control.
_attachments_attachments Bu, ekler kaynağının adreslenebilir yolunu belirten sistem tarafından oluşturulan bir özelliktir.It is a system generated property that specifies the addressable path for the attachments resource.
{  
  "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"  
}  
  

ÖrnekExample

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

Ayrıca Bkz.See Also