FeedOptions.EnableCrossPartitionQuery 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 a value indicating whether users are enabled to send more than one request to execute the query in the Azure Cosmos DB service. More than one request is necessary if the query is not scoped to single partition key value.

public bool EnableCrossPartitionQuery { get; set; }

member this.EnableCrossPartitionQuery : bool with get, set

Public Property EnableCrossPartitionQuery As Boolean

Property Value

Boolean

Option is true if cross-partition query execution is enabled; otherwise, false.

Examples

// Enable cross partition query.
var queryable = client.CreateDocumentQuery<Book>(
    collectionLink, new FeedOptions { EnableCrossPartitionQuery = true }).Where(b => b.Price > 1000);

Remarks

This option only applies to queries on documents and document attachments.

Applies to