Skip to content

RDoc-3554 Deleting a non-existing compare-exchange item returns false #2164

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
merged 2 commits into from
Nov 6, 2025
Merged

RDoc-3554 Deleting a non-existing compare-exchange item returns false #2164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebc6cce
RDoc-3554 Deleting a non-existing compare-exchange item returns false
Danielle9897 Oct 30, 2025
268dac5
RDoc-3554 fix text
Danielle9897 Nov 3, 2025
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
17 changes: 14 additions & 3 deletions docs/compare-exchange/content/_delete-cmpxchg-items-csharp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,12 @@ import CodeBlock from '@theme/CodeBlock';
long indexOfItem = resultOfDelete.Index; // The version of the deleted item

// If 'successful' is true - the compare-exchange item was deleted.
// If 'successful' is false - the item was not deleted (index mismatch).

// If 'successful' is false -
// * The item was not deleted because the index didn't match (it was modified by someone else).
// In this case, 'resultOfDelete.Value' will contain the current value stored on the server.
// * Or the item no longer existed at the time of deletion (it was already deleted).
Copy link

@haludi haludi Oct 30, 2025

Choose a reason for hiding this comment

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

I would consider that the same as "the index didn't match," since the index of a non-existent entry is 0.
But it's not important, it's good to be explicit about it, like you did.
You can consider adding here that distinguishing between a case where the compare-exchange exists with a different index and a case where the compare-exchange does not exist can be determined by the returned object.
If the compare-exchange does not exist, this will be null.

Copy link
Member Author

@Danielle9897 Danielle9897 Nov 3, 2025

Choose a reason for hiding this comment

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

added

// In this case, 'resultOfDelete.Value' will be null.
}
```
</TabItem>
Expand All @@ -281,14 +286,20 @@ import CodeBlock from '@theme/CodeBlock';
itemToDelete.Key, itemToDelete.Index);

// Execute the delete operation by passing it to Operations.SendAsync
CompareExchangeResult<string> resultOfDelete = await store.Operations.SendAsync(deleteCmpXchgOp);
CompareExchangeResult<string> resultOfDelete = await
store.Operations.SendAsync(deleteCmpXchgOp);

// Check results
bool successful = resultOfDelete.Successful; // Has operation succeeded
long indexOfItem = resultOfDelete.Index; // The version of the deleted item

// If 'successful' is true - the compare-exchange item was deleted.
// If 'successful' is false - the item was not deleted (index mismatch).

// If 'successful' is false -
// * The item was not deleted because the index didn't match (it was modified by someone else).
// In this case, 'resultOfDelete.Value' will contain the current value stored on the server.
// * Or the item no longer existed at the time of deletion (it was already deleted).
// In this case, 'resultOfDelete.Value' will be null.
}
```
</TabItem>
Expand Down
7 changes: 6 additions & 1 deletion docs/compare-exchange/content/_delete-cmpxchg-items-nodejs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,12 @@ import CodeBlock from '@theme/CodeBlock';
const indexOfItem = resultOfDelete.index; // The version of the deleted item

// If 'successful' is true - the compare-exchange item was deleted.
// If 'successful' is false - the item was not deleted (index mismatch).

// If 'successful' is false -
// * The item was not deleted because the index didn't match (it was modified by someone else).
// In this case, 'resultOfDelete.value' will contain the current value stored on the server.
// * Or the item no longer existed at the time of deletion (it was already deleted).
// In this case, 'resultOfDelete.value' will be null.
}
```
</TabItem>
Expand Down
Loading