Skip to content

Fix Purge Instance Comments #489

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

Merged
sophiatev merged 1 commit into from
Oct 30, 2025
Merged

Fix Purge Instance Comments #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 4 deletions src/Client/Core/DurableTaskClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,7 @@ public virtual Task<PurgeResult> PurgeInstanceAsync(string instanceId, Cancellat
/// <see cref="OrchestrationRuntimeStatus.Terminated"/> state can be purged.
/// </para><para>
/// Purging an orchestration will by default not purge any of the child sub-orchestrations that were started by the
/// orchetration instance. If you want to purge sub-orchestration instances, you can set <see cref="PurgeInstanceOptions.Recursive"/> flag to
/// true which will enable purging of child sub-orchestration instances. It is set to false by default.
/// orchetration instance. Currently, purging of sub-orchestrations is not supported.
/// If <paramref name="instanceId"/> is not found in the data store, or if the instance is found but not in a
/// terminal state, then the returned <see cref="PurgeResult"/> object will have a
/// <see cref="PurgeResult.PurgedInstanceCount"/> value of <c>0</c>. Otherwise, the existing data will be purged and
Expand Down Expand Up @@ -390,8 +389,7 @@ public virtual Task<PurgeResult> PurgeAllInstancesAsync(PurgeInstancesFilter fil
/// </param>
/// <returns>
/// This method returns a <see cref="PurgeResult"/> object after the operation has completed with a
/// <see cref="PurgeResult.PurgedInstanceCount"/> indicating the number of orchestration instances that were purged,
/// including the count of sub-orchestrations purged if any.
/// <see cref="PurgeResult.PurgedInstanceCount"/> indicating the number of orchestration instances that were purged.
/// </returns>
public virtual Task<PurgeResult> PurgeAllInstancesAsync(
PurgeInstancesFilter filter, PurgeInstanceOptions? options = null, CancellationToken cancellation = default)
Expand Down
6 changes: 4 additions & 2 deletions src/Client/Core/PurgeInstanceOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
namespace Microsoft.DurableTask.Client;

/// <summary>
/// Options to purge an orchestration.
/// Options to purge an orchestration.
/// Note that recursive purging of suborchestrations is currently not supported.
/// </summary>
/// <param name="Recursive">The optional boolean value indicating whether to purge sub-orchestrations as well.</param>
/// <param name="Recursive">The optional boolean value indicating whether to purge sub-orchestrations as well.
/// Currently this parameter is not supported.</param>
public record PurgeInstanceOptions(bool Recursive = false);
Loading