GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — feat: add opt-in metadata catalog name escaping by vuanhphung · Pull Request #985 · databricks/databricks-sql-python

Conversation

@vuanhphung

@vuanhphung vuanhphung commented Oct 15, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

What type of PR is this?

  • Feature

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?

  • Unit tests

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.

All reactions
@vuanhphung
feat: add opt-in metadata catalog name escaping
5229187
Signed-off-by: Vu Anh Phung <[email protected]>
@vuanhphung vuanhphung added the ai-assisted label Oct 15, 2026
@vuanhphung
vuanhphung had a problem deploying to azure-prod October 15, 2026 19:20 — with GitHub Actions Error
@vuanhphung
vuanhphung had a problem deploying to azure-prod October 15, 2026 19:20 — with GitHub Actions Error
@vuanhphung
docs: note metadata catalog escaping configuration in changelog
2463ec8
Signed-off-by: Vu Anh Phung <[email protected]>
@vuanhphung
vuanhphung temporarily deployed to azure-prod October 15, 2026 19:22 — with GitHub Actions Inactive
@vuanhphung
vuanhphung temporarily deployed to azure-prod October 15, 2026 19:22 — with GitHub Actions Inactive
@vuanhphung
vuanhphung had a problem deploying to azure-prod October 15, 2026 19:23 — with GitHub Actions Error
peco-review-bot[bot]
peco-review-bot Bot approved these changes Oct 15, 2026
View reviewed changes

@peco-review-bot peco-review-bot Bot left a comment

Copy link
Copy Markdown

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.

All reactions
Comment thread src/databricks/sql/utils.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@peco-review-bot
peco-review-bot Bot temporarily deployed to azure-prod October 15, 2026 19:27 Inactive
@vuanhphung
test: document JDBC-compatible metadata backslash escaping
7879089
Signed-off-by: Vu Anh Phung <[email protected]>
@vuanhphung
vuanhphung temporarily deployed to azure-prod October 15, 2026 19:39 — with GitHub Actions Inactive
@vuanhphung
vuanhphung temporarily deployed to azure-prod October 15, 2026 19:39 — with GitHub Actions Inactive
@vuanhphung
vuanhphung temporarily deployed to azure-prod October 15, 2026 19:39 — with GitHub Actions Inactive
peco-review-bot[bot]
peco-review-bot Bot approved these changes Oct 15, 2026
View reviewed changes

@peco-review-bot peco-review-bot Bot left a comment

Copy link
Copy Markdown

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.

All reactions
Comment thread src/databricks/sql/utils.py Resolved

Uh oh!

There was an error while loading. Please reload this page.

@peco-review-bot
peco-review-bot Bot temporarily deployed to azure-prod October 15, 2026 19:44 Inactive
@vuanhphung
vuanhphung requested a review from rahuls-db October 15, 2026 20:11
rahuls-db
rahuls-db approved these changes Oct 15, 2026
View reviewed changes
@vuanhphung
vuanhphung enabled auto-merge October 15, 2026 22:28
@vuanhphung
vuanhphung added this pull request to the merge queue Oct 15, 2026
Merged via the queue into main with commit b1978d4 Oct 15, 2026
52 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@vuanhphung
vuanhphung deleted the vu-phung/escape-metadata-catalog-names branch October 15, 2026 23:25
@vuanhphung vuanhphung mentioned this pull request Nov 12, 2026
Escape _ in metadata catalog_name by default (behavior change) #1029
Open
5 tasks done

This branch was previously deployed

1 inactive deployment
azure-prod — 78790895 Deployed Oct 15, 2026 by peco-review-bot[bot] via followup #989
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rahuls-db rahuls-db rahuls-db approved these changes
@peco-review-bot peco-review-bot[bot] peco-review-bot[bot] approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

ai-assisted

Projects

None yet

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.

2 participants

@vuanhphung @rahuls-db
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.