diff --git a/docs/bigquery-usage.rst b/docs/bigquery-usage.rst new file mode 100644 index 0000000000000..53a3495f193f2 --- /dev/null +++ b/docs/bigquery-usage.rst @@ -0,0 +1,49 @@ +Using the API +============= + +Authorization / Configuration +----------------------------- + +- Use :class:`Client ` objects to configure + your applications. + +- :class:`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 ` + and + :meth:`from_service_account_p12 `. + +- After setting ``GOOGLE_APPLICATION_CREDENTIALS`` and ``GCLOUD_PROJECT`` + environment variables, create an instance of + :class:`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') diff --git a/docs/index.rst b/docs/index.rst index 2d418866a7405..71df3e528f87f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,6 +17,7 @@ pubsub-usage pubsub-subscription pubsub-topic + bigquery-usage Getting started