-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
tseaver
merged 4 commits into
googleapis:master
from
tseaver:bigquery-devx-client_authz_configure
Jul 20, 2015
+66
−2
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
f74b8fe
Start DX docs for bigquery: client authorization / configuration.
tseaver 590519e
Pass required 'client_email' to 'Client.from_service_account_p12'.
tseaver ebcdc92
Get BigQuery positioned correctly in left-side navbar.
tseaver 4c0bc4f
Treat 'BigQuery' as one word.
tseaver File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
- :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.
Sorry, something went wrong.
This comment was marked as spam.
Sorry, something went wrong. |
||
|
||
>>> 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') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ | |
pubsub-usage | ||
pubsub-subscription | ||
pubsub-topic | ||
bigquery-usage | ||
|
||
|
||
Getting started | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This comment was marked as spam.
Sorry, something went wrong.