FeedOptions.EnableScanInQuery 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

Gets or sets the option to enable scans on the queries which couldn't be served as indexing was opted out on the requested paths in the Azure Cosmos DB service.

public bool? EnableScanInQuery { get; set; }
member this.EnableScanInQuery : Nullable<bool> with get, set
Public Property EnableScanInQuery As Nullable(Of Boolean)

Property Value

Nullable<Boolean>

Option is true if scan on queries is enabled; otherwise, false.

Examples

// Enable scan when Range index is not specified.
var queryable = client.CreateDocumentQuery<Book>(
    collectionLink, new FeedOptions { EnableScanInQuery = true }).Where(b => b.Price > 1000);

Applies to