Patch (FSharp.Azure.Cosmos)

Patch Module

Namespace: FSharp.Azure.Cosmos
Assembly: FSharp.Azure.Cosmos.dll

Types and nested modules

Type/Module	Description
CosmosException
PatchBuilder<'T>
PatchOperation<'T>
PatchResult<'t>	Represents the result of a patch operation.

Functions and values

Function or value	Description
`patch` Full Usage: `patch` Returns: `PatchBuilder<'T>`	Returns: `PatchBuilder<'T>`
`patchAndRead` Full Usage: `patchAndRead` Returns: `PatchBuilder<'T>`	Returns: `PatchBuilder<'T>`

Type extensions

Type extension	Description
`this.ExecuteAsync` Full Usage: `this.ExecuteAsync` Parameters: operation : `PatchOperation<'T>` - Patch operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<PatchResult<'T>>>`	Executes a patch operation safely and returns CosmosResponse{PatchResult{T}}. Requires ETag to be set in PatchItemRequestOptions. Extended Type: `Container` operation : `PatchOperation<'T>` Patch operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<PatchResult<'T>>>`
`this.ExecuteOverwriteAsync` Full Usage: `this.ExecuteOverwriteAsync` Parameters: operation : `PatchOperation<'T>` - Patch operation success : `'T -> 'Result` - Result transform if success failure : `CosmosException -> 'Result` - Error transform if failure cancellationToken : `CancellationToken` - Cancellation token Returns: `Task<CosmosResponse<'Result>>`	Executes a patch operation, transforms success or failure, and returns CosmosResponse{T}. Extended Type: `Container` operation : `PatchOperation<'T>` Patch operation success : `'T -> 'Result` Result transform if success failure : `CosmosException -> 'Result` Error transform if failure cancellationToken : `CancellationToken` Cancellation token Returns: `Task<CosmosResponse<'Result>>`
`this.ExecuteOverwriteAsync` Full Usage: `this.ExecuteOverwriteAsync` Parameters: operation : `PatchOperation<'T>` - Patch operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<PatchResult<'T>>>`	Executes a patch operation and returns CosmosResponse{PatchResult{T}}. Extended Type: `Container` operation : `PatchOperation<'T>` Patch operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<PatchResult<'T>>>`
`this.PlainExecuteAsync` Full Usage: `this.PlainExecuteAsync` Parameters: operation : `PatchOperation<'T>` - Patch operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<ItemResponse<'T>>`	Executes a patch operation and returns ItemResponse{T}. Extended Type: `Container` operation : `PatchOperation<'T>` Patch operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<ItemResponse<'T>>`