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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: show common job properties in get_job and cancel_job samples #1137

Merged
merged 2 commits into from
Feb 14, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/snippets.py
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,7 @@ def test_client_query_total_rows(client, capsys):


def test_manage_job(client):
# TODO(b/199162556): delete after migrating docs
sql = """
SELECT corpus
FROM `bigquery-public-data.samples.shakespeare`
Expand Down
26 changes: 26 additions & 0 deletions samples/snippets/manage_job_cancel.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Copyright 2016-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
#
# http://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.

# [START bigquery_cancel_job]
from google.cloud import bigquery


def cancel_job(
client: bigquery.Client, location: str = "us", job_id: str = "abcd-efgh-ijkl-mnop",
):
job = client.cancel_job(job_id, location=location)
print(f"{job.location}:{job.job_id} cancelled")


# [END bigquery_cancel_job]
33 changes: 33 additions & 0 deletions samples/snippets/manage_job_get.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Copyright 2016-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
#
# http://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.

# [START bigquery_get_job]
from google.cloud import bigquery


def get_job(
client: bigquery.Client, location: str = "us", job_id: str = "abcd-efgh-ijkl-mnop",
):
job = client.get_job(job_id, location=location)

# All job classes have "location" and "job_id" string properties.
# Use these properties for job operations such as "cancel_job" and
# "delete_job".
print(f"{job.location}:{job.job_id}")
print(f"Type: {job.job_type}")
print(f"State: {job.state}")
print(f"Created: {job.created.isoformat()}")


# [END bigquery_get_job]
39 changes: 39 additions & 0 deletions samples/snippets/manage_job_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 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
#
# http://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
import pytest

import manage_job_cancel
import manage_job_get


def test_manage_job(capsys: pytest.CaptureFixture):
client = bigquery.Client()
sql = """
SELECT corpus
FROM `bigquery-public-data.samples.shakespeare`
GROUP BY corpus;
"""
location = "us"
job = client.query(sql, location=location)

manage_job_cancel.cancel_job(client, location=location, job_id=job.job_id)
out, _ = capsys.readouterr()
assert f"{job.location}:{job.job_id} cancelled" in out

manage_job_get.get_job(client, location=location, job_id=job.job_id)
out, _ = capsys.readouterr()
assert f"{job.location}:{job.job_id}" in out
assert "Type: query" in out