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(samples): add table snapshot sample #1274

Merged
merged 3 commits into from
Jun 17, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
15 changes: 14 additions & 1 deletion samples/snippets/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
import pytest
import test_utils.prefixer


prefixer = test_utils.prefixer.Prefixer("python-bigquery", "samples/snippets")


Expand Down Expand Up @@ -52,6 +51,20 @@ def dataset_id(bigquery_client: bigquery.Client, project_id: str) -> Iterator[st
bigquery_client.delete_dataset(dataset, delete_contents=True, not_found_ok=True)


@pytest.fixture
def table_id(
bigquery_client: bigquery.Client, project_id: str, dataset_id: str
) -> Iterator[str]:
table_id = prefixer.create_prefix()
full_table_id = f"{project_id}.{dataset_id}.{table_id}"
table = bigquery.Table(
full_table_id, schema=[bigquery.SchemaField("string_col", "STRING")]
)
bigquery_client.create_table(table)
yield full_table_id
bigquery_client.delete_table(table, not_found_ok=True)


@pytest.fixture(scope="session")
def entity_id(bigquery_client: bigquery.Client, dataset_id: str) -> str:
return "cloud-developer-relations@google.com"
Expand Down
43 changes: 43 additions & 0 deletions samples/snippets/create_table_snapshot.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.


def create_table_snapshot(source_table_id: str, snapshot_table_id: str) -> None:
original_source_table_id = source_table_id
original_snapshot_table_id = snapshot_table_id
# [START bigquery_create_table_snapshot]
from google.cloud import bigquery

# TODO(developer): Set table_id to the ID of the table to create.
source_table_id = "your-project.your_dataset.your_table_name"
snapshot_table_id = "your-project.your_dataset.snapshot_table_name"
# [END bigquery_create_table_snapshot]
source_table_id = original_source_table_id
snapshot_table_id = original_snapshot_table_id
# [START bigquery_create_table_snapshot]

# Construct a BigQuery client object.
client = bigquery.Client()
copy_config = bigquery.CopyJobConfig()
copy_config.operation_type = bigquery.OperationType.SNAPSHOT

copy_job = client.copy_table(
sources=source_table_id,
destination=snapshot_table_id,
job_config=copy_config,
)
copy_job.result()

print("Created table snapshot {}".format(snapshot_table_id))
# [END bigquery_create_table_snapshot]
33 changes: 33 additions & 0 deletions samples/snippets/create_table_snapshot_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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_snapshot

if typing.TYPE_CHECKING:
import pytest


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

create_table_snapshot.create_table_snapshot(table_id, random_table_id)

out, _ = capsys.readouterr()

assert "Created table snapshot {}".format(random_table_id) in out