From d1eb8b3dcc789916c5d3ba8464f62b1f8bef35ff Mon Sep 17 00:00:00 2001
From: Ryan Yuan <ryan.yuan@outlook.com>
Date: Wed, 7 Oct 2020 06:00:18 +1100
Subject: [PATCH] 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>
---
 docs/usage/tables.rst                        |  9 +++++
 samples/create_table_clustered.py            | 42 ++++++++++++++++++++
 samples/tests/test_create_table_clustered.py | 22 ++++++++++
 3 files changed, 73 insertions(+)
 create mode 100644 samples/create_table_clustered.py
 create mode 100644 samples/tests/test_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..2b45b747e
--- /dev/null
+++ b/samples/create_table_clustered.py
@@ -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
diff --git a/samples/tests/test_create_table_clustered.py b/samples/tests/test_create_table_clustered.py
new file mode 100644
index 000000000..8eab5d48b
--- /dev/null
+++ b/samples/tests/test_create_table_clustered.py
@@ -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"]