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

Jump to bottom

fix(Databricks): Escape catalog and schema names in pre-queries #31199

Merged
merged 1 commit into from
Dec 2, 2024
+20 −4
Merged

fix(Databricks): Escape catalog and schema names in pre-queries #31199

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
2 changes: 2 additions & 0 deletions superset/db_engine_specs/databricks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,10 @@ def get_prequeries(
) -> list[str]:
prequeries = []
if catalog:
catalog = f"`{catalog}`" if not catalog.startswith("`") else catalog
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't use database.quote_identifier(), because the Database is no longer passed as an argument in >=4.1.0: https://github.com/apache/superset/blob/4.1.0/superset/db_engine_specs/base.py#L1412-L1431

Since this method is specifically for Databricks, I thought it was OK to hardcode the quote identifiers.

prequeries.append(f"USE CATALOG {catalog}")
if schema:
schema = f"`{schema}`" if not schema.startswith("`") else schema
prequeries.append(f"USE SCHEMA {schema}")
return prequeries

Expand Down
22 changes: 18 additions & 4 deletions tests/unit_tests/db_engine_specs/test_databricks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,14 +257,28 @@ def test_get_prequeries(mocker: MockerFixture) -> None:

assert DatabricksNativeEngineSpec.get_prequeries(database) == []
assert DatabricksNativeEngineSpec.get_prequeries(database, schema="test") == [
"USE SCHEMA test",
"USE SCHEMA `test`",
]
assert DatabricksNativeEngineSpec.get_prequeries(database, catalog="test") == [
"USE CATALOG test",
"USE CATALOG `test`",
]
assert DatabricksNativeEngineSpec.get_prequeries(
database, catalog="foo", schema="bar"
) == [
"USE CATALOG foo",
"USE SCHEMA bar",
"USE CATALOG `foo`",
"USE SCHEMA `bar`",
]

assert DatabricksNativeEngineSpec.get_prequeries(
database, catalog="with-hyphen", schema="hyphen-again"
) == [
"USE CATALOG `with-hyphen`",
"USE SCHEMA `hyphen-again`",
]

assert DatabricksNativeEngineSpec.get_prequeries(
database, catalog="`escaped-hyphen`", schema="`hyphen-escaped`"
) == [
"USE CATALOG `escaped-hyphen`",
"USE SCHEMA `hyphen-escaped`",
]
Loading