Skip to content

Commit f21edfe

Browse files
tswastparthea
authored andcommitted
docs: add note about Arrow blocks to README (#73)
Suggest Arrow as prefered data format when downloading to a pandas dataframe, as this is several times faster. Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery-storage/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [x] Appropriate docs were updated (if necessary)
1 parent 5e06588 commit f21edfe

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/google-cloud-bigquery-storage/README.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,21 @@ Optional Dependencies
8686
Several features of ``google-cloud-bigquery-storage`` require additional
8787
dependencies.
8888

89+
* Parse Arrow blocks in a ``read_rows()`` stream using `pyarrow
90+
<https://arrow.apache.org/docs/python/>`_.
91+
92+
``pip install 'google-cloud-bigquery-storage[pyarrow]'``
93+
94+
8995
* Parse Avro blocks in a ``read_rows()`` stream using `fastavro
9096
<https://fastavro.readthedocs.io/en/latest/>`_.
9197

9298
``pip install google-cloud-bigquery-storage[fastavro]``
9399

94-
* Write rows to a `pandas <http://pandas.pydata.org/pandas-docs/stable/>`_
100+
* Download rows to a `pandas <http://pandas.pydata.org/pandas-docs/stable/>`_
95101
dataframe.
96102

97-
``pip install google-cloud-bigquery-storage[pandas,fastavro]``
103+
``pip install 'google-cloud-bigquery-storage[pandas,pyarrow]'``
98104

99105
Next Steps
100106
~~~~~~~~~~

0 commit comments

Comments
 (0)