Skip to content

Commit

Permalink
docs: revise create table cmek sample (#1452)
Browse files Browse the repository at this point in the history
* docs: revise create table cmek sample

* 🦉 Updates from OwlBot post-processor

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

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <partheniou@google.com>
  • Loading branch information
3 people authored Jan 6, 2023
1 parent 14ae1f2 commit 57740e4
Show file tree
Hide file tree
Showing 3 changed files with 84 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ def test_create_table_cmek(client, to_delete):
dataset = bigquery.Dataset(dataset_ref)
client.create_dataset(dataset)
to_delete.append(dataset)

# TODO(Mattix23): When sample is updated in cloud.google.com, delete this one.
# [START bigquery_create_table_cmek]
# from google.cloud import bigquery
# client = bigquery.Client()
Expand Down
46 changes: 46 additions & 0 deletions samples/snippets/create_table_cmek.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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 create_table_cmek(table_id: str, kms_key_name: str) -> None:
orig_table_id = table_id
orig_key_name = kms_key_name
# [START bigquery_create_table_cmek]
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"

# Set the encryption key to use for the table.
# TODO: Replace this key with a key you have created in Cloud KMS.
kms_key_name = "projects/your-project/locations/us/keyRings/test/cryptoKeys/test"

# [END bigquery_create_table_cmek]

table_id = orig_table_id
kms_key_name = orig_key_name

# [START bigquery_create_table_cmek]
table = bigquery.Table(table_id)
table.encryption_configuration = bigquery.EncryptionConfiguration(
kms_key_name=kms_key_name
)
table = client.create_table(table) # API request

print(f"Created {table_id}.")
print(f"Key: {table.encryption_configuration.kms_key_name}.")

# [END bigquery_create_table_cmek]
37 changes: 37 additions & 0 deletions samples/snippets/create_table_cmek_test.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.

import typing

import create_table_cmek

if typing.TYPE_CHECKING:
import pytest


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

kms_key_name = (
"projects/cloud-samples-tests/locations/us/keyRings/test/cryptoKeys/test"
)

create_table_cmek.create_table_cmek(random_table_id, kms_key_name)

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

0 comments on commit 57740e4

Please sign in to comment.