fix: URL-encode full_name in Unity Catalog API path parameters#1393
Open
nanookclaw wants to merge 1 commit intodatabricks:mainfrom
Open
fix: URL-encode full_name in Unity Catalog API path parameters#1393nanookclaw wants to merge 1 commit intodatabricks:mainfrom
nanookclaw wants to merge 1 commit intodatabricks:mainfrom
Conversation
Unity Catalog allows table/schema/model names with special characters (e.g. '%', '#', '?') which must be URL-encoded when used in REST API path segments. Previously, methods like tables.get(), schemas.get(), models.get(), etc. interpolated full_name directly into f-string URLs without encoding, causing NotFound errors for names containing unsafe characters. This change applies the existing _escape_multi_segment_path_parameter() helper (already used in files.py) to all full_name path parameters in catalog.py, consistent with how the code generator handles path params in other service modules. Fixes databricks#1266 Signed-off-by: Nanook Claw <[email protected]> Signed-off-by: Nanook <[email protected]>
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
|
Please ensure that the NEXT_CHANGELOG.md file is updated with any relevant changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
Unity Catalog allows table/schema/model names with special characters (e.g.
%,#,?). When calling methods liketables.get(full_name=db.schema.my_table_#$%), the SDK interpolatesfull_namedirectly into the URL path without encoding, causingNotFounderrors.Repro:
Solution
Applied the existing
_escape_multi_segment_path_parameter()helper (already used infiles.py) to allfull_namepath parameters incatalog.py. This covers:TablesAPI— get, delete, exists, updateSchemasAPI— get, delete, updateRegisteredModelsAPI— get, delete, update, get_by_alias, etc.ModelVersionsAPI— get, delete, updateTableConstraintsAPI— deleteGrantsAPI— get, get_effective, update (with securable_type/full_name)ResourceQuotasAPI— getThe encoding uses
urllib.parse.quote()which safely handles special characters while preserving dots and underscores in normal names likecatalog.schema.table.Fixes #1266
Testing
python3 -m py_compile)CC @ghansen (issue reporter)