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 delete label table code sample, add TODO to clean up sni… #1466

Merged
merged 5 commits into from
Jan 18, 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
2 changes: 2 additions & 0 deletions docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,8 @@ def test_manage_table_labels(client, to_delete):
# [END bigquery_get_table_labels]
assert table.labels == labels

# TODO(Mattix23): After code sample is updated from cloud.google.com delete this

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

from google.cloud import bigquery


def delete_label_table(table_id: str, label_key: str) -> bigquery.Table:
orig_table_id = table_id
orig_label_key = label_key
# [START bigquery_delete_label_table]
from google.cloud import bigquery

client = bigquery.Client()

# TODO(dev): Change table_id to the full name of the table you wish to delete from.
table_id = "your-project.your_dataset.your_table_name"
# TODO(dev): Change label_key to the name of the label you want to remove.
label_key = "color"
# [END bigquery_delete_label_table]
table_id = orig_table_id
label_key = orig_label_key
# [START bigquery_delete_label_table]
table = client.get_table(table_id) # API request

# To delete a label from a table, set its value to None
table.labels[label_key] = None

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

print(f"Deleted label '{label_key}' from {table_id}.")
# [END bigquery_delete_label_table]
return table
34 changes: 34 additions & 0 deletions samples/snippets/delete_label_table_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 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 delete_label_table

if typing.TYPE_CHECKING:
import pytest


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

table = delete_label_table.delete_label_table(table_id, "color")

out, _ = capsys.readouterr()
assert "Deleted" in out
assert "color" in out
assert table_id in out
assert table.labels is None or "color" not in table.labels