Skip to content

Commit

Permalink
Start DX docs for bigquery: client authorization / configuration.
Browse files Browse the repository at this point in the history
  • Loading branch information
tseaver committed Jul 13, 2015
1 parent 8373227 commit f45f0ad
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/bigquery-usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Using the API
=============

Authorization / Configuration
-----------------------------

- Use :class:`Client <gcloud.bigquery.client.Client>` objects to configure
your applications.

- :class:`Client <gcloud.bigquery.client.Client>` objects hold both a ``project``
and an authenticated connection to the PubSub service.

- The authentication credentials can be implicitly determined from the
environment or directly via
:meth:`from_service_account_json <gcloud.bigquery.client.Client.from_service_account_json>`
and
:meth:`from_service_account_p12 <gcloud.bigquery.client.Client.from_service_account_p12>`.

- After setting ``GOOGLE_APPLICATION_CREDENTIALS`` and ``GCLOUD_PROJECT``
environment variables, create an instance of
:class:`Client <gcloud.bigquery.client.Client>`.

.. doctest::

>>> from gcloud import bigquery
>>> client = bigquery.Client()

- Override the credentials inferred from the environment by passing explicit
``credentials`` to one of the alternative classmethods, `from_service_account_json`:

.. doctest::

>>> from gcloud import bigquery
>>> client = bigquery.Client.from_service_account_json('/path/to/creds.json')

or `from_service_account_p12`:

.. doctest::

>>> from gcloud import bigquery
>>> client = bigquery.Client.from_service_account_p12('/path/to/creds.p12')

- Override the project inferred from the environment by passing an explicit
``project`` to the constructor, or to either of the alternative classmethods:

.. doctest::

>>> from gcloud import bigquery
>>> client = bigquery.Client(project='PROJECT_ID')
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
pubsub-usage
pubsub-subscription
pubsub-topic
bigquery-usage


Getting started
Expand Down

0 comments on commit f45f0ad

Please sign in to comment.