Skip to content

Commit

Permalink
docs: revise sample for nested schema (#1446)
Browse files Browse the repository at this point in the history
* docs: revise sample for nested schema

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* added TODO

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
Mattix23 and gcf-owl-bot[bot] authored Dec 20, 2022
1 parent 093cc68 commit a097631
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ def test_create_client_default_credentials():
assert client is not None


# TODO(Mattix23): After code sample from https://github.com/googleapis/python-bigquery/pull/1446
# is updated from cloud.google.com delete this.
def test_create_table_nested_repeated_schema(client, to_delete):
dataset_id = "create_table_nested_repeated_{}".format(_millis())
project = client.project
Expand Down
54 changes: 54 additions & 0 deletions samples/snippets/nested_repeated_schema.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Copyright 2022 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 nested_schema(table_id: str) -> None:
orig_table_id = table_id
# [START bigquery_nested_repeated_schema]
from google.cloud import bigquery

client = bigquery.Client()

# TODO(dev): Change table_id to the full name of the table you want to create.
table_id = "your-project.your_dataset.your_table_name"

schema = [
bigquery.SchemaField("id", "STRING", mode="NULLABLE"),
bigquery.SchemaField("first_name", "STRING", mode="NULLABLE"),
bigquery.SchemaField("last_name", "STRING", mode="NULLABLE"),
bigquery.SchemaField("dob", "DATE", mode="NULLABLE"),
bigquery.SchemaField(
"addresses",
"RECORD",
mode="REPEATED",
fields=[
bigquery.SchemaField("status", "STRING", mode="NULLABLE"),
bigquery.SchemaField("address", "STRING", mode="NULLABLE"),
bigquery.SchemaField("city", "STRING", mode="NULLABLE"),
bigquery.SchemaField("state", "STRING", mode="NULLABLE"),
bigquery.SchemaField("zip", "STRING", mode="NULLABLE"),
bigquery.SchemaField("numberOfYears", "STRING", mode="NULLABLE"),
],
),
]
# [END bigquery_nested_repeated_schema]

table_id = orig_table_id

# [START bigquery_nested_repeated_schema]
table = bigquery.Table(table_id, schema=schema)
table = client.create_table(table) # API request

print(f"Created table {table.project}.{table.dataset_id}.{table.table_id}.")
# [END bigquery_nested_repeated_schema]
32 changes: 32 additions & 0 deletions samples/snippets/nested_repeated_schema_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

import typing

import nested_repeated_schema

if typing.TYPE_CHECKING:
import pytest


def test_create_table(
capsys: "pytest.CaptureFixture[str]",
random_table_id: str,
) -> None:

nested_repeated_schema.nested_schema(random_table_id)

out, _ = capsys.readouterr()
assert "Created" in out
assert random_table_id in out

0 comments on commit a097631

Please sign in to comment.