Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Internal] CosmosClient: Add a remarks section to AllowBulkExecution #3987

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

[Internal] CosmosClient: Add a remarks section to AllowBulkExecution #3987

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
56a190e
Add a remarks section to AllowBulkExecution
Jul 17, 2023
f32b53f
Update documentation remarks
Aug 23, 2023
6f2f4af
Update Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs
Sep 11, 2023
6aec328
Merge branch 'master' into dev/iainx/fix-1783
Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions Microsoft.Azure.Cosmos/src/CosmosClientOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,9 @@ public CosmosSerializer Serializer

/// <summary>
/// Allows optimistic batching of requests to service. Setting this option might impact the latency of the operations. Hence this option is recommended for non-latency sensitive scenarios only.
/// <remarks>
/// The use of Resource Tokens scoped to a Partition Key as an authentication mechanism when Bulk is enabled is not recommended as it reduces the potential throughput benefit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of Resource Tokens scoped to a Partition Key as an authentication mechanism is not recommended, as it reduces the potential throughput benefit. you can rephrase it something like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But is it only not recommended when Bulk is enabled?

/// </remarks>
/// </summary>
public bool AllowBulkExecution { get; set; }

Expand Down