Specify pagesize for workflow list command #748
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
yiminc
force-pushed
the
vis_list_pagesize
branch
from
bcd8ab6 to
9504ce3
Compare
josh-berry
reviewed
Feb 7, 2025
temporalcli/commandsgen/commands.yml
Outdated
| @@ -2886,6 +2886,9 @@ commands: | |||
| - name: limit | |||
| type: int | |||
| description: Maximum number of Workflow Executions to display. | |||
| - name: pagesize | |||
There was a problem hiding this comment.
To be consistent with how we name other flags, this should be:
Suggested change
| - name: pagesize | |
| - name: page-size |
temporalcli/commandsgen/commands.yml
Outdated
| @@ -2886,6 +2886,9 @@ commands: | |||
| - name: limit | |||
| type: int | |||
| description: Maximum number of Workflow Executions to display. | |||
| - name: pagesize | |||
| type: int | |||
| description: Maximum number of Workflow Executions to return from server per request. Used for pagination. | |||
There was a problem hiding this comment.
Optional; rewords in terms of behavior, not implementation.
Suggested change
| description: Maximum number of Workflow Executions to return from server per request. Used for pagination. | |
| description: Maximum number of Workflow Executions to fetch at a time from the server. |
josh-berry
approved these changes
Feb 10, 2025
cretz
reviewed
Feb 10, 2025
| @@ -2886,6 +2886,9 @@ commands: | |||
| - name: limit | |||
| type: int | |||
| description: Maximum number of Workflow Executions to display. | |||
| - name: page-size | |||
There was a problem hiding this comment.
Suggested change
| - name: page-size | |
| - name: force-override-page-size |
Mentioned internally, but this less-wieldy form may make it a bit clearer users usually don't ever need to set this. No strong opinion though.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
What was changed
Add optional pagesize parameter to workflow list command
Why?
Be able to specify page size is useful when default page is too large for cases where it leads to timeout due to large amount of data.
Checklist
Closes
How was this tested:
Updated unit test to cover it.