Read (FSharp.Azure.Cosmos)

Read Module

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

Types and nested modules

Type/Module	Description
CosmosException
FeedIteratorExtensions
ReadBuilder<'T>
ReadOperation<'T>
ReadResult<'t>	Represents the result of a read operation.

Functions and values

Function or value	Description
`read` Full Usage: `read` Returns: `ReadBuilder<'T>`	Returns: `ReadBuilder<'T>`

Type extensions

Type extension	Description
`this.ExecuteAsync` Full Usage: `this.ExecuteAsync` Parameters: operation : `ReadOperation<'T>` - Read 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 read operation, transforms success or failure, and returns CosmosResponse{T}. Extended Type: `Container` operation : `ReadOperation<'T>` Read operation success : `'T -> 'Result` Result transform if success failure : `CosmosException -> 'Result` Error transform if failure cancellationToken : `CancellationToken` Cancellation token Returns: `Task<CosmosResponse<'Result>>`
`this.ExecuteAsync` Full Usage: `this.ExecuteAsync` Parameters: operation : `ReadOperation<'T>` - Read operation cancellationToken : `CancellationToken` - Cancellation token Returns: `Task<CosmosResponse<ReadResult<'T>>>`	Executes a read operation and returns CosmosResponse{ReadResult{T}}. Extended Type: `Container` operation : `ReadOperation<'T>` Read operation cancellationToken : `CancellationToken` Cancellation token Returns: `Task<CosmosResponse<ReadResult<'T>>>`
`this.ExecuteAsyncOption` Full Usage: `this.ExecuteAsyncOption` Parameters: operation : `ReadOperation<'T>` - Read operation cancellationToken : `CancellationToken` - Cancellation token Returns: `Task<CosmosResponse<'T option>>`	Executes a read operation and returns CosmosResponse{FSharpValueOption{T}}. Extended Type: `Container` operation : `ReadOperation<'T>` Read operation cancellationToken : `CancellationToken` Cancellation token Returns: `Task<CosmosResponse<'T option>>`
`this.ExecuteAsyncValueOption` Full Usage: `this.ExecuteAsyncValueOption` Parameters: operation : `ReadOperation<'T>` - Read operation cancellationToken : `CancellationToken` - Cancellation token Returns: `Task<CosmosResponse<'T voption>>`	Executes a read operation and returns CosmosResponse{FSharpOption{T}}. Extended Type: `Container` operation : `ReadOperation<'T>` Read operation cancellationToken : `CancellationToken` Cancellation token Returns: `Task<CosmosResponse<'T voption>>`
`this.PlainExecuteAsync` Full Usage: `this.PlainExecuteAsync` Parameters: operation : `ReadOperation<'T>` - Read operation cancellationToken : `CancellationToken` - Cancellation token Returns: `Task<ItemResponse<'T>>`	Executes a read operation and returns ItemResponse{T}. Extended Type: `Container` operation : `ReadOperation<'T>` Read operation cancellationToken : `CancellationToken` Cancellation token Returns: `Task<ItemResponse<'T>>`