Replace (FSharp.Azure.Cosmos)

Replace Module

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

Types and nested modules

Type/Module	Description
CosmosException
ReplaceBuilder<'T>
ReplaceConcurrentResult<'T, 'E>	Represents the result of a replace operation.
ReplaceConcurrentlyBuilder<'T, 'E>
ReplaceConcurrentlyOperation<'T, 'E>
ReplaceOperation<'T>
ReplaceResult<'T>	Represents the result of a replace operation.

Functions and values

Function or value	Description
`DefaultRetryCount` Full Usage: `DefaultRetryCount` Returns: `int`	Returns: `int`
`executeConcurrentlyAsync ct container operation retryAttempts` Full Usage: `executeConcurrentlyAsync ct container operation retryAttempts` Parameters: ct : `CancellationToken` container : `Container` operation : `ReplaceConcurrentlyOperation<'value, 'error>` retryAttempts : `int` Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'value, 'error>>>`	ct : `CancellationToken` container : `Container` operation : `ReplaceConcurrentlyOperation<'value, 'error>` retryAttempts : `int` Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'value, 'error>>>`
`replace` Full Usage: `replace` Returns: `ReplaceBuilder<'T>`	Returns: `ReplaceBuilder<'T>`
`replaceAndRead` Full Usage: `replaceAndRead` Returns: `ReplaceBuilder<'T>`	Returns: `ReplaceBuilder<'T>`
`replaceConcurrenly` Full Usage: `replaceConcurrenly` Returns: `ReplaceConcurrentlyBuilder<'T, 'E>`	Returns: `ReplaceConcurrentlyBuilder<'T, 'E>`
`replaceConcurrenlyAndRead` Full Usage: `replaceConcurrenlyAndRead` Returns: `ReplaceConcurrentlyBuilder<'T, 'E>`	Returns: `ReplaceConcurrentlyBuilder<'T, 'E>`

Type extensions

Type extension	Description
`this.ExecuteAsync` Full Usage: `this.ExecuteAsync` Parameters: operation : `ReplaceOperation<'T>` - Replace operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<ReplaceResult<'T>>>`	Executes a replace operation safely and returns CosmosResponse{ReplaceResult{T}}. Extended Type: `Container` operation : `ReplaceOperation<'T>` Replace operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<ReplaceResult<'T>>>`
`this.ExecuteConcurrentlyAsync` Full Usage: `this.ExecuteConcurrentlyAsync` Parameters: operation : `ReplaceConcurrentlyOperation<'T, 'E>` - Replace operation. maxRetryCount : `int` - Max retry count. Default is 10. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'T, 'E>>>`	Executes a replace operation by applying change to item and returns CosmosResponse{ReplaceConcurrentResult{T, E}}. Extended Type: `Container` operation : `ReplaceConcurrentlyOperation<'T, 'E>` Replace operation. maxRetryCount : `int` Max retry count. Default is 10. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'T, 'E>>>`
`this.ExecuteConcurrentlyAsync` Full Usage: `this.ExecuteConcurrentlyAsync` Parameters: operation : `ReplaceConcurrentlyOperation<'T, 'E>` - Replace operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'T, 'E>>>`	Executes a replace operation by applying change to item and returns CosmosResponse{ReplaceConcurrentResult{T, E}}. Extended Type: `Container` operation : `ReplaceConcurrentlyOperation<'T, 'E>` Replace operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<ReplaceConcurrentResult<'T, 'E>>>`
`this.ExecuteOverwriteAsync` Full Usage: `this.ExecuteOverwriteAsync` Parameters: operation : `ReplaceOperation<'T>` - Replace 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 replace operation, transforms success or failure, and returns CosmosResponse{T}. Extended Type: `Container` operation : `ReplaceOperation<'T>` Replace 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 : `ReplaceOperation<'T>` - Replace operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<CosmosResponse<ReplaceResult<'T>>>`	Executes a replace operation replacing existing item if it exists and returns CosmosResponse{UpsertResult{T}}. Extended Type: `Container` operation : `ReplaceOperation<'T>` Replace operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<CosmosResponse<ReplaceResult<'T>>>`
`this.PlainExecuteAsync` Full Usage: `this.PlainExecuteAsync` Parameters: operation : `ReplaceOperation<'T>` - Replace operation. cancellationToken : `CancellationToken` - Cancellation token. Returns: `Task<ItemResponse<'T>>`	Executes a replace operation and returns ItemResponse{T}. Extended Type: `Container` operation : `ReplaceOperation<'T>` Replace operation. cancellationToken : `CancellationToken` Cancellation token. Returns: `Task<ItemResponse<'T>>`