Share via

ChangeFeedRequestOptions.PageSizeHint Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.45.0
Source:
ChangeFeedRequestOptions.cs

Gets or sets the maximum number of items to be returned in the enumeration operation in the Azure Cosmos DB service.

public int? PageSizeHint { get; set; }
member this.PageSizeHint : Nullable<int> with get, set
Public Property PageSizeHint As Nullable(Of Integer)

Property Value

Nullable<Int32>

The maximum number of items to be returned in the enumeration operation.

Remarks

This is just a hint to the server which can return less or more items per page. If operations in the container are performed through stored procedures or transactional batch, transaction scope is preserved when reading items from the Change Feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.

Applies to