Skip to content

doc: update wording in rowiterator docstrings to reduce confusion #127

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
plamut merged 2 commits into from
Jun 11, 2020
Merged

doc: update wording in rowiterator docstrings to reduce confusion #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a86266
doc: update wording in docstrings to reduce confusion
shollyman Jun 9, 2020
a0962c5
Merge branch 'master' into docs-rowiterator
plamut Jun 10, 2020
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
15 changes: 9 additions & 6 deletions google/cloud/bigquery/table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1515,8 +1515,9 @@ def to_arrow(
This method requires the ``pyarrow`` and
``google-cloud-bigquery-storage`` libraries.

Reading from a specific partition or snapshot is not
currently supported by this method.
This method only exposes a subset of the capabilities of the
BigQuery Storage API. For full access to all features
(projections, filters, snapshots) use the Storage API directly.
create_bqstorage_client (bool):
Optional. If ``True`` (default), create a BigQuery Storage API
client using the default API settings. The BigQuery Storage API
Expand Down Expand Up @@ -1598,8 +1599,9 @@ def to_dataframe_iterable(self, bqstorage_client=None, dtypes=None):
This method requires the ``pyarrow`` and
``google-cloud-bigquery-storage`` libraries.

Reading from a specific partition or snapshot is not
currently supported by this method.
This method only exposes a subset of the capabilities of the
BigQuery Storage API. For full access to all features
(projections, filters, snapshots) use the Storage API directly.

**Caution**: There is a known issue reading small anonymous
query result tables with the BQ Storage API. When a problem
Expand Down Expand Up @@ -1666,8 +1668,9 @@ def to_dataframe(
This method requires the ``pyarrow`` and
``google-cloud-bigquery-storage`` libraries.

Reading from a specific partition or snapshot is not
currently supported by this method.
This method only exposes a subset of the capabilities of the
BigQuery Storage API. For full access to all features
(projections, filters, snapshots) use the Storage API directly.

**Caution**: There is a known issue reading small anonymous
query result tables with the BQ Storage API. When a problem
Expand Down