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.

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

Documentation: Adds see also link to Container.CreateTransactionalBatch #3860

Merged
5 commits merged into from
May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Microsoft.Azure.Cosmos/src/Batch/TransactionalBatch.cs
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ namespace Microsoft.Azure.Cosmos
/// ]]>
/// </code>
/// </example>
/// <seealso href="https://docs.microsoft.com/azure/cosmos-db/concepts-limits">Limits on TransactionalBatch requests</seealso>
/// <remarks>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/concepts-limits#per-request-limits">Limits on TransactionalBatch requests</seealso>
/// </remarks>
public abstract class TransactionalBatch
{
/// <summary>
Expand Down Expand Up @@ -244,6 +246,7 @@ public abstract TransactionalBatch PatchItem(
/// <remarks>
/// This API only throws on client side exceptions. This is to increase performance and prevent the overhead of throwing exceptions.
/// Use <see cref="TransactionalBatchResponse.IsSuccessStatusCode"/> on the response returned to ensure that the transactional batch succeeded.
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/concepts-limits#per-request-limits">Limits on TransactionalBatch requests</seealso>
/// </remarks>
public abstract Task<TransactionalBatchResponse> ExecuteAsync(
CancellationToken cancellationToken = default);
Expand Down Expand Up @@ -275,6 +278,7 @@ public abstract Task<TransactionalBatchResponse> ExecuteAsync(
/// <remarks>
/// This API only throws on client side exceptions. This is to increase performance and prevent the overhead of throwing exceptions.
/// Use <see cref="TransactionalBatchResponse.IsSuccessStatusCode"/> on the response returned to ensure that the transactional batch succeeded.
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/concepts-limits#per-request-limits">Limits on TransactionalBatch requests</seealso>
/// </remarks>
public abstract Task<TransactionalBatchResponse> ExecuteAsync(
TransactionalBatchRequestOptions requestOptions,
Expand Down
3 changes: 3 additions & 0 deletions Microsoft.Azure.Cosmos/src/Resource/Container/Container.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1342,6 +1342,9 @@ public abstract ChangeFeedEstimator GetChangeFeedEstimator(
/// </summary>
/// <param name="partitionKey">The partition key for all items in the batch.</param>
/// <returns>A new instance of <see cref="TransactionalBatch"/>.</returns>
/// <remarks>
/// <seealso href="https://learn.microsoft.com/azure/cosmos-db/concepts-limits#per-request-limits">Limits on TransactionalBatch requests</seealso>
/// </remarks>
public abstract TransactionalBatch CreateTransactionalBatch(PartitionKey partitionKey);

/// <summary>
Expand Down