Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add streaming html docs #884

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.

Sign up for GitHub

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 3 commits into from
Aug 6, 2024
Merged

docs: add streaming html docs #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a63d60
docs: add streaming html docs
GarrettWu Aug 6, 2024
a386b2f
add beta icon
GarrettWu Aug 6, 2024
9b49610
add beta icon in toc.yml
GarrettWu Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion bigframes/session/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,9 @@ def read_gbq_table_streaming(
) -> streaming_dataframe.StreamingDataFrame:
"""Turn a BigQuery table into a StreamingDataFrame.

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

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

**Examples:**

Expand Down
11 changes: 10 additions & 1 deletion bigframes/streaming/dataframe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,16 @@ def to_pubsub(

@log_adapter.class_logger
class StreamingDataFrame(StreamingBase):
__doc__ = _curate_df_doc(dataframe.DataFrame.__doc__)
__doc__ = (
_curate_df_doc(dataframe.DataFrame.__doc__)
+ """
.. note::

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

Currently only supports basic projection, filtering and preview operations.
"""
)

# Private constructor
_create_key = object()
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/bigframes.streaming/dataframe.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
bigframes.streaming.dataframe
=============================

.. autoclass:: bigframes.streaming.dataframe.StreamingDataFrame
:members:
:inherited-members:
13 changes: 13 additions & 0 deletions docs/reference/bigframes.streaming/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

============================
BigQuery DataFrame Streaming
============================

.. automodule:: bigframes.streaming
:members:
:undoc-members:

.. toctree::
:maxdepth: 2

dataframe
1 change: 1 addition & 0 deletions docs/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ packages.
bigframes.pandas/index
bigframes.ml/index
bigframes.bigquery/index
bigframes.streaming/index
7 changes: 7 additions & 0 deletions docs/templates/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,11 @@
- name: BigQuery built-in functions
uid: bigframes.bigquery
name: bigframes.bigquery
- items:
- name: Overview
uid: bigframes.streaming
- name: StreamingDataFrame
uid: bigframes.streaming.dataframe.StreamingDataFrame
name: bigframes.streaming
status: beta
name: BigQuery DataFrames