Skip to content

Commit

Permalink
DOC: fix numbering of BQ Storage API steps.
Browse files Browse the repository at this point in the history
  • Loading branch information
tswast committed Apr 5, 2019
1 parent 5e80908 commit b7472c3
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions docs/source/reading.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,29 +95,31 @@ quickly (but at an `increased cost
<https://cloud.google.com/bigquery/pricing#storage-api>`__) by setting
``use_bqstorage_api`` to ``True``.

1. Enable the BigQuery Storage API on the project you are using to run
queries.
#. Enable the BigQuery Storage API on the project you are using to run
queries.

`Enable the API
<https://console.cloud.google.com/apis/library/bigquerystorage.googleapis.com>`__.
2. Ensure you have the `*bigquery.readsessions.create permission*
<https://cloud.google.com/bigquery/docs/access-control#bq-permissions>`__. to
create BigQuery Storage API read sessions. This permission is provided by
the `*bigquery.user* role
<https://cloud.google.com/bigquery/docs/access-control#roles>`__.
4. Install the ``google-cloud-bigquery-storage``, ``fastavro``, and
``python-snappy`` packages.
`Enable the API
<https://console.cloud.google.com/apis/library/bigquerystorage.googleapis.com>`__.
#. Ensure you have the `bigquery.readsessions.create permission
<https://cloud.google.com/bigquery/docs/access-control#bq-permissions>`__. to
create BigQuery Storage API read sessions. This permission is provided by
the `bigquery.user role
<https://cloud.google.com/bigquery/docs/access-control#roles>`__.
#. Install the ``google-cloud-bigquery-storage``, ``fastavro``, and
``python-snappy`` packages.

With pip:
With pip:

..code-block:: sh
.. code-block:: sh
pip install --upgrade google-cloud-bigquery-storage fastavro python-snappy
pip install --upgrade google-cloud-bigquery-storage fastavro python-snappy
With conda:
With conda:

conda install -c conda-forge google-cloud-bigquery-storage fastavro python-snappy
4. Set ``use_bqstorage_api`` to ``True`` when calling the
.. code-block:: sh
conda install -c conda-forge google-cloud-bigquery-storage fastavro python-snappy
#. Set ``use_bqstorage_api`` to ``True`` when calling the
:func:`~pandas_gbq.read_gbq` function. As of the ``google-cloud-bigquery``
package, version 1.11.1 or later,the function will fallback to the
BigQuery API if the BigQuery Storage API cannot be used, such as with
Expand Down

0 comments on commit b7472c3

Please sign in to comment.