FSharp.Azure.Cosmos 1.0.0

Edit this page

Operations Module

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

Type extensions

Type extension Description

this.AddPostTrigger

Full Usage: this.AddPostTrigger

Parameters:
    trigger : string

Extended Type: ItemRequestOptions

trigger : string

this.AddPostTriggers

Full Usage: this.AddPostTriggers

Parameters:
    triggers : string seq

Extended Type: ItemRequestOptions

triggers : string seq

this.AddPreTrigger

Full Usage: this.AddPreTrigger

Parameters:
    trigger : string

Extended Type: ItemRequestOptions

trigger : string

this.AddPreTriggers

Full Usage: this.AddPreTriggers

Parameters:
    triggers : string seq

Extended Type: ItemRequestOptions

triggers : string seq

this.CountAsync

Full Usage: this.CountAsync

Parameters:
Returns: Task<int>

Counts the number of items in the container with specified QueryRequestOptions.

Extended Type: Container

requestOptions : QueryRequestOptions

Request options

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int>

this.CountAsync

Full Usage: this.CountAsync

Parameters:
Returns: Task<int>

Counts the number of items in the container partition with specified key.

If no partition key is provided, the count will be for the entire container.

Extended Type: Container

partitionKey : Nullable<PartitionKey>

Partition key

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int>

this.CountAsync

Full Usage: this.CountAsync

Parameters:
    partitionKey : string - Partition key
    cancellationToken : CancellationToken - Cancellation token

Returns: Task<int>

Counts the number of items in the container partition with specified key.

If no partition key is provided, the count will be for the entire container.

Extended Type: Container

partitionKey : string

Partition key

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int>

this.ExistsAsync

Full Usage: this.ExistsAsync

Parameters:
Returns: Task<bool>

Checks if an item with specified Id exists in the container.

Extended Type: Container

id : string

Item Id

requestOptions : QueryRequestOptions

Request options

cancellationToken : CancellationToken

Cancellation token

Returns: Task<bool>

this.ExistsAsync

Full Usage: this.ExistsAsync

Parameters:
Returns: Task<bool>

Checks if an item with specified Id exists in the container partition with specified key.

Extended Type: Container

id : string

Item Id

partitionKey : PartitionKey

Partition key

cancellationToken : CancellationToken

Cancellation token

Returns: Task<bool>

this.IsNotDeletedAsync

Full Usage: this.IsNotDeletedAsync

Parameters:
Returns: Task<bool>

Checks if an item with specified Id exists in the container partition with specified key.

Extended Type: Container

deletedFieldName : 'a
id : string

Item Id

requiestOptions : QueryRequestOptions
cancellationToken : CancellationToken

Cancellation token

Returns: Task<bool>

this.LongCountAsync

Full Usage: this.LongCountAsync

Parameters:
Returns: Task<int64>

Counts the number of items in the container with specified QueryRequestOptions.

Extended Type: Container

requestOptions : QueryRequestOptions

Request options

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int64>

this.LongCountAsync

Full Usage: this.LongCountAsync

Parameters:
Returns: Task<int64>

Counts the number of items in the container partition with specified key.

If no partition key is provided, the count will be for the entire container.

Extended Type: Container

partitionKey : Nullable<PartitionKey>

Partition key

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int64>

this.LongCountAsync

Full Usage: this.LongCountAsync

Parameters:
    partitionKey : string - Partition key
    cancellationToken : CancellationToken - Cancellation token

Returns: Task<int64>

Counts the number of items in the container partition with specified key.

If no partition key is provided, the count will be for the entire container.

Extended Type: Container

partitionKey : string

Partition key

cancellationToken : CancellationToken

Cancellation token

Returns: Task<int64>

Active patterns

Active pattern Description

(|CosmosException|_|) ex

Full Usage: (|CosmosException|_|) ex

Parameters:
Returns: CosmosException option
ex : Exception
Returns: CosmosException option

(|HandleException|_|) ex

Full Usage: (|HandleException|_|) ex

Parameters:
Returns: CosmosException option
ex : Exception
Returns: CosmosException option