From d9691f1714bf34b3119d4e457293a723c2fb9120 Mon Sep 17 00:00:00 2001 From: Tim Swast Date: Thu, 14 Jan 2021 10:18:03 -0600 Subject: [PATCH] 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) --- README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index ad8a5e99..27d3f4fd 100644 --- a/README.rst +++ b/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 + `_. + + ``pip install 'google-cloud-bigquery-storage[pyarrow]'`` + + * Parse Avro blocks in a ``read_rows()`` stream using `fastavro `_. ``pip install google-cloud-bigquery-storage[fastavro]`` -* Write rows to a `pandas `_ +* Download rows to a `pandas `_ dataframe. - ``pip install google-cloud-bigquery-storage[pandas,fastavro]`` + ``pip install 'google-cloud-bigquery-storage[pandas,pyarrow]'`` Next Steps ~~~~~~~~~~