-
Notifications
You must be signed in to change notification settings - Fork 16.6k
feat(examples): Transpile virtual dataset SQL on import #37311
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
119b45f
feat(examples): Transpile virtual dataset SQL on import
rusackas 0cd1b48
fix: Add source_engine parameter for proper SQL transpilation
rusackas db976c2
Update superset/commands/importers/v1/examples.py
rusackas eae1da1
Update tests/unit_tests/sql/transpile_to_dialect_test.py
rusackas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
244 changes: 244 additions & 0 deletions
244
tests/unit_tests/commands/importers/v1/examples_test.py
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,244 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
| """Tests for the examples importer, specifically SQL transpilation.""" | ||
|
|
||
| from unittest.mock import MagicMock, patch | ||
|
|
||
| from superset.commands.importers.v1.examples import transpile_virtual_dataset_sql | ||
|
|
||
|
|
||
| def test_transpile_virtual_dataset_sql_no_sql(): | ||
| """Test that configs without SQL are unchanged.""" | ||
| config = {"table_name": "my_table", "sql": None} | ||
| transpile_virtual_dataset_sql(config, 1) | ||
| assert config["sql"] is None | ||
|
|
||
|
|
||
| def test_transpile_virtual_dataset_sql_empty_sql(): | ||
| """Test that configs with empty SQL are unchanged.""" | ||
| config = {"table_name": "my_table", "sql": ""} | ||
| transpile_virtual_dataset_sql(config, 1) | ||
| assert config["sql"] == "" | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| def test_transpile_virtual_dataset_sql_database_not_found(mock_db): | ||
| """Test graceful handling when database is not found.""" | ||
| mock_db.session.query.return_value.get.return_value = None | ||
|
|
||
| config = {"table_name": "my_table", "sql": "SELECT * FROM foo"} | ||
| original_sql = config["sql"] | ||
|
|
||
| transpile_virtual_dataset_sql(config, 999) | ||
|
|
||
| # SQL should remain unchanged | ||
| assert config["sql"] == original_sql | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_success(mock_transpile, mock_db): | ||
| """Test successful SQL transpilation with source engine.""" | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "mysql" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| mock_transpile.return_value = "SELECT * FROM `foo`" | ||
|
|
||
| config = { | ||
| "table_name": "my_table", | ||
| "sql": "SELECT * FROM foo", | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == "SELECT * FROM `foo`" | ||
| mock_transpile.assert_called_once_with("SELECT * FROM foo", "mysql", "postgresql") | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_no_source_engine(mock_transpile, mock_db): | ||
| """Test transpilation when source_db_engine is not specified (legacy).""" | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "mysql" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| mock_transpile.return_value = "SELECT * FROM `foo`" | ||
|
|
||
| # No source_db_engine - should default to None (generic dialect) | ||
| config = {"table_name": "my_table", "sql": "SELECT * FROM foo"} | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == "SELECT * FROM `foo`" | ||
| mock_transpile.assert_called_once_with("SELECT * FROM foo", "mysql", None) | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_no_change(mock_transpile, mock_db): | ||
| """Test when transpilation returns same SQL (no dialect differences).""" | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "postgresql" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| original_sql = "SELECT * FROM foo" | ||
| mock_transpile.return_value = original_sql | ||
|
|
||
| config = { | ||
| "table_name": "my_table", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == original_sql | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_error_fallback(mock_transpile, mock_db): | ||
| """Test graceful fallback when transpilation fails.""" | ||
| from superset.exceptions import QueryClauseValidationException | ||
|
|
||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "mysql" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| mock_transpile.side_effect = QueryClauseValidationException("Parse error") | ||
|
|
||
| original_sql = "SELECT SOME_POSTGRES_SPECIFIC_FUNCTION() FROM foo" | ||
| config = { | ||
| "table_name": "my_table", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
|
|
||
| # Should not raise, should keep original SQL | ||
| transpile_virtual_dataset_sql(config, 1) | ||
| assert config["sql"] == original_sql | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_postgres_to_duckdb(mock_transpile, mock_db): | ||
| """Test transpilation from PostgreSQL to DuckDB.""" | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "duckdb" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| original_sql = """ | ||
| SELECT DATE_TRUNC('month', created_at) AS month, COUNT(*) AS cnt | ||
| FROM orders WHERE status = 'completed' GROUP BY 1 | ||
| """ | ||
| transpiled_sql = """ | ||
| SELECT DATE_TRUNC('month', created_at) AS month, COUNT(*) AS cnt | ||
| FROM orders WHERE status = 'completed' GROUP BY 1 | ||
| """ | ||
| mock_transpile.return_value = transpiled_sql | ||
|
|
||
| config = { | ||
| "table_name": "monthly_orders", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == transpiled_sql | ||
| mock_transpile.assert_called_once_with(original_sql, "duckdb", "postgresql") | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_postgres_to_clickhouse(mock_transpile, mock_db): | ||
| """Test transpilation from PostgreSQL to ClickHouse. | ||
|
|
||
| ClickHouse has different syntax for date functions, so this tests | ||
| real dialect differences. | ||
| """ | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "clickhouse" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| # PostgreSQL syntax | ||
| original_sql = "SELECT DATE_TRUNC('month', created_at) AS month FROM orders" | ||
| # ClickHouse uses toStartOfMonth instead | ||
| transpiled_sql = "SELECT toStartOfMonth(created_at) AS month FROM orders" | ||
| mock_transpile.return_value = transpiled_sql | ||
|
|
||
| config = { | ||
| "table_name": "monthly_orders", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == transpiled_sql | ||
| mock_transpile.assert_called_once_with(original_sql, "clickhouse", "postgresql") | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_postgres_to_mysql(mock_transpile, mock_db): | ||
| """Test transpilation from PostgreSQL to MySQL. | ||
|
|
||
| MySQL uses backticks for identifiers and has different casting syntax. | ||
| """ | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "mysql" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| # PostgreSQL syntax with :: casting | ||
| original_sql = "SELECT created_at::DATE AS date_only FROM orders" | ||
| # MySQL syntax with CAST | ||
| transpiled_sql = "SELECT CAST(created_at AS DATE) AS date_only FROM `orders`" | ||
| mock_transpile.return_value = transpiled_sql | ||
|
|
||
| config = { | ||
| "table_name": "orders_dates", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == transpiled_sql | ||
| mock_transpile.assert_called_once_with(original_sql, "mysql", "postgresql") | ||
|
|
||
|
|
||
| @patch("superset.commands.importers.v1.examples.db") | ||
| @patch("superset.commands.importers.v1.examples.transpile_to_dialect") | ||
| def test_transpile_virtual_dataset_sql_postgres_to_sqlite(mock_transpile, mock_db): | ||
| """Test transpilation from PostgreSQL to SQLite.""" | ||
| mock_database = MagicMock() | ||
| mock_database.db_engine_spec.engine = "sqlite" | ||
| mock_db.session.query.return_value.get.return_value = mock_database | ||
|
|
||
| original_sql = "SELECT * FROM orders WHERE created_at > NOW() - INTERVAL '7 days'" | ||
| transpiled_sql = ( | ||
| "SELECT * FROM orders WHERE created_at > DATETIME('now', '-7 days')" | ||
| ) | ||
| mock_transpile.return_value = transpiled_sql | ||
|
|
||
| config = { | ||
| "table_name": "recent_orders", | ||
| "sql": original_sql, | ||
| "source_db_engine": "postgresql", | ||
| } | ||
| transpile_virtual_dataset_sql(config, 1) | ||
|
|
||
| assert config["sql"] == transpiled_sql | ||
| mock_transpile.assert_called_once_with(original_sql, "sqlite", "postgresql") |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.