Share via

PatchItemRequestOptions.FilterPredicate Property

  • Reference

Definition

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

Gets or sets condition to be checked before the patch operations in the Azure Cosmos DB service.

public string FilterPredicate { get; set; }
member this.FilterPredicate : string with get, set
Public Property FilterPredicate As String

Property Value

String

The condition to be checked before execution of operations.

Remarks

Condition can only be a from-clause of a sql statement. Creates a conditional SQL argument which is of format "FROM X where CONDITION", the condition has to be within the scope of the document which is supposed to be patched in the particular request. If the condition is satisfied the patch transaction will take place otherwise it will be returned with precondition failed.

Applies to