Add scanner API to transaction abstraction #2729
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR integrates a new scanner API into the transaction abstraction layer by adding the getScanner method to various transaction and transaction manager implementations. Key changes include:
- Adding a getScanner(Scan) method override in DecoratedTwoPhaseCommitTransactionManager, DecoratedTwoPhaseCommitTransaction, DecoratedDistributedTransactionManager, DecoratedDistributedTransaction, and active transaction managed classes.
- Introducing new scanner interfaces and implementations in CrudOperable and its related abstractions.
- Minor updates to documentation and integration tests to support the scanner API.
Reviewed Changes
Copilot reviewed 51 out of 51 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| core/src/main/java/com/scalar/db/common/DecoratedTwoPhaseCommitTransactionManager.java | Added delegation for getScanner to the underlying transaction manager |
| core/src/main/java/com/scalar/db/common/DecoratedTwoPhaseCommitTransaction.java | Added getScanner override delegating to the underlying transaction |
| core/src/main/java/com/scalar/db/common/DecoratedDistributedTransactionManager.java | Added getScanner override for distributed transactions |
| core/src/main/java/com/scalar/db/common/DecoratedDistributedTransaction.java | Added getScanner override delegating to the underlying distributed transaction |
| core/src/main/java/com/scalar/db/common/ActiveTransactionManagedTwoPhaseCommitTransactionManager.java | Added synchronized getScanner override |
| core/src/main/java/com/scalar/db/common/ActiveTransactionManagedDistributedTransactionManager.java | Added synchronized getScanner override |
| core/src/main/java/com/scalar/db/common/AbstractTransactionManagerCrudOperableScanner.java | Introduced new abstract scanner class for TransactionManagerCrudOperable |
| core/src/main/java/com/scalar/db/common/AbstractTransactionCrudOperableScanner.java | Introduced new abstract scanner class for TransactionCrudOperable |
| core/src/main/java/com/scalar/db/common/AbstractCrudOperableScanner.java | Added implementation for iterator semantics over scanner results |
| core/src/java/api classes | Updated scanner interfaces in TransactionManagerCrudOperable, TransactionCrudOperable, Scanner, and CrudOperable with comprehensive Javadoc comments to describe scanner behavior |
| Integration tests | Added @test annotations to previously disabled test methods to ensure proper scanner-related behavior validation |
| * (e.g., a conflict error). You can retry the transaction from the beginning | ||
| * @throws CrudException if the transaction CRUD operation fails due to transient or nontransient | ||
| * faults. You can try retrying the transaction from the beginning, but the transaction may | ||
| * still fail if the cause is nontranient |
There was a problem hiding this comment.
Consider correcting the spelling of 'nontranient' to 'nontransient' in the documentation to improve clarity.
Suggested change
| * still fail if the cause is nontranient | |
| * still fail if the cause is nontransient |
Copilot uses AI. Check for mistakes.
| * (e.g., a conflict error). You can retry the transaction from the beginning | ||
| * @throws CrudException if the transaction CRUD operation fails due to transient or nontransient | ||
| * faults. You can try retrying the transaction from the beginning, but the transaction may | ||
| * still fail if the cause is nontranient |
There was a problem hiding this comment.
Consider correcting the spelling of 'nontranient' to 'nontransient' in the documentation to improve clarity.
Suggested change
| * still fail if the cause is nontranient | |
| * still fail if the cause is nontransient |
Copilot uses AI. Check for mistakes.
Torch3333
approved these changes
Jun 3, 2025
feeblefakie
approved these changes
Jun 3, 2025
|
@feeblefakie @Torch3333 I’ll fix the typo in a separate PR, since the same typo also exists in the existing code. Thanks! |
brfrn169
added a commit
that referenced
this pull request
Jun 4, 2025
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a scanner API to the transaction abstraction for iteratively retrieving results. It simply merges the
add-scanner-api-to-transaction-abstractionfeature branch into themasterbranch, and the code has already been reviewed.Related issues and/or PRs
Changes made
add-scanner-api-to-transaction-abstractionfeature branch to themasterbranchChecklist
Additional notes (optional)
N/A
Release notes
Added a scanner API to the transaction abstraction for iteratively retrieving results.