GeezerVison is showing github.com — feat: add opt-in metadata catalog name escaping by vuanhphung · Pull Request #985 · databricks/databricks-sql-python
Conversation
vuanhphung
commented
Oct 15, 2026
•
edited
Loading
Uh oh!
There was an error while loading. Please reload this page.
What type of PR is this?
Description
Catalog names containing _ can trigger unintended metadata pattern matching and extra catalog lookups. Add the opt-in escape_catalog_name connection parameter, defaulting to False, to escape unescaped underscores while preserving existing escapes and % wildcards.
This applies to schemas, tables, and columns on Thrift and tables on kernel. Kernel schemas and columns already use exact catalog identifiers.
How is this tested?
628 tests passed, 3 skipped, including 198 metadata regression cases across both backends. Explicit cases document JDBC compatibility for even/odd backslash runs. Kernel calls are mocked. Black formatting and git diff --check passed.
Related Tickets & Documents
N/A
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Verdict: 1 Low
Looks good — a clean, well-tested opt-in feature. End-to-end wiring (connect → session → both backends) is correct, the Thrift/Kernel asymmetry (escaping on schemas/tables/columns vs. tables only) matches the documented behavior and the _catalog_or_none normalization, and the parametrized unit tests cover both backends thoroughly. One minor low-severity edge case noted in the escaping regex.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Verdict: 1 Low
Looks good — clean, opt-in, default-off feature that's well wired (Thrift via **kwargs, kernel explicitly in session.py) and thoroughly parametrized in tests. One low note: the escape regex only checks a single preceding backslash, so the "Match JDBC … regardless of backslash parity" comment doesn't actually match JDBC/LIKE semantics for even-length backslash runs (harmless in practice since catalog names lack backslashes). Also worth being aware: the parameter is a silent no-op on the SEA backend and on kernel schemas()/columns() by design — this matches the documented scope, so no change needed, just flagging for intent.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
This branch was previously deployed
1 inactive
deployment
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
|