Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
docs(samples): add create_table_clustered code snippet (#291)
* docs(samples): add create_table_clustered code snippet * docs(samples): add create_table_clustered code snippet * fix unit test and lint Co-authored-by: Tim Swast <swast@google.com>
- Loading branch information
Showing
3 changed files
with
73 additions
and
0 deletions.
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,42 @@ | ||
# Copyright 2019 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
|
||
def create_table_clustered(table_id): | ||
|
||
# [START bigquery_create_table_clustered] | ||
from google.cloud import bigquery | ||
|
||
# Construct a BigQuery client object. | ||
client = bigquery.Client() | ||
|
||
# TODO(developer): Set table_id to the ID of the table to create. | ||
# table_id = "your-project.your_dataset.your_table_name" | ||
|
||
schema = [ | ||
bigquery.SchemaField("full_name", "STRING"), | ||
bigquery.SchemaField("city", "STRING"), | ||
bigquery.SchemaField("zipcode", "INTEGER"), | ||
] | ||
|
||
table = bigquery.Table(table_id, schema=schema) | ||
table.clustering_fields = ["city", "zipcode"] | ||
table = client.create_table(table) # Make an API request. | ||
print( | ||
"Created clustered table {}.{}.{}".format( | ||
table.project, table.dataset_id, table.table_id | ||
) | ||
) | ||
# [END bigquery_create_table_clustered] | ||
return table |
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,22 @@ | ||
# Copyright 2019 Google LLC | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
from .. import create_table_clustered | ||
|
||
|
||
def test_create_table_clustered(capsys, random_table_id): | ||
table = create_table_clustered.create_table_clustered(random_table_id) | ||
out, _ = capsys.readouterr() | ||
assert "Created clustered table {}".format(random_table_id) in out | ||
assert table.clustering_fields == ["city", "zipcode"] |