FeedOptions.SessionToken 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 session token for use with session consistency in the Azure Cosmos DB service.

public string SessionToken { get; set; }

member this.SessionToken : string with get, set

Public Property SessionToken As String

Property Value

String

The session token for use with session consistency.

Examples

var queryable = client.CreateDocumentQuery<Book>(
    collectionLink, new FeedOptions { SessionToken = lastSessionToken });

Remarks

Useful for applications that are load balanced across multiple Microsoft.Azure.Documents.Client.DocumentClient instances. In this case, round-trip the token from end user to the application and then back to Azure Cosmos DB so that a session can be preserved across servers.

Applies to