Rename SQLQuery to SQLScript

Author: betodealmeida

superset/db_engine_specs/base.py

@@ -59,7 +59,7 @@
 from superset.constants import TimeGrain as TimeGrainConstants
 from superset.databases.utils import make_url_safe
 from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
-from superset.sql_parse import ParsedQuery, SQLQuery, Table
+from superset.sql_parse import ParsedQuery, SQLScript, Table
 from superset.superset_typing import ResultSetColumnType, SQLAColumnType
 from superset.utils import core as utils
 from superset.utils.core import ColumnSpec, GenericDataType
@@ -1448,7 +1448,7 @@ def select_star(  # pylint: disable=too-many-arguments,too-many-locals
                 qry = partition_query
         sql = database.compile_sqla_query(qry)
         if indent:
-            sql = SQLQuery(sql, engine=cls.engine).format()
+            sql = SQLScript(sql, engine=cls.engine).format()
         return sql
 
     @classmethod

superset/db_engine_specs/postgres.py

@@ -36,7 +36,7 @@
 from superset.errors import ErrorLevel, SupersetError, SupersetErrorType
 from superset.exceptions import SupersetException, SupersetSecurityException
 from superset.models.sql_lab import Query
-from superset.sql_parse import SQLQuery
+from superset.sql_parse import SQLScript
 from superset.utils import core as utils
 from superset.utils.core import GenericDataType
 
@@ -281,8 +281,8 @@ def get_default_schema_for_query(
         This method simply uses the parent method after checking that there are no
         malicious path setting in the query.
         """
-        statement = SQLQuery(query.sql, engine=cls.engine)
-        settings = statement.get_settings()
+        script = SQLScript(query.sql, engine=cls.engine)
+        settings = script.get_settings()
         if "search_path" in settings:
             raise SupersetSecurityException(
                 SupersetError(

superset/models/helpers.py

@@ -74,7 +74,7 @@
     insert_rls_in_predicate,
     ParsedQuery,
     sanitize_clause,
-    SQLQuery,
+    SQLScript,
     SQLStatement,
 )
 from superset.superset_typing import (
@@ -1082,13 +1082,13 @@ def get_rendered_sql(
                     )
                 ) from ex
 
-        query = SQLQuery(sql.strip("\t\r\n; "), engine=self.db_engine_spec.engine)
-        if len(query.statements) > 1:
+        script = SQLScript(sql.strip("\t\r\n; "), engine=self.db_engine_spec.engine)
+        if len(script.statements) > 1:
             raise QueryObjectValidationError(
                 _("Virtual dataset query cannot consist of multiple statements")
             )
 
-        sql = query.statements[0].format(comments=False)
+        sql = script.statements[0].format(comments=False)
         if not sql:
             raise QueryObjectValidationError(_("Virtual dataset query cannot be empty"))
         return sql

superset/sql_parse.py

@@ -323,9 +323,9 @@ def is_cte(source: exp.Table, scope: Scope) -> bool:
     return source.name in ctes_in_scope
 
 
-class SQLQuery:
+class SQLScript:
     """
-    A SQL query, with 0+ statements.
+    A SQL script, with 0+ statements.
     """
 
     def __init__(
@@ -351,7 +351,7 @@ def get_settings(self) -> dict[str, str]:
         """
         Return the settings for the SQL query.
 
-            >>> statement = SQLQuery("SET foo = 'bar'; SET foo = 'baz'")
+            >>> statement = SQLScript("SET foo = 'bar'; SET foo = 'baz'")
             >>> statement.get_settings()
             {"foo": "'baz'"}
 

superset/sqllab/api.py

@@ -37,7 +37,7 @@
 from superset.jinja_context import get_template_processor
 from superset.models.sql_lab import Query
 from superset.sql_lab import get_sql_results
-from superset.sql_parse import SQLQuery
+from superset.sql_parse import SQLScript
 from superset.sqllab.command_status import SqlJsonExecutionStatus
 from superset.sqllab.exceptions import (
     QueryIsForbiddenToAccessException,
@@ -230,7 +230,7 @@ def format_sql(self) -> FlaskResponse:
         """
         try:
             model = self.format_model_schema.load(request.json)
-            result = SQLQuery(model["sql"], model.get("engine")).format()
+            result = SQLScript(model["sql"], model.get("engine")).format()
             return self.response(200, result=result)
         except ValidationError as error:
             return self.response_400(message=error.messages)

tests/unit_tests/sql_parse_tests.py

@@ -35,7 +35,7 @@
     insert_rls_in_predicate,
     ParsedQuery,
     sanitize_clause,
-    SQLQuery,
+    SQLScript,
     SQLStatement,
     strip_comments_from_sql,
     Table,
@@ -1855,16 +1855,16 @@ def test_is_select() -> None:
 
 def test_sqlquery() -> None:
     """
-    Test the `SQLQuery` class.
+    Test the `SQLScript` class.
     """
-    query = SQLQuery("SELECT 1; SELECT 2;")
+    script = SQLScript("SELECT 1; SELECT 2;")
 
-    assert len(query.statements) == 2
-    assert query.format() == "SELECT\n  1;\nSELECT\n  2"
-    assert query.statements[0].format() == "SELECT\n  1"
+    assert len(script.statements) == 2
+    assert script.format() == "SELECT\n  1;\nSELECT\n  2"
+    assert script.statements[0].format() == "SELECT\n  1"
 
-    query = SQLQuery("SET a=1; SET a=2; SELECT 3;")
-    assert query.get_settings() == {"a": "2"}
+    script = SQLScript("SET a=1; SET a=2; SELECT 3;")
+    assert script.get_settings() == {"a": "2"}
 
 
 def test_sqlstatement() -> None: