Add comments to async query handlers #2657
Merged
Conversation
This file contains 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
ykmr1224
changed the title
ykmr1224
requested review from
ps48,
kavithacm,
derek-ho,
joshuali925,
dai-chen,
YANG-DB,
rupal-bq,
mengweieric,
vmmusings,
Swiddis,
penghuo,
seankao-az,
MaxKsyunz,
Yury-Fridlyand,
anirudha,
forestmvey,
acarbonetto and
GumpacG
as code owners
ykmr1224
force-pushed
the
queryhandler-comment
branch
from
032cf98 to
a0042c3
Compare
Signed-off-by: Tomoyuki Morita <[email protected]>
ykmr1224
force-pushed
the
queryhandler-comment
branch
from
a0042c3 to
f8d8728
Compare
Signed-off-by: Tomoyuki Morita <[email protected]>
seankao-az
previously approved these changes
May 8, 2024
Swiddis
previously approved these changes
May 8, 2024
There was a problem hiding this comment.
Thanks! While you're at it, it might also be nice to link to related classes, to make it slightly easier to navigate if someone e.g. lands on IndexDMLResultStorageService without having seen IndexDMLResultStorage.
That's a good point. I'm wondering if we need those links in the comments considering IDE or Github provide code navigation feature. I think the link would be beneficial when we want to mention some related class which is not obviously referred in the code. |
noCharger
reviewed
May 9, 2024
| @@ -28,6 +28,10 @@ | |||
| import org.opensearch.sql.spark.leasemanager.model.LeaseRequest; | |||
| import org.opensearch.sql.spark.response.JobExecutionResponseReader; | |||
|
|
|||
| /** | |||
| * The handler for batch query. With batch query, queries are executed as single batch. The queries | |||
| * are sent along with job execution request to spark. | |||
There was a problem hiding this comment.
what is job execution request? can you add a ref link to the class?
| @@ -31,7 +31,12 @@ | |||
| import org.opensearch.sql.spark.flint.operation.FlintIndexOpFactory; | |||
| import org.opensearch.sql.spark.response.JobExecutionResponseReader; | |||
|
|
|||
| /** Handle Index DML query. includes * DROP * ALT? */ | |||
| /** | |||
| * The handler for Index DML (Data Manipulation Language) query. Handles DROP/ALT/VACUUM operation | |||
There was a problem hiding this comment.
Good catch. Fixed.
Signed-off-by: Tomoyuki Morita <[email protected]>
noCharger
approved these changes
May 9, 2024
seankao-az
approved these changes
May 10, 2024
ykmr1224
added
backport 2.x
maintenance
Swiddis
approved these changes
May 10, 2024
|
The backport to To backport manually, run these commands in your terminal: # Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/sql/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/sql/backport-2.x
# Create a new branch
git switch --create backport/backport-2657-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 05a2f66a0af2baab747aa0afd437441dbd5efc67
# Push it to GitHub
git push --set-upstream origin backport/backport-2657-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/sql/backport-2.xThen, create a pull request where the |
ykmr1224
added a commit
to ykmr1224/sql
that referenced
this pull request
May 15, 2024
* Add comments to query handlers Signed-off-by: Tomoyuki Morita <[email protected]> * Reformat Signed-off-by: Tomoyuki Morita <[email protected]> * Fix comments Signed-off-by: Tomoyuki Morita <[email protected]> --------- Signed-off-by: Tomoyuki Morita <[email protected]>
ykmr1224
added a commit
to ykmr1224/sql
that referenced
this pull request
May 15, 2024
* Add comments to query handlers Signed-off-by: Tomoyuki Morita <[email protected]> * Reformat Signed-off-by: Tomoyuki Morita <[email protected]> * Fix comments Signed-off-by: Tomoyuki Morita <[email protected]> --------- Signed-off-by: Tomoyuki Morita <[email protected]> (cherry picked from commit 05a2f66)
6 tasks
ykmr1224
added a commit
that referenced
this pull request
May 16, 2024
* Add comments to query handlers Signed-off-by: Tomoyuki Morita <[email protected]> * Reformat Signed-off-by: Tomoyuki Morita <[email protected]> * Fix comments Signed-off-by: Tomoyuki Morita <[email protected]> --------- Signed-off-by: Tomoyuki Morita <[email protected]> (cherry picked from commit 05a2f66)
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
Added comments to async query handlers to make the responsibility of each handler clearer.
Issues Resolved
N/A
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.