Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start DX docs for bigquery: client authorization / configuration. #985

Merged
merged 4 commits into from
Jul 20, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/_static/js/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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');
}
});
Expand All @@ -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');
Expand Down
57 changes: 57 additions & 0 deletions docs/bigquery-usage.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. toctree::
:maxdepth: 0
:hidden:

========
BigQuery
========

Using the API
=============

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

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

This comment was marked as spam.


- :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::

This comment was marked as spam.

This comment was marked as spam.


>>> 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')
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
pubsub-usage
pubsub-subscription
pubsub-topic
bigquery-usage


Getting started
Expand Down