ENH: Add max_results kwarg to read_gbq #34641
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
Since max_results is a new kwarg (added in pandas-gbq 0.12.0), it is handled and tested in the same way as use_bqstorage_api, using the "new kwargs" mechanism to maintain backwards compatibility with older pandas-gbq versions.
JohnPaton
commented
Jun 8, 2020
Comment on lines
+129
to
+131
| max_results : int, optional | ||
| If set, limit the maximum number of rows to fetch from the query | ||
| results. |
There was a problem hiding this comment.
I just copied the docstring from pandas-gbq here, but given the current behaviour it might be an idea to add a line like
If set to 0, ``read_gbq`` will return ``None`` once the query has
executed.
jreback
approved these changes
Jun 9, 2020
tswast
approved these changes
Jun 9, 2020
|
thanks @JohnPaton |
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.
Adds support for the new
max_resultskwarg from pandas-gbq (added in 0.12.0). Sincemax_resultsis a new kwarg, it is handled and tested in the same way as theuse_bqstorage_apikwarg to maintain backwards compatibility.❓ Open question: Setting
max_results=0causespandas_gbq.read_gbqto returnNoneinstead of a DataFrame. I've kept this behaviour the same in this PR, but maintainers may prefer to always return a (empty) DataFrame instead ofNone.read_gbq#34639black pandasgit diff upstream/master -u -- "*.py" | flake8 --diff