michael-s-molina commented on code in PR #36529: URL: https://github.com/apache/superset/pull/36529#discussion_r2619389432
########## superset-core/src/superset_core/api/types.py: ########## @@ -0,0 +1,164 @@ +# 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. + +""" +Query execution types for superset-core. + +Provides type definitions for query execution that are partially aligned +with frontend types in superset-ui-core/src/query/types/. +""" + +from __future__ import annotations + +from dataclasses import dataclass, field +from datetime import datetime +from enum import Enum +from typing import Any, TYPE_CHECKING + +if TYPE_CHECKING: + import pandas as pd + + +class QueryStatus(Enum): + """ + Status of query execution. + + Aligned with frontend QueryState values but using Python conventions. + """ + + PENDING = "pending" + RUNNING = "running" + SUCCESS = "success" + FAILED = "failed" + TIMED_OUT = "timed_out" + STOPPED = "stopped" + + +@dataclass +class CacheOptions: + """ + Options for query result caching. + """ + + timeout: int | None = None # Override default cache timeout (seconds) + force_refresh: bool = False # Bypass cache and re-execute query + + +@dataclass +class QueryOptions: + """ + Options for query execution via Database.execute() and execute_async(). + + Supports customization of: + - Basic: catalog, schema, limit, timeout + - Templates: Jinja2 template parameters + - Caching: Cache timeout and refresh control + - Dry run: Return transformed SQL without execution + """ + + # Basic options + catalog: str | None = None + schema: str | None = None + limit: int | None = None + timeout_seconds: int | None = None + + # Template options + template_params: dict[str, Any] | None = None # For Jinja2 rendering + + # Caching options + cache: CacheOptions | None = None + + # Dry run option + dry_run: bool = False # Return transformed SQL without executing + + +@dataclass +class QueryResult: + """ + Result of a query execution. + + Aligned with frontend ChartDataResponseResult structure. + For column information, use df.columns and df.dtypes on the data DataFrame. + + Fields: + status: Query execution status + data: Result DataFrame (None if dry_run=True or error) + row_count: Number of rows in result Review Comment: @villebro Commit [b9a8d76](https://github.com/apache/superset/pull/36529/commits/b9a8d76850d37204995d5f947acf4bd1fc36d700) returns `statements: list[StatementResult]` where each entry contains the SQL, result data (`DataFrame` for SELECT, `None` for DML), row count, and execution time. The query-level fields track overall status and total execution time. With fail-fast behavior, execution stops on the first error, so all statements in the list are successful and errors are tracked at the query level with statement context. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
