Skip to content

docs: add short mode query sample & test #1978

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

Merged
merged 5 commits into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
docs: add short mode query sample & test
  • Loading branch information
shollyman committed Jul 17, 2024
commit 6b2618cd9c048071d1fe89340397d2bdf536986c
52 changes: 52 additions & 0 deletions samples/client_query_shortmode.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Copyright 2024 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 client_query_shortmode() -> None:
# [START bigquery_query_shortquery]
# This example demonstrates issuing a query that may be run in short query mode.
#
# To enable the short query mode preview feature, the QUERY_PREVIEW_ENABLED
# environmental variable should be set to `TRUE`.
from google.cloud import bigquery

# Construct a BigQuery client object.
client = bigquery.Client()

query = """
SELECT
name,
gender,
SUM(number) AS total
FROM
bigquery-public-data.usa_names.usa_1910_2013
GROUP BY
name, gender
ORDER BY
total DESC
LIMIT 10
"""
# Run the query and process the returned row iterator.
rows = client.query_and_wait(query)

if rows.job_id is not None:
print("Query was run with job state. Job ID: {}".format(rows.job_id))
else:
print("Query was run in short mode. Query ID: {}".format(rows.query_id))

print("The query data:")
for row in rows:
# Row values can be accessed by field name or index.
print("name={}, gender={}, total={}".format(row[0], row[1], row["total"]))
# [END bigquery_query_shortquery]
26 changes: 26 additions & 0 deletions samples/tests/test_client_query_shortmode.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Copyright 2024 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

from .. import client_query_shortmode

if typing.TYPE_CHECKING:
import pytest


def test_client_query_batch(capsys: "pytest.CaptureFixture[str]") -> None:
job = client_query_shortmode.client_query_shortmode()
out, err = capsys.readouterr()
assert "Query was run" in out