diff --git a/docs/source/reading.rst b/docs/source/reading.rst index e10f533c..0be39b14 100644 --- a/docs/source/reading.rst +++ b/docs/source/reading.rst @@ -95,29 +95,31 @@ quickly (but at an `increased cost `__) 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 - `__. -2. Ensure you have the `*bigquery.readsessions.create permission* - `__. to - create BigQuery Storage API read sessions. This permission is provided by - the `*bigquery.user* role - `__. -4. Install the ``google-cloud-bigquery-storage``, ``fastavro``, and - ``python-snappy`` packages. + `Enable the API + `__. +#. Ensure you have the `bigquery.readsessions.create permission + `__. to + create BigQuery Storage API read sessions. This permission is provided by + the `bigquery.user role + `__. +#. 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