Skip to content

Commit 445ae08

Browse files
shollymanplamut
andauthored
doc: update wording in RowIterator docstrings to reduce confusion (#127)
Goal: Talking about partition filtration can be problematic, so refer to Storage API capabilities more obliquely. Particularly, partition filtration is possible via a query or a direct storage API read, so don't use as severe of language when describing helper mechanisms such as to_dataframe() on row iterators. Fixes: googleapis/python-bigquery-storage#22 Co-authored-by: Peter Lamut <plamut@users.noreply.github.com>
1 parent e75ff82 commit 445ae08

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

‎google/cloud/bigquery/table.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1515,8 +1515,9 @@ def to_arrow(
15151515
This method requires the ``pyarrow`` and
15161516
``google-cloud-bigquery-storage`` libraries.
15171517
1518-
Reading from a specific partition or snapshot is not
1519-
currently supported by this method.
1518+
This method only exposes a subset of the capabilities of the
1519+
BigQuery Storage API. For full access to all features
1520+
(projections, filters, snapshots) use the Storage API directly.
15201521
create_bqstorage_client (bool):
15211522
Optional. If ``True`` (default), create a BigQuery Storage API
15221523
client using the default API settings. The BigQuery Storage API
@@ -1598,8 +1599,9 @@ def to_dataframe_iterable(self, bqstorage_client=None, dtypes=None):
15981599
This method requires the ``pyarrow`` and
15991600
``google-cloud-bigquery-storage`` libraries.
16001601
1601-
Reading from a specific partition or snapshot is not
1602-
currently supported by this method.
1602+
This method only exposes a subset of the capabilities of the
1603+
BigQuery Storage API. For full access to all features
1604+
(projections, filters, snapshots) use the Storage API directly.
16031605
16041606
**Caution**: There is a known issue reading small anonymous
16051607
query result tables with the BQ Storage API. When a problem
@@ -1666,8 +1668,9 @@ def to_dataframe(
16661668
This method requires the ``pyarrow`` and
16671669
``google-cloud-bigquery-storage`` libraries.
16681670
1669-
Reading from a specific partition or snapshot is not
1670-
currently supported by this method.
1671+
This method only exposes a subset of the capabilities of the
1672+
BigQuery Storage API. For full access to all features
1673+
(projections, filters, snapshots) use the Storage API directly.
16711674
16721675
**Caution**: There is a known issue reading small anonymous
16731676
query result tables with the BQ Storage API. When a problem

0 commit comments

Comments
 (0)