docs(bigquery): Update TableResult.getTotalRows() docstring #3785
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
product-auto-label bot added size: xs 
PhongChuong approved these changes May 7, 2025
lqiu96 pushed a commit that referenced this pull request May 7, 2025
This was referenced May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
After some investigation into Issue #3776, we noticed that getTotalRows() would return 1 for queries that didn't actually return any rows. This docstring explains why the method can potentially return a non-zero value for queries that don't return any rows, such as INSERT, UPDATE, and DELETE.
The reason for this is that the totalRows value can be set to the numDmlAffectedRows in some cases.