Skip to content

allow setting a job config on BigQuery queries #1552

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.

Sign up for GitHub

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
shaunagm merged 2 commits into from
Aug 28, 2025
Merged

allow setting a job config on BigQuery queries #1552

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a2774f
allow setting a job config on BigQuery queries
austinweisgrau Aug 12, 2025
4f2ac49
Merge branch 'main' into bq_config
austinweisgrau Aug 12, 2025
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
23 changes: 19 additions & 4 deletions parsons/google/google_bigquery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from google.api_core import exceptions
from google.cloud import bigquery
from google.cloud.bigquery import dbapi, job
from google.cloud.bigquery.job import ExtractJobConfig, LoadJobConfig
from google.cloud.bigquery.job import ExtractJobConfig, LoadJobConfig, QueryJobConfig
from google.oauth2.credentials import Credentials

from parsons.databases.database_connector import DatabaseConnector
Expand Down Expand Up @@ -249,6 +249,7 @@ def query(
sql: str,
parameters: Optional[Union[list, dict]] = None,
return_values: bool = True,
job_config: Optional[QueryJobConfig] = None,
) -> Optional[Table]:
"""
Run a BigQuery query and return the results as a Parsons table.
Expand Down Expand Up @@ -277,6 +278,8 @@ def query(
A valid BigTable statement
parameters: dict
A dictionary of query parameters for BigQuery.
job_config: QueryJobConfig or None
An optional QueryJobConfig object for custom behavior. See https://cloud.google.com/python/docs/reference/bigquery/latest#google.cloud.bigquery.job.QueryJobConfig

`Returns:`
Parsons Table
Expand All @@ -285,11 +288,21 @@ def query(

with self.connection() as connection:
return self.query_with_connection(
sql, connection, parameters=parameters, return_values=return_values
sql,
connection,
parameters=parameters,
return_values=return_values,
job_config=job_config,
)

def query_with_connection(
self, sql, connection, parameters=None, commit=True, return_values: bool = True
self,
sql,
connection,
parameters=None,
commit=True,
return_values: bool = True,
job_config: Optional[QueryJobConfig] = None,
):
"""
Execute a query against the BigQuery database, with an existing connection.
Expand All @@ -305,6 +318,8 @@ def query_with_connection(
A list of python variables to be converted into SQL values in your query
commit: boolean
Must be true. BigQuery
job_config: QueryJobConfig or None
An optional QueryJobConfig object for custom behavior. See https://cloud.google.com/python/docs/reference/bigquery/latest#google.cloud.bigquery.job.QueryJobConfig

`Returns:`
Parsons Table
Expand All @@ -325,7 +340,7 @@ def query_with_connection(
# get our connection and cursor
with self.cursor(connection) as cursor:
# Run the query
cursor.execute(sql, parameters)
cursor.execute(sql, parameters, job_config=job_config)

if not return_values:
return None
Expand Down
Loading