mirror of
https://github.com/apache/superset.git
synced 2026-04-10 11:55:24 +00:00
100 lines
3.8 KiB
Python
100 lines
3.8 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.
|
|
# isort:skip_file
|
|
|
|
import logging
|
|
from collections.abc import Iterator
|
|
from typing import Callable
|
|
|
|
import yaml
|
|
from werkzeug.utils import secure_filename
|
|
|
|
from superset.commands.export.models import ExportModelsCommand
|
|
from superset.models.sql_lab import SavedQuery
|
|
from superset.commands.query.exceptions import SavedQueryNotFoundError
|
|
from superset.daos.query import SavedQueryDAO
|
|
from superset.utils.dict_import_export import EXPORT_VERSION
|
|
from superset.utils import json
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class ExportSavedQueriesCommand(ExportModelsCommand):
|
|
dao = SavedQueryDAO
|
|
not_found = SavedQueryNotFoundError
|
|
|
|
@staticmethod
|
|
def _file_name(model: SavedQuery) -> str:
|
|
# build filename based on database, optional schema, and label
|
|
# we call secure_filename() multiple times and join the directories afterwards,
|
|
# as secure_filename() replaces "/" with "_".
|
|
database_slug = secure_filename(model.database.database_name)
|
|
query_slug = secure_filename(model.label) or str(model.uuid)
|
|
if model.schema is None:
|
|
file_name = f"queries/{database_slug}/{query_slug}.yaml"
|
|
else:
|
|
schema_slug = secure_filename(model.schema)
|
|
file_name = f"queries/{database_slug}/{schema_slug}/{query_slug}.yaml"
|
|
return file_name
|
|
|
|
@staticmethod
|
|
def _file_content(model: SavedQuery) -> str:
|
|
payload = model.export_to_dict(
|
|
recursive=False,
|
|
include_parent_ref=False,
|
|
include_defaults=True,
|
|
export_uuids=True,
|
|
)
|
|
payload["version"] = EXPORT_VERSION
|
|
payload["database_uuid"] = str(model.database.uuid)
|
|
|
|
file_content = yaml.safe_dump(payload, sort_keys=False)
|
|
return file_content
|
|
|
|
@staticmethod
|
|
def _export(
|
|
model: SavedQuery, export_related: bool = True
|
|
) -> Iterator[tuple[str, Callable[[], str]]]:
|
|
yield (
|
|
ExportSavedQueriesCommand._file_name(model),
|
|
lambda: ExportSavedQueriesCommand._file_content(model),
|
|
)
|
|
|
|
if export_related: # TODO: Maybe we can use database export command here?
|
|
# include database as well
|
|
database_slug = secure_filename(model.database.database_name)
|
|
file_name = f"databases/{database_slug}.yaml"
|
|
|
|
payload = model.database.export_to_dict(
|
|
recursive=False,
|
|
include_parent_ref=False,
|
|
include_defaults=True,
|
|
export_uuids=True,
|
|
)
|
|
# TODO (betodealmeida): move this logic to export_to_dict once this
|
|
# becomes the default export endpoint
|
|
if "extra" in payload:
|
|
try:
|
|
payload["extra"] = json.loads(payload["extra"])
|
|
except json.JSONDecodeError:
|
|
logger.info("Unable to decode `extra` field: %s", payload["extra"])
|
|
|
|
payload["version"] = EXPORT_VERSION
|
|
|
|
file_content = yaml.safe_dump(payload, sort_keys=False)
|
|
yield file_name, lambda: file_content
|