IDocumentWriter<TDocument>.UpsertDocumentAsync Method

Definition

Namespace:

System.Cloud.DocumentDb

Assembly:

System.Cloud.DocumentDb.Abstractions.dll

Package:

System.Cloud.DocumentDb.Abstractions v8.0.0-rc.1.23453.1

Upserts a document provided in Document.

public:
 System::Threading::Tasks::Task<System::Cloud::DocumentDb::IDatabaseResponse<TDocument> ^> ^ UpsertDocumentAsync(System::Cloud::DocumentDb::RequestOptions<TDocument> ^ options, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<TDocument>> UpsertDocumentAsync(System.Cloud.DocumentDb.RequestOptions<TDocument> options, System.Threading.CancellationToken cancellationToken);

abstract member UpsertDocumentAsync : System.Cloud.DocumentDb.RequestOptions<'Document> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<'Document>>

Public Function UpsertDocumentAsync (options As RequestOptions(Of TDocument), cancellationToken As CancellationToken) As Task(Of IDatabaseResponse(Of TDocument))

Parameters

options

RequestOptions<TDocument>

The request options.

cancellationToken

CancellationToken

The token represents request cancellation.

Returns

Task<IDatabaseResponse<TDocument>>

A Task containing a IDatabaseResponse<T> that wraps the updated document.

Exceptions

DatabaseClientException

Thrown when an error occurred on a client side. For example on a bad request, permissions error or client timeout.

DatabaseServerException

Thrown when an error occurred on a database server side, including internal server error.

DatabaseRetryableException

Thrown when a request failed but can be retried. This includes throttling and server not available cases.

DatabaseException

A generic exception thrown in all other not covered above cases.

Remarks

This method is suitable when existence of a document is unknown, and replace is always suitable. For conditional replace InsertOrUpdateDocumentAsync(RequestOptions<TDocument>, String, Func<TDocument,TDocument>, CancellationToken) should be used instead.