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.

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

docs: revise label table code samples #1451

Merged
merged 8 commits into from
Jan 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,9 @@ def test_manage_table_labels(client, to_delete):
table = bigquery.Table(dataset.table(table_id), schema=SCHEMA)
table = client.create_table(table)

# TODO(Mattix23): After code sample from https://github.com/googleapis/python-bigquery/pull/1451
# is updated from cloud.google.com delete this.

# [START bigquery_label_table]
# from google.cloud import bigquery
# client = bigquery.Client()
Expand Down
37 changes: 37 additions & 0 deletions samples/snippets/label_table.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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 label_table(table_id: str) -> None:
orig_table_id = table_id
# [START bigquery_label_table]
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"

# [END bigquery_label_table]
table_id = orig_table_id
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you clarify the reason that orig_table_id is needed? Could we remove orig_table_id and just have table_id?

# [START bigquery_label_table]
table = client.get_table(table_id) # API request

labels = {"color": "green"}
table.labels = labels

table = client.update_table(table, ["labels"]) # API request

print(f"Added {table.labels} to {table_id}.")
# [END bigquery_label_table]
32 changes: 32 additions & 0 deletions samples/snippets/label_table_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 label_table

if typing.TYPE_CHECKING:
import pytest


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

label_table.label_table(table_id)

out, _ = capsys.readouterr()
assert "color" in out
assert table_id in out