diff --git a/docs/_static/js/main.js b/docs/_static/js/main.js index 11b8202481a0..35a57b701d32 100755 --- a/docs/_static/js/main.js +++ b/docs/_static/js/main.js @@ -15,8 +15,10 @@ $('.headerlink').parent().each(function() { $('.side-nav').children('ul:nth-child(2)').children().each(function() { var itemName = $(this).text(); - if (itemName !== 'Datastore' && itemName !== 'Storage' && - itemName !== 'Pub/Sub') { + if (itemName !== 'Datastore' && + itemName !== 'Storage' && + itemName !== 'Pub/Sub' && + itemName !== 'BigQuery') { $(this).css('padding-left','2em'); } }); @@ -27,6 +29,10 @@ if ($('#cloud-datastore-in-10-seconds').length) apiQsSection = $('#cloud-datastore-in-10-seconds'); else if ($('#cloud-storage-in-10-seconds').length) apiQsSection = $('#cloud-storage-in-10-seconds'); +else if ($('#cloud-pubsub-in-10-seconds').length) + apiQsSection = $('#cloud-pubsub-in-10-seconds'); +else if ($('#cloud-bigquery-in-10-seconds').length) + apiQsSection = $('#cloud-bigquery-in-10-seconds'); if(apiQsSection) { var apiQsSubSections = apiQsSection.children('div'); diff --git a/docs/bigquery-usage.rst b/docs/bigquery-usage.rst new file mode 100644 index 000000000000..ee12c3422f87 --- /dev/null +++ b/docs/bigquery-usage.rst @@ -0,0 +1,57 @@ +.. toctree:: + :maxdepth: 0 + :hidden: + +======== +BigQuery +======== + +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', 'jrandom@example.com') + +- 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 64b2340cd102..aee033827e74 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ pubsub-usage pubsub-subscription pubsub-topic + bigquery-usage Getting started