From b120c1475d3e412715a0a27e60a7df9a6647bed3 Mon Sep 17 00:00:00 2001 From: Ryan Yuan Date: Fri, 2 Oct 2020 22:04:30 +1000 Subject: [PATCH 1/3] docs(samples): add create_table_clustered code snippet --- docs/usage/tables.rst | 9 +++++++ samples/create_table_clustered.py | 39 +++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 samples/create_table_clustered.py diff --git a/docs/usage/tables.rst b/docs/usage/tables.rst index 27af7c7df..7afca05e2 100644 --- a/docs/usage/tables.rst +++ b/docs/usage/tables.rst @@ -58,6 +58,15 @@ Create an empty table with the :start-after: [START bigquery_create_table] :end-before: [END bigquery_create_table] +Create a clustered table with the +:func:`~google.cloud.bigquery.client.Client.create_table` method: + +.. literalinclude:: ../samples/create_table_clustered.py + :language: python + :dedent: 4 + :start-after: [START bigquery_create_table_clustered] + :end-before: [END bigquery_create_table_clustered] + Create an integer range partitioned table with the :func:`~google.cloud.bigquery.client.Client.create_table` method: diff --git a/samples/create_table_clustered.py b/samples/create_table_clustered.py new file mode 100644 index 000000000..25043265e --- /dev/null +++ b/samples/create_table_clustered.py @@ -0,0 +1,39 @@ +# 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] From decf2b1ca0d5dce79fdf214cd897e9b9ed000ff3 Mon Sep 17 00:00:00 2001 From: Ryan Yuan Date: Sat, 3 Oct 2020 13:55:20 +1000 Subject: [PATCH 2/3] docs(samples): add create_table_clustered code snippet --- samples/tests/test_create_table_clustered.py | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 samples/tests/test_create_table_clustered.py diff --git a/samples/tests/test_create_table_clustered.py b/samples/tests/test_create_table_clustered.py new file mode 100644 index 000000000..ab111002a --- /dev/null +++ b/samples/tests/test_create_table_clustered.py @@ -0,0 +1,25 @@ +# 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"] + From eebbb425a8d8e3581f9f30a162a2610ed034b5f9 Mon Sep 17 00:00:00 2001 From: Ryan Yuan Date: Tue, 6 Oct 2020 17:44:29 +1100 Subject: [PATCH 3/3] fix unit test and lint --- samples/create_table_clustered.py | 5 ++++- samples/tests/test_create_table_clustered.py | 5 +---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/samples/create_table_clustered.py b/samples/create_table_clustered.py index 25043265e..2b45b747e 100644 --- a/samples/create_table_clustered.py +++ b/samples/create_table_clustered.py @@ -34,6 +34,9 @@ def create_table_clustered(table_id): 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) + "Created clustered table {}.{}.{}".format( + table.project, table.dataset_id, table.table_id + ) ) # [END bigquery_create_table_clustered] + return table diff --git a/samples/tests/test_create_table_clustered.py b/samples/tests/test_create_table_clustered.py index ab111002a..8eab5d48b 100644 --- a/samples/tests/test_create_table_clustered.py +++ b/samples/tests/test_create_table_clustered.py @@ -16,10 +16,7 @@ def test_create_table_clustered(capsys, random_table_id): - table = create_table_clustered.create_table_clustered( - 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"] -