Skip to content
Permalink
Browse files
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)
  • Loading branch information
tswast committed Jan 14, 2021
1 parent 3518624 commit d9691f1714bf34b3119d4e457293a723c2fb9120
Showing with 8 additions and 2 deletions.
  1. +8 −2 README.rst
@@ -86,15 +86,21 @@ Optional Dependencies
Several features of ``google-cloud-bigquery-storage`` require additional
dependencies.

* Parse Arrow blocks in a ``read_rows()`` stream using `pyarrow
<https://arrow.apache.org/docs/python/>`_.

``pip install 'google-cloud-bigquery-storage[pyarrow]'``


* Parse Avro blocks in a ``read_rows()`` stream using `fastavro
<https://fastavro.readthedocs.io/en/latest/>`_.

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

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

``pip install google-cloud-bigquery-storage[pandas,fastavro]``
``pip install 'google-cloud-bigquery-storage[pandas,pyarrow]'``

Next Steps
~~~~~~~~~~

0 comments on commit d9691f1

Please sign in to comment.