Skip to content

feat: add streaming.StreamingDataFrame class #864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jul 31, 2024
Merged
Prev Previous commit
Next Next commit
add preview warning
  • Loading branch information
GarrettWu committed Jul 29, 2024
commit 5be015536af2b0082710dbf6745fc8d53aba8591
8 changes: 8 additions & 0 deletions bigframes/session/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -755,13 +755,21 @@ def read_gbq_table_streaming(
) -> bigframes.streaming.StreamingDataFrame:
"""Turn a BigQuery table into a StreamingDataFrame.

Note: The bigframes.streaming module is a preview feature, and subject to change.

**Examples:**

>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None

>>> sdf = bpd.read_gbq_table_streaming("bigquery-public-data.ml_datasets.penguins")
"""
warnings.warn(
"The bigframes.streaming module is a preview feature, and subject to change.",
stacklevel=1,
category=bigframes.exceptions.PreviewWarning,
)

from bigframes import streaming
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure we raise a PreviewWarning and mark this as a preview method in the docstring.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


df = self._read_gbq_table(
Expand Down