-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add notes on 'project' as an entity within the API. #1000
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 hidden or 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 |
|---|---|---|
|
|
@@ -34,31 +34,61 @@ Authorization / Configuration | |
| >>> client = bigquery.Client() | ||
|
|
||
| - Override the credentials inferred from the environment by passing explicit | ||
| ``credentials`` to one of the alternative classmethods, `from_service_account_json`: | ||
| ``credentials`` to one of the alternative ``classmethod`` factories, | ||
| `:meth:gcloud.bigquery.client.Client.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`: | ||
| or `:meth:gcloud.bigquery.client.Client.from_service_account_p12`: | ||
|
|
||
| .. doctest:: | ||
|
|
||
| >>> from gcloud import bigquery | ||
| >>> client = bigquery.Client.from_service_account_p12('/path/to/creds.p12', '[email protected]') | ||
|
|
||
| - Override the project inferred from the environment by passing an explicit | ||
| ``project`` to the constructor, or to either of the alternative classmethods: | ||
|
|
||
| Projects | ||
| -------- | ||
|
|
||
| A project is the top-level container in the ``BigQuery`` API: it is tied | ||
| closely to billing, and can provide default access control across all its | ||
| datasets. If no ``project`` is passed to the client container, the library | ||
| attempts to infer a project using the environment (including explicit | ||
| environment variables, GAE, and GCE). | ||
|
|
||
| To override the project inferred from the environment, pass an explicit | ||
| ``project`` to the constructor, or to either of the alternative | ||
| ``classmethod`` factories: | ||
|
|
||
| .. doctest:: | ||
|
|
||
| >>> from gcloud import bigquery | ||
| >>> client = bigquery.Client(project='PROJECT_ID') | ||
|
|
||
| Project ACLs | ||
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
Sorry, something went wrong. |
||
| ~~~~~~~~~~~~ | ||
|
|
||
| Each project has an access control list granting reader / writer / owner | ||
| permission to one or more entities. This list cannot be queried or set | ||
| via the API: it must be managed using the Google Developer Console. | ||
|
|
||
| Datasets | ||
| -------- | ||
|
|
||
| A dataset represents a collection of tables, and applies several default | ||
| policies to tables as they are created: | ||
|
|
||
| - An access control list (ACL). When created, a dataset has an ACL | ||
| which maps to the ACL inherited from its project. | ||
|
|
||
| - A default table expiration period. If set, tables created within the | ||
| dataset will have the value as their expiration period. | ||
|
|
||
| Manage datasets | ||
| --------------- | ||
| Dataset operations | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Create a new dataset for the client's project: | ||
|
|
||
|
|
@@ -100,7 +130,7 @@ Patch metadata for a dataset: | |
| >>> dataset.patch(description='Description goes here', | ||
| ... default_table_expiration_ms=one_day_ms) # API request | ||
|
|
||
| Replace the ACL for a project, and update all writeable fields: | ||
| Replace the ACL for a dataset, and update all writeable fields: | ||
|
|
||
| .. doctest:: | ||
|
|
||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
This comment was marked as spam.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.