diff --git a/bigframes/session/__init__.py b/bigframes/session/__init__.py index 8ff5862bfc..2da788292b 100644 --- a/bigframes/session/__init__.py +++ b/bigframes/session/__init__.py @@ -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:** diff --git a/bigframes/streaming/dataframe.py b/bigframes/streaming/dataframe.py index 64a4898c57..b83ae5d822 100644 --- a/bigframes/streaming/dataframe.py +++ b/bigframes/streaming/dataframe.py @@ -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() diff --git a/docs/reference/bigframes.streaming/dataframe.rst b/docs/reference/bigframes.streaming/dataframe.rst new file mode 100644 index 0000000000..79ec64961c --- /dev/null +++ b/docs/reference/bigframes.streaming/dataframe.rst @@ -0,0 +1,6 @@ +bigframes.streaming.dataframe +============================= + +.. autoclass:: bigframes.streaming.dataframe.StreamingDataFrame + :members: + :inherited-members: diff --git a/docs/reference/bigframes.streaming/index.rst b/docs/reference/bigframes.streaming/index.rst new file mode 100644 index 0000000000..20a22072e5 --- /dev/null +++ b/docs/reference/bigframes.streaming/index.rst @@ -0,0 +1,13 @@ + +============================ +BigQuery DataFrame Streaming +============================ + +.. automodule:: bigframes.streaming + :members: + :undoc-members: + +.. toctree:: + :maxdepth: 2 + + dataframe diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 387e9b5ced..eb5a774b29 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -11,3 +11,4 @@ packages. bigframes.pandas/index bigframes.ml/index bigframes.bigquery/index + bigframes.streaming/index diff --git a/docs/templates/toc.yml b/docs/templates/toc.yml index 95bded9a60..736ffba286 100644 --- a/docs/templates/toc.yml +++ b/docs/templates/toc.yml @@ -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