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.

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

Add BQ labels to all BQJobConfigs #795

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add BQ labels to all BQJobConfigs #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 14 additions & 4 deletions dbt-bigquery/src/dbt/adapters/bigquery/connections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,12 @@ def get_labels_from_query_comment(cls):

return {}

def get_job_labels(self):
labels = self.get_labels_from_query_comment()
labels["dbt_invocation_id"] = get_invocation_id()

return labels

def generate_job_id(self) -> str:
# Generating a fresh job_id for every _query_and_results call to avoid job_id reuse.
# Generating a job id instead of persisting a BigQuery-generated one after client.query is called.
Expand All @@ -244,9 +250,7 @@ def raw_execute(

fire_event(SQLQuery(conn_name=conn.name, sql=sql, node_info=get_node_info()))

labels = self.get_labels_from_query_comment()

labels["dbt_invocation_id"] = get_invocation_id()
labels = self.get_job_labels()

job_params = {
"use_legacy_sql": use_legacy_sql,
Expand Down Expand Up @@ -424,6 +428,7 @@ def copy_bq_table(self, source, destination, write_disposition) -> None:
destination_ref = self.table_ref(
destination.database, destination.schema, destination.table
)
labels = self.get_job_labels()

logger.debug(
'Copying table(s) "{}" to "{}" with disposition: "{}"',
Expand All @@ -440,7 +445,7 @@ def copy_bq_table(self, source, destination, write_disposition) -> None:
copy_job = client.copy_table(
source_ref_array,
destination_ref,
job_config=CopyJobConfig(write_disposition=write_disposition),
job_config=CopyJobConfig(write_disposition=write_disposition, labels=labels),
retry=self._retry.create_reopen_with_deadline(conn),
)
copy_job.result(timeout=self._retry.create_job_execution_timeout(fallback=300))
Expand All @@ -456,10 +461,12 @@ def write_dataframe_to_table(
field_delimiter: str,
fallback_timeout: Optional[float] = None,
) -> None:
labels = self.get_job_labels()
load_config = LoadJobConfig(
skip_leading_rows=1,
schema=table_schema,
field_delimiter=field_delimiter,
labels=labels,
)
table = self.table_ref(database, schema, identifier)
self._write_file_to_table(client, file_path, table, load_config, fallback_timeout)
Expand All @@ -477,6 +484,9 @@ def write_file_to_table(
config = kwargs["kwargs"]
if "schema" in config:
config["schema"] = json.load(config["schema"])
if "labels" not in config:
config["labels"] = self.get_job_labels()

load_config = LoadJobConfig(**config)
table = self.table_ref(database, schema, identifier)
self._write_file_to_table(client, file_path, table, load_config, fallback_timeout)
Expand Down
16 changes: 14 additions & 2 deletions dbt-bigquery/tests/unit/test_bigquery_connection_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,24 @@ def test_copy_bq_table_truncates(self):
kwargs["job_config"].write_disposition, dbt.adapters.bigquery.impl.WRITE_TRUNCATE
)

def test_job_labels_valid_json(self):
@patch("dbt.adapters.bigquery.connections.get_invocation_id", new=Mock(return_value="uuid4"))
@patch.object(BigQueryConnectionManager, "get_labels_from_query_comment")
def test_get_job_labels(self, mock_get_query_comment_labels):
query_labels = {"key": "value"}
expected = {**query_labels, "dbt_invocation_id": "uuid4"}
mock_get_query_comment_labels.return_value = self.connections._labels_from_query_comment(
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mocking get_labels_from_query_comment to keep the test simple and unit test only get_job_labels, in another case have to create many obj for fully operational BigQueryConnectionManager instance. (https://github.com/dbt-labs/dbt-adapters/blob/main/dbt-bigquery/src/dbt/adapters/bigquery/connections.py#L213)

json.dumps(query_labels)
)

labels = self.connections.get_job_labels()
self.assertEqual(labels, expected)

def test_job_labels_from_query_comment_valid_json(self):
expected = {"key": "value"}
labels = self.connections._labels_from_query_comment(json.dumps(expected))
self.assertEqual(labels, expected)

def test_job_labels_invalid_json(self):
def test_job_labels_from_query_comment_invalid_json(self):
labels = self.connections._labels_from_query_comment("not json")
self.assertEqual(labels, {"query_comment": "not_json"})

Expand Down