RequestOptions.ConsistencyLevel Property

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the consistency level required for the request in the Azure Cosmos DB service.

public Microsoft.Azure.Documents.ConsistencyLevel? ConsistencyLevel { get; set; }

member this.ConsistencyLevel : Nullable<Microsoft.Azure.Documents.ConsistencyLevel> with get, set

Public Property ConsistencyLevel As Nullable(Of ConsistencyLevel)

Property Value

Nullable<ConsistencyLevel>

The consistency level required for the request.

Examples

This example uses RequestOptions to override the consistency level to Eventual for this single Read operation.

Document doc = client.ReadDocumentAsync(documentLink, new RequestOptions { ConsistencyLevel = ConsistencyLevel.Eventual });

Remarks

Azure Cosmos DB offers 5 different consistency levels. Strong, Bounded Staleness, Session, Consistent Prefix and Eventual - in order of strongest to weakest consistency. ConnectionPolicy

While this is set at a database account level, Azure Cosmos DB allows a developer to override the default consistency level for each individual request.

Applies to

Sdílet prostřednictvím