Skip to content

Fix DatabricksSqlHook deprecation warning on every connection - #72289

Closed
sohailiqrar wants to merge 1 commit into
apache:mainfrom
sohailiqrar:fix/databricks-sql-user-agent-entry
Closed

sohailiqrar wants to merge 1 commit into
apache:mainfrom
sohailiqrar:fix/databricks-sql-user-agent-entry

Conversation

@sohailiqrar

@sohailiqrar sohailiqrar commented Aug 30, 2026 •

Copy link
Copy Markdown

databricks-sql-connector deprecated the _user_agent_entry keyword argument in favour of user_agent_entry (no leading underscore). Passing the old name logs a warning on every call to get_conn(), which fires for every DatabricksSqlOperator / sensor execution. Switch to the current parameter name so the warning is no longer emitted.


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

databricks-sql-connector deprecated the ``_user_agent_entry`` keyword
argument in favour of ``user_agent_entry`` (no leading underscore).
Passing the old name logs a warning on every call to get_conn(), which
fires for every DatabricksSqlOperator / sensor execution. Switch to the
current parameter name so the warning is no longer emitted.
@boring-cyborg

boring-cyborg Bot commented Aug 30, 2026

Copy link
Copy Markdown

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example Dag that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@sohailiqrar

Copy link
Copy Markdown
Author

DatabricksSqlHook.get_conn() was passing _user_agent_entry (with a leading underscore) to sql.connect(). The databricks-sql-connector deprecated that alias and logs a [WARN] Parameter '_user_agent_entry' is deprecated warning on every connection open, which means every DatabricksSqlOperator / sensor execution produces noisy log spam.

Switch to the current parameter name user_agent_entry. No behavior change: user_agent_entry has been supported by databricks-sql-connector since well before the provider's >=4.4.0 lower bound.

closes: #72102

@potiuk

potiuk commented Sep 20, 2026

Copy link
Copy Markdown
Member

Thanks for this, and sorry it ends here — closing as superseded by #72103, through no fault of yours.

The same one-line change landed on main on 2026-09-09 as #72103 (e90b59dc3e, "Use non-deprecated user_agent_entry param in DatabricksSqlHook"), and providers/databricks/src/airflow/providers/databricks/hooks/databricks_sql.py:244 already reads "user_agent_entry": self.user_agent_value. Because both sides made the identical edit, git still reports this PR as mergeable — which hides the fact that the hook hunk would contribute nothing.

Two notes for next time, both small:

  • The changelog edit would need dropping regardless: it sits under 7.19.0, which is already released (the unreleased section on main is 7.20.0), and it cites the issue number rather than the PR. Per providers/AGENTS.md, provider changelogs are regenerated by the release manager from git log, so routine bug fixes should not touch changelog.rst at all.
  • Rebasing on main before pushing an update is the quickest way to catch a race like this one.

One part of your PR is still genuinely missing from main: #72103 shipped without a test, and there is no test asserting that sql.connect receives user_agent_entry and not _user_agent_entry. If you would like to open a small follow-up with just test_get_conn_passes_user_agent_entry_without_underscore (no hook change, no changelog edit), that would be a welcome contribution and I am happy to review it.


This message was drafted by an AI-assisted tool and
confirmed by an Apache Airflow maintainer. If you think
something here is mistaken, please reply on the PR and a
maintainer will weigh in.

More on how Apache Airflow handles maintainer review:
contributing-docs/05_pull_requests.rst.

@potiuk potiuk closed this Sep 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants