Skip to content

Commit 5b34b28

Browse files
committed
Add to changelog. Remove comment about destination tables.
1 parent 8b5e80b commit 5b34b28

File tree

3 files changed

+15
-21
lines changed

3 files changed

+15
-21
lines changed

docs/source/changelog.rst

+8
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,16 @@ Enhancements
3939
(contributed by @johnpaton)
4040
- Read ``project_id`` in :func:`to_gbq` from provided ``credentials`` if
4141
available (contributed by @daureg)
42+
<<<<<<< Updated upstream
4243
- ``read_gbq`` uses the timezone-aware ``DatetimeTZDtype(unit='ns',
4344
tz='UTC')`` dtype for BigQuery ``TIMESTAMP`` columns. (:issue:`269`)
45+
||||||| merged common ancestors
46+
=======
47+
- Add ``use_bqstorage_api`` to :func:`read_gbq`. The BigQuery Storage API can
48+
be used to download large query results (>125 MB) more quickly. If the BQ
49+
Storage API can't be used, the BigQuery API is used instead. (:issue:`133`,
50+
:issue:`270`)
51+
>>>>>>> Stashed changes
4452

4553
.. _changelog-0.9.0:
4654

docs/source/reading.rst

+7
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,10 @@ DATETIME datetime64[ns]
8484
TIME datetime64[ns]
8585
DATE datetime64[ns]
8686
================== =========================
87+
88+
.. _reading-bqstorage-api:
89+
90+
Using the BigQuery Storage API
91+
------------------------------
92+
93+
The BigQuery Storage API

pandas_gbq/gbq.py

-21
Original file line numberDiff line numberDiff line change
@@ -885,27 +885,6 @@ def read_gbq(
885885
-------
886886
df: DataFrame
887887
DataFrame representing results of query.
888-
889-
Examples
890-
--------
891-
892-
Use the BigQuery Storage API to fetch results quickly, but at an addition
893-
cost. Due to a known issue in the BigQuery Storage API, you must write
894-
your query results to a destination table.
895-
896-
>>> pandas_gbq.read_gbq(
897-
... query_string,
898-
... configuration={
899-
... 'query': {
900-
... 'destinationTable': {
901-
... 'projectId': 'your-project',
902-
... 'datasetId': 'destination_dataset',
903-
... 'tableId': 'new_table_name',
904-
... }
905-
... }
906-
... },
907-
... use_bqstorage_api=True,
908-
... )
909888
"""
910889
global context
911890

0 commit comments

Comments
 (0)