docs: add warning for bigframes 2.0 #1557
Merged
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: s
shobsi
reviewed
Mar 28, 2025
shobsi
reviewed
Mar 28, 2025
README.rst
Outdated
| <p>Version 2.0 introduces breaking changes for improved security and performance. Key default behaviors have changed:</p> | ||
| <ul> | ||
| <li><strong>Large Results (>10GB):</strong> The default value for <code>allow_large_results</code> has changed to False. Methods like <code>to_pandas()</code> will now fail if the query result's compressed data size exceeds 10GB, unless large results are explicitly permitted.</li> | ||
| <li><strong>Remote Function Security:</strong> The library no longer defaults to using the Compute Engine service account, and network ingress now defaults to "internal-only".</li> |
There was a problem hiding this comment.
[nit] suggest rephrasing:
The library no longer automatically lets the Compute Engine default service account become the identity of the Cloud Run functions. If that is desired, it has to be indicated by passing cloud_function_service_account="default".
In addition, we should also call out:
Arguments to remote_function would have to be passed as keyword arguments.
There was a problem hiding this comment.
Updated, also added a new line for keyword arguments.
shobsi
reviewed
Mar 28, 2025
README.rst
Outdated
| <li><strong>Remote Function Security:</strong> The library no longer defaults to using the Compute Engine service account, and network ingress now defaults to "internal-only".</li> | ||
| <li><strong>Endpoint Connections:</strong> Automatic fallback to locational endpoints in certain regions is removed. </li> | ||
| </ul> | ||
| <p><strong>Important:</strong> If you are not ready to adapt to these changes, please pin your dependency to a version less than 2.0 (e.g., <code>bigframes==1.38.0</code>) to avoid disruption.</p> |
There was a problem hiding this comment.
we should say 1.42.0, as that is the latest release
tswast
reviewed
Mar 28, 2025
tswast
approved these changes
Mar 28, 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> 🦕
Staging result: https://screenshot.googleplex.com/4iMfjL9VsB7ZXy5