mirror of
https://github.com/apache/superset.git
synced 2026-06-03 06:39:25 +00:00
94 lines
3.5 KiB
Python
94 lines
3.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.
|
|
import logging
|
|
from typing import Any, Dict, Optional
|
|
|
|
from flask_appbuilder.security.sqla.models import User
|
|
|
|
from superset import db, security_manager
|
|
from superset.commands.base import BaseCommand
|
|
from superset.common.chart_data import ChartDataResultType
|
|
from superset.common.query_context_factory import QueryContextFactory
|
|
from superset.common.utils.query_cache_manager import QueryCacheManager
|
|
from superset.constants import CacheRegion
|
|
from superset.dao.exceptions import DatasourceNotFound
|
|
from superset.datasource.dao import Datasource, DatasourceDAO
|
|
from superset.exceptions import SupersetSecurityException
|
|
from superset.explore.exceptions import (
|
|
DatasourceForbiddenError,
|
|
DatasourceSamplesFailedError,
|
|
)
|
|
from superset.utils.core import DatasourceType, QueryStatus
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class SamplesDatasourceCommand(BaseCommand):
|
|
def __init__(
|
|
self,
|
|
user: User,
|
|
datasource_id: Optional[int],
|
|
datasource_type: Optional[str],
|
|
force: bool,
|
|
):
|
|
self._actor = user
|
|
self._datasource_id = datasource_id
|
|
self._datasource_type = datasource_type
|
|
self._force = force
|
|
self._model: Optional[Datasource] = None
|
|
|
|
def run(self) -> Dict[str, Any]:
|
|
self.validate()
|
|
if not self._model:
|
|
raise DatasourceNotFound()
|
|
|
|
qc_instance = QueryContextFactory().create(
|
|
datasource={
|
|
"type": self._model.type,
|
|
"id": self._model.id,
|
|
},
|
|
queries=[{}],
|
|
result_type=ChartDataResultType.SAMPLES,
|
|
force=self._force,
|
|
)
|
|
results = qc_instance.get_payload()
|
|
try:
|
|
sample_data = results["queries"][0]
|
|
error_msg = sample_data.get("error")
|
|
if sample_data.get("status") == QueryStatus.FAILED and error_msg:
|
|
cache_key = sample_data.get("cache_key")
|
|
QueryCacheManager.delete(cache_key, region=CacheRegion.DATA)
|
|
raise DatasourceSamplesFailedError(error_msg)
|
|
return sample_data
|
|
except (IndexError, KeyError) as exc:
|
|
raise DatasourceSamplesFailedError from exc
|
|
|
|
def validate(self) -> None:
|
|
# Validate/populate model exists
|
|
if self._datasource_type and self._datasource_id:
|
|
self._model = DatasourceDAO.get_datasource(
|
|
session=db.session,
|
|
datasource_type=DatasourceType(self._datasource_type),
|
|
datasource_id=self._datasource_id,
|
|
)
|
|
|
|
# Check ownership
|
|
try:
|
|
security_manager.raise_for_ownership(self._model)
|
|
except SupersetSecurityException as ex:
|
|
raise DatasourceForbiddenError() from ex
|