FSharp.Azure.Cosmos 1.0.0

Edit this page

ReadMany Module

Types and nested modules

Type/Module Description

CosmosException

ReadManyBuilder<'T>

ReadManyOperation<'T>

ReadManyResult<'t>

Represents the result of a read operation.

Functions and values

Function or value Description

readMany

Full Usage: readMany

Returns: ReadManyBuilder<'T>
Returns: ReadManyBuilder<'T>

Type extensions

Type extension Description

this.ExecuteAsync

Full Usage: this.ExecuteAsync

Parameters:
Returns: Task<CosmosResponse<'Result>>

Executes a read many operation, transforms success or failure, and returns CosmosResponse{T}.

Extended Type: Container

operation : ReadManyOperation<'T>

Read operation

success : FeedResponse<'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:
Returns: Task<CosmosResponse<ReadManyResult<FeedResponse<'T>>>>

Executes a read many operation and returns CosmosResponse{ReadResult{T}}.

Extended Type: Container

operation : ReadManyOperation<'T>

Read operation

cancellationToken : CancellationToken

Cancellation token

Returns: Task<CosmosResponse<ReadManyResult<FeedResponse<'T>>>>

this.PlainExecuteAsync

Full Usage: this.PlainExecuteAsync

Parameters:
Returns: Task<FeedResponse<'T>>

Executes a read many operation and returns ItemResponse{T}.

Extended Type: Container

operation : ReadManyOperation<'T>

Read many operation

cancellationToken : CancellationToken

Cancellation token

Returns: Task<FeedResponse<'T>>