Skip to content

Commit 3f0eaa1

Browse files
Genesis929tswast
andauthored
docs: add warning for bigframes 2.0 (#1557)
* docs: add warning for bigframes 2.0 * style update * update content * update text * upadte based on comment * update wording * move to lower * Add llm change * Update README.rst --------- Co-authored-by: Tim Sweña (Swast) <[email protected]>
1 parent b2375de commit 3f0eaa1

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.rst

+17
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,23 @@ powered by the BigQuery engine.
1212
BigQuery DataFrames is an open-source package. You can run
1313
``pip install --upgrade bigframes`` to install the latest version.
1414

15+
.. raw:: html
16+
17+
<div style="border: 1px solid #f5c6cb;
18+
background-color: #f8d7da; color: #721c24; padding: 15px; margin-bottom: 20px; border-radius: 4px; font-size: 90%;">
19+
<p style="margin-top: 0; font-weight: bold;">⚠️ Breaking Changes in BigQuery DataFrames v2.0</p>
20+
<p>Version 2.0 introduces breaking changes for improved security and performance. Key default behaviors have changed:</p>
21+
<ul>
22+
<li><strong>Large Results (&gt;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>
23+
<li><strong>Remote Function Security:</strong>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". And network ingress now defaults to "internal-only".</li>
24+
<li><strong>@remote_function Argument Passing:</strong> Arguments other than input_types, output_type, and dataset to remote_function must now be passed using keyword syntax, as positional arguments are no longer supported.</li>
25+
<li><strong>Endpoint Connections:</strong> Automatic fallback to locational endpoints in certain regions is removed. </li>
26+
<li><strong>LLM Changes (Shift to Gemini):</strong> Integrations now default to <code>gemini-2.0-flash-001</code>. Support for PaLM2 models has been removed; migrate any PaLM2 usage to Gemini.</li>
27+
</ul>
28+
<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.42.0</code>) to avoid disruption.</p>
29+
<p style="margin-bottom: 0;"> To learn about these changes and how to migrate to version 2.0, see: <a href="https://cloud.google.com/bigquery/docs/bigquery-dataframes-introduction" style="color: #842029; text-decoration: underline;">updated introduction guide</a>.</p>
30+
</div>
31+
1532
.. |GA| image:: https://img.shields.io/badge/support-GA-gold.svg
1633
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#general-availability
1734
.. |pypi| image:: https://img.shields.io/pypi/v/bigframes.svg

0 commit comments

Comments
 (0)