mirror of
https://github.com/apache/superset.git
synced 2026-04-12 04:37:49 +00:00
85 lines
2.5 KiB
Python
85 lines
2.5 KiB
Python
# 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.
|
|
|
|
from marshmallow import fields, Schema
|
|
|
|
from superset.dashboards.schemas import UserSchema
|
|
from superset.models.sql_lab import Query
|
|
from superset.sql.parse import Table
|
|
|
|
openapi_spec_methods_override = {
|
|
"get": {"get": {"summary": "Get query detail information"}},
|
|
"get_list": {
|
|
"get": {
|
|
"summary": "Get a list of queries",
|
|
"description": "Gets a list of queries, use Rison or JSON query "
|
|
"parameters for filtering, sorting, pagination and "
|
|
" for selecting specific columns and metadata.",
|
|
}
|
|
},
|
|
}
|
|
|
|
queries_get_updated_since_schema = {
|
|
"type": "object",
|
|
"properties": {
|
|
"last_updated_ms": {"type": "number"},
|
|
},
|
|
"required": ["last_updated_ms"],
|
|
}
|
|
|
|
|
|
class DatabaseSchema(Schema):
|
|
database_name = fields.String()
|
|
|
|
|
|
class QuerySchema(Schema):
|
|
"""
|
|
Schema for the ``Query`` model.
|
|
"""
|
|
|
|
changed_on = fields.DateTime()
|
|
database = fields.Nested(DatabaseSchema)
|
|
end_time = fields.Float(attribute="end_time")
|
|
executed_sql = fields.String()
|
|
id = fields.Int()
|
|
rows = fields.Int()
|
|
schema = fields.String()
|
|
sql = fields.String()
|
|
sql_tables = fields.Method("get_sql_tables")
|
|
start_time = fields.Float(attribute="start_time")
|
|
status = fields.String()
|
|
tab_name = fields.String()
|
|
tmp_table_name = fields.String()
|
|
tracking_url = fields.String()
|
|
user = fields.Nested(UserSchema(exclude=["username"]))
|
|
|
|
class Meta: # pylint: disable=too-few-public-methods
|
|
model = Query
|
|
load_instance = True
|
|
include_relationships = True
|
|
|
|
def get_sql_tables(self, obj: Query) -> list[Table]:
|
|
return obj.sql_tables
|
|
|
|
|
|
class StopQuerySchema(Schema):
|
|
"""
|
|
Schema for the stop_query API call.
|
|
"""
|
|
|
|
client_id = fields.String()
|