docs: deprecate bpd.options.bigquery.allow_large_results in favor of bpd.options.compute.allow_large_results
#1597
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: m
tswast
requested changes
Apr 16, 2025
| @@ -89,7 +89,6 @@ def __init__( | |||
| kms_key_name: Optional[str] = None, | |||
| skip_bq_connection_check: bool = False, | |||
| *, | |||
| allow_large_results: bool = False, | |||
There was a problem hiding this comment.
We already have public documentation including the MSA referencing this option. Let's make this immutable instead and raise a warning that this is deprecated. Direct folks to the compute version in the warning.
Genesis929
force-pushed
the
move_alr_huanc
branch
from
b1aa2e4 to
a9a6354
Compare
tswast
requested changes
Apr 17, 2025
| @@ -112,7 +112,7 @@ def execute( | |||
| max_results: Optional[int] = None, | |||
| ) -> executor.ExecuteResult: | |||
| if use_explicit_destination is None: | |||
| use_explicit_destination = bigframes.options.bigquery.allow_large_results | |||
| use_explicit_destination = bigframes.options.compute.allow_large_results | |||
There was a problem hiding this comment.
Need to use the bigquery option if the compute option is not set.
Suggested change
| use_explicit_destination = bigframes.options.compute.allow_large_results | |
| allow_large_results = bigframes.options.compute.allow_large_results | |
| if allow_large_results is None: | |
| allow_large_results = bigframes.options.bigquery.allow_large_results | |
| use_explicit_destination = allow_large_results |
Since this is going to be used in many places, please make a helper function somewhere in bigframes._config for this.
There was a problem hiding this comment.
added one in Options class, but I'm not sure if that's the best place for it.
tswast
changed the title
bpd.options.bigquery.allow_large_results in favor of bpd.options.compute.allow_large_results
Co-authored-by: Tim Sweña (Swast) <[email protected]>
Co-authored-by: Tim Sweña (Swast) <[email protected]>
Co-authored-by: Tim Sweña (Swast) <[email protected]>
tswast
reviewed
May 1, 2025
| @@ -150,6 +150,12 @@ def is_bigquery_thread_local(self) -> bool: | |||
| """ | |||
| return self._local.bigquery_options is not None | |||
|
|
|||
| @property | |||
| def _allow_large_results(self) -> bool: | |||
There was a problem hiding this comment.
Even though this is private, please add a docstring explaining the purpose.
Co-authored-by: Tim Sweña (Swast) <[email protected]>
tswast
reviewed
May 6, 2025
tswast
approved these changes
May 6, 2025
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.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> 🦕