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.

Sign up for GitHub

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

Update redirects and references for BigQuery docs. #3196

Merged
merged 1 commit into from
Mar 23, 2017
Merged

Update redirects and references for BigQuery docs. #3196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions bigquery/google/cloud/bigquery/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def list_projects(self, max_results=None, page_token=None):
"""List projects for the project associated with this client.

See:
https://cloud.google.com/bigquery/docs/reference/v2/projects/list
https://cloud.google.com/bigquery/docs/reference/rest/v2/projects/list

:type max_results: int
:param max_results: maximum number of projects to return, If not
Expand All @@ -110,7 +110,7 @@ def list_datasets(self, include_all=False, max_results=None,
"""List datasets for the project associated with this client.

See:
https://cloud.google.com/bigquery/docs/reference/v2/datasets/list
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/list

:type include_all: bool
:param include_all: True if results include hidden datasets.
Expand Down Expand Up @@ -182,7 +182,7 @@ def list_jobs(self, max_results=None, page_token=None, all_users=None,
"""List jobs for the project associated with this client.

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs/list
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/list

:type max_results: int
:param max_results: maximum number of jobs to return, If not
Expand Down Expand Up @@ -226,7 +226,7 @@ def load_table_from_storage(self, job_name, destination, *source_uris):
"""Construct a job for loading data into a table from CloudStorage.

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load

:type job_name: str
:param job_name: Name of the job.
Expand All @@ -248,7 +248,7 @@ def copy_table(self, job_name, destination, *sources):
"""Construct a job for copying one or more tables into another table.

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.copy

:type job_name: str
:param job_name: Name of the job.
Expand All @@ -268,7 +268,7 @@ def extract_table_to_storage(self, job_name, source, *destination_uris):
"""Construct a job for extracting a table into Cloud Storage files.

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extract
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract

:type job_name: str
:param job_name: Name of the job.
Expand All @@ -292,7 +292,7 @@ def run_async_query(self, job_name, query,
"""Construct a job for running a SQL query asynchronously.

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query

:type job_name: str
:param job_name: Name of the job.
Expand Down
18 changes: 9 additions & 9 deletions bigquery/google/cloud/bigquery/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class AccessGrant(object):
``role`` specified. ``role`` is omitted for a ``view``, since
``view`` s are always read-only.

See https://cloud.google.com/bigquery/docs/reference/v2/datasets.
See https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets.

:type role: str
:param role: Role granted to the entity. One of
Expand Down Expand Up @@ -90,7 +90,7 @@ class Dataset(object):
"""Datasets are containers for tables.

See:
https://cloud.google.com/bigquery/docs/reference/v2/datasets
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets

:type name: str
:param name: the name of the dataset
Expand Down Expand Up @@ -418,7 +418,7 @@ def create(self, client=None):
"""API call: create the dataset via a PUT request.

See:
https://cloud.google.com/bigquery/docs/reference/v2/tables/insert
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/insert

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -435,7 +435,7 @@ def exists(self, client=None):
"""API call: test for the existence of the dataset via a GET request

See
https://cloud.google.com/bigquery/docs/reference/v2/datasets/get
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/get

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -459,7 +459,7 @@ def reload(self, client=None):
"""API call: refresh dataset properties via a GET request.

See
https://cloud.google.com/bigquery/docs/reference/v2/datasets/get
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/get

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -476,7 +476,7 @@ def patch(self, client=None, **kw):
"""API call: update individual dataset properties via a PATCH request.

See
https://cloud.google.com/bigquery/docs/reference/v2/datasets/patch
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/patch

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand Down Expand Up @@ -515,7 +515,7 @@ def update(self, client=None):
"""API call: update dataset properties via a PUT request.

See
https://cloud.google.com/bigquery/docs/reference/v2/datasets/update
https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets/update

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -531,7 +531,7 @@ def delete(self, client=None):
"""API call: delete the dataset via a DELETE request.

See:
https://cloud.google.com/bigquery/docs/reference/v2/tables/delete
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/delete

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -545,7 +545,7 @@ def list_tables(self, max_results=None, page_token=None):
"""List tables for the project associated with this client.

See:
https://cloud.google.com/bigquery/docs/reference/v2/tables/list
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/list

:type max_results: int
:param max_results: (Optional) Maximum number of tables to return.
Expand Down
62 changes: 31 additions & 31 deletions bigquery/google/cloud/bigquery/job.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def begin(self, client=None):
"""API call: begin the job via a POST request

See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs/insert
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -324,7 +324,7 @@ def exists(self, client=None):
"""API call: test for the existence of the job via a GET request

See
https://cloud.google.com/bigquery/docs/reference/v2/jobs/get
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -348,7 +348,7 @@ def reload(self, client=None):
"""API call: refresh job properties via a GET request

See
https://cloud.google.com/bigquery/docs/reference/v2/jobs/get
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand All @@ -365,7 +365,7 @@ def cancel(self, client=None):
"""API call: cancel job via a POST request

See
https://cloud.google.com/bigquery/docs/reference/v2/jobs/cancel
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/cancel

:type client: :class:`~google.cloud.bigquery.client.Client` or
``NoneType``
Expand Down Expand Up @@ -498,57 +498,57 @@ def output_rows(self):

allow_jagged_rows = _TypedProperty('allow_jagged_rows', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowJaggedRows
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.allowJaggedRows
"""

allow_quoted_newlines = _TypedProperty('allow_quoted_newlines', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.allowQuotedNewlines
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.allowQuotedNewlines
"""

create_disposition = CreateDisposition('create_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.createDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.createDisposition
"""

encoding = Encoding('encoding')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.encoding
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.encoding
"""

field_delimiter = _TypedProperty('field_delimiter', six.string_types)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.fieldDelimiter
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.fieldDelimiter
"""

ignore_unknown_values = _TypedProperty('ignore_unknown_values', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.ignoreUnknownValues
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.ignoreUnknownValues
"""

max_bad_records = _TypedProperty('max_bad_records', six.integer_types)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.maxBadRecords
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.maxBadRecords
"""

quote_character = _TypedProperty('quote_character', six.string_types)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.quote
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.quote
"""

skip_leading_rows = _TypedProperty('skip_leading_rows', six.integer_types)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.skipLeadingRows
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.skipLeadingRows
"""

source_format = SourceFormat('source_format')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.sourceFormat
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.sourceFormat
"""

write_disposition = WriteDisposition('write_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load.writeDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.writeDisposition
"""

def _populate_config_resource(self, configuration):
Expand Down Expand Up @@ -673,12 +673,12 @@ def __init__(self, name, destination, sources, client):

create_disposition = CreateDisposition('create_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.copy.createDisposition
"""

write_disposition = WriteDisposition('write_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.copy.writeDisposition
"""

def _populate_config_resource(self, configuration):
Expand Down Expand Up @@ -796,22 +796,22 @@ def __init__(self, name, source, destination_uris, client):

compression = Compression('compression')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.compression
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.compression
"""

destination_format = DestinationFormat('destination_format')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.destinationFormat
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.destinationFormat
"""

field_delimiter = _TypedProperty('field_delimiter', six.string_types)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.fieldDelimiter
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.fieldDelimiter
"""

print_header = _TypedProperty('print_header', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.extracted.printHeader
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.extract.printHeader
"""

def _populate_config_resource(self, configuration):
Expand Down Expand Up @@ -937,32 +937,32 @@ def __init__(self, name, query, client,

allow_large_results = _TypedProperty('allow_large_results', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.allowLargeResults
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.allowLargeResults
"""

create_disposition = CreateDisposition('create_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.createDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.createDisposition
"""

default_dataset = _TypedProperty('default_dataset', Dataset)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.defaultDataset
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.defaultDataset
"""

destination = _TypedProperty('destination', Table)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.destinationTable
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.destinationTable
"""

flatten_results = _TypedProperty('flatten_results', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.flattenResults
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.flattenResults
"""

priority = QueryPriority('priority')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.priority
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.priority
"""

query_parameters = QueryParametersProperty()
Expand All @@ -971,7 +971,7 @@ def __init__(self, name, query, client,

use_query_cache = _TypedProperty('use_query_cache', bool)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.useQueryCache
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.useQueryCache
"""

use_legacy_sql = _TypedProperty('use_legacy_sql', bool)
Expand All @@ -988,17 +988,17 @@ def __init__(self, name, query, client,

write_disposition = WriteDisposition('write_disposition')
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.writeDisposition
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.writeDisposition
"""

maximum_billing_tier = _TypedProperty('maximum_billing_tier', int)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.maximumBillingTier
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.maximumBillingTier
"""

maximum_bytes_billed = _TypedProperty('maximum_bytes_billed', int)
"""See:
https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.maximumBytesBilled
https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.maximumBytesBilled
"""

def _destination_table_resource(self):
Expand Down
Loading