mirror of
https://github.com/apache/superset.git
synced 2026-04-20 08:34:37 +00:00
refactor: database API OpenAPI spec and location (#10303)
* refactor: database API OpenAPI spec and location * fix isort and license * fix description
This commit is contained in:
Daniel Vaz Gaspar
committed by
GitHub
GitHub
parent
611dd7a8f6
commit
4529812a10
@@ -1,343 +0,0 @@
|
||||
# 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 typing import Any, Dict, List, Optional
|
||||
|
||||
from flask_appbuilder.api import expose, protect, safe
|
||||
from flask_appbuilder.models.sqla.interface import SQLAInterface
|
||||
from sqlalchemy.exc import NoSuchTableError, SQLAlchemyError
|
||||
|
||||
from superset import event_logger
|
||||
from superset.models.core import Database
|
||||
from superset.typing import FlaskResponse
|
||||
from superset.utils.core import error_msg_from_exception
|
||||
from superset.views.base_api import BaseSupersetModelRestApi
|
||||
from superset.views.database.decorators import check_datasource_access
|
||||
from superset.views.database.filters import DatabaseFilter
|
||||
from superset.views.database.mixins import DatabaseMixin
|
||||
from superset.views.database.validators import sqlalchemy_uri_validator
|
||||
|
||||
|
||||
def get_foreign_keys_metadata(
|
||||
database: Database, table_name: str, schema_name: Optional[str]
|
||||
) -> List[Dict[str, Any]]:
|
||||
foreign_keys = database.get_foreign_keys(table_name, schema_name)
|
||||
for fk in foreign_keys:
|
||||
fk["column_names"] = fk.pop("constrained_columns")
|
||||
fk["type"] = "fk"
|
||||
return foreign_keys
|
||||
|
||||
|
||||
def get_indexes_metadata(
|
||||
database: Database, table_name: str, schema_name: Optional[str]
|
||||
) -> List[Dict[str, Any]]:
|
||||
indexes = database.get_indexes(table_name, schema_name)
|
||||
for idx in indexes:
|
||||
idx["type"] = "index"
|
||||
return indexes
|
||||
|
||||
|
||||
def get_col_type(col: Dict[Any, Any]) -> str:
|
||||
try:
|
||||
dtype = f"{col['type']}"
|
||||
except Exception: # pylint: disable=broad-except
|
||||
# sqla.types.JSON __str__ has a bug, so using __class__.
|
||||
dtype = col["type"].__class__.__name__
|
||||
return dtype
|
||||
|
||||
|
||||
def get_table_metadata(
|
||||
database: Database, table_name: str, schema_name: Optional[str]
|
||||
) -> Dict[str, Any]:
|
||||
"""
|
||||
Get table metadata information, including type, pk, fks.
|
||||
This function raises SQLAlchemyError when a schema is not found.
|
||||
|
||||
|
||||
:param database: The database model
|
||||
:param table_name: Table name
|
||||
:param schema_name: schema name
|
||||
:return: Dict table metadata ready for API response
|
||||
"""
|
||||
keys = []
|
||||
columns = database.get_columns(table_name, schema_name)
|
||||
primary_key = database.get_pk_constraint(table_name, schema_name)
|
||||
if primary_key and primary_key.get("constrained_columns"):
|
||||
primary_key["column_names"] = primary_key.pop("constrained_columns")
|
||||
primary_key["type"] = "pk"
|
||||
keys += [primary_key]
|
||||
foreign_keys = get_foreign_keys_metadata(database, table_name, schema_name)
|
||||
indexes = get_indexes_metadata(database, table_name, schema_name)
|
||||
keys += foreign_keys + indexes
|
||||
payload_columns: List[Dict[str, Any]] = []
|
||||
for col in columns:
|
||||
dtype = get_col_type(col)
|
||||
payload_columns.append(
|
||||
{
|
||||
"name": col["name"],
|
||||
"type": dtype.split("(")[0] if "(" in dtype else dtype,
|
||||
"longType": dtype,
|
||||
"keys": [k for k in keys if col["name"] in k["column_names"]],
|
||||
}
|
||||
)
|
||||
return {
|
||||
"name": table_name,
|
||||
"columns": payload_columns,
|
||||
"selectStar": database.select_star(
|
||||
table_name,
|
||||
schema=schema_name,
|
||||
show_cols=True,
|
||||
indent=True,
|
||||
cols=columns,
|
||||
latest_partition=True,
|
||||
),
|
||||
"primaryKey": primary_key,
|
||||
"foreignKeys": foreign_keys,
|
||||
"indexes": keys,
|
||||
}
|
||||
|
||||
|
||||
class DatabaseRestApi(DatabaseMixin, BaseSupersetModelRestApi):
|
||||
datamodel = SQLAInterface(Database)
|
||||
|
||||
include_route_methods = {"get_list", "table_metadata", "select_star"}
|
||||
class_permission_name = "DatabaseView"
|
||||
method_permission_name = {
|
||||
"get_list": "list",
|
||||
"table_metadata": "list",
|
||||
"select_star": "list",
|
||||
}
|
||||
resource_name = "database"
|
||||
allow_browser_login = True
|
||||
base_filters = [["id", DatabaseFilter, lambda: []]]
|
||||
list_columns = [
|
||||
"id",
|
||||
"database_name",
|
||||
"expose_in_sqllab",
|
||||
"allow_ctas",
|
||||
"allow_cvas",
|
||||
"force_ctas_schema",
|
||||
"allow_run_async",
|
||||
"allow_dml",
|
||||
"allow_multi_schema_metadata_fetch",
|
||||
"allow_csv_upload",
|
||||
"allows_subquery",
|
||||
"allows_cost_estimate",
|
||||
"allows_virtual_table_explore",
|
||||
"explore_database_id",
|
||||
"backend",
|
||||
"function_names",
|
||||
]
|
||||
show_columns = list_columns
|
||||
|
||||
# Removes the local limit for the page size
|
||||
max_page_size = -1
|
||||
validators_columns = {"sqlalchemy_uri": sqlalchemy_uri_validator}
|
||||
|
||||
openapi_spec_tag = "Database"
|
||||
|
||||
@expose("/<int:pk>/table/<table_name>/<schema_name>/", methods=["GET"])
|
||||
@protect()
|
||||
@check_datasource_access
|
||||
@safe
|
||||
@event_logger.log_this
|
||||
def table_metadata(
|
||||
self, database: Database, table_name: str, schema_name: str
|
||||
) -> FlaskResponse:
|
||||
""" Table schema info
|
||||
---
|
||||
get:
|
||||
description: Get database table metadata
|
||||
parameters:
|
||||
- in: path
|
||||
schema:
|
||||
type: integer
|
||||
name: pk
|
||||
description: The database id
|
||||
- in: path
|
||||
schema:
|
||||
type: string
|
||||
name: table_name
|
||||
description: Table name
|
||||
- in: path
|
||||
schema:
|
||||
type: string
|
||||
name: schema_name
|
||||
description: Table schema
|
||||
responses:
|
||||
200:
|
||||
description: Table schema info
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
columns:
|
||||
type: array
|
||||
description: Table columns info
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
keys:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
longType:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
foreignKeys:
|
||||
type: array
|
||||
description: Table list of foreign keys
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
column_names:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
options:
|
||||
type: object
|
||||
referred_columns:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
referred_schema:
|
||||
type: string
|
||||
referred_table:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
indexes:
|
||||
type: array
|
||||
description: Table list of indexes
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
column_names:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
options:
|
||||
type: object
|
||||
referred_columns:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
referred_schema:
|
||||
type: string
|
||||
referred_table:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
primaryKey:
|
||||
type: object
|
||||
properties:
|
||||
column_names:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
type:
|
||||
type: string
|
||||
400:
|
||||
$ref: '#/components/responses/400'
|
||||
401:
|
||||
$ref: '#/components/responses/401'
|
||||
404:
|
||||
$ref: '#/components/responses/404'
|
||||
422:
|
||||
$ref: '#/components/responses/422'
|
||||
500:
|
||||
$ref: '#/components/responses/500'
|
||||
"""
|
||||
self.incr_stats("init", self.table_metadata.__name__)
|
||||
try:
|
||||
table_info = get_table_metadata(database, table_name, schema_name)
|
||||
except SQLAlchemyError as ex:
|
||||
self.incr_stats("error", self.table_metadata.__name__)
|
||||
return self.response_422(error_msg_from_exception(ex))
|
||||
self.incr_stats("success", self.table_metadata.__name__)
|
||||
return self.response(200, **table_info)
|
||||
|
||||
@expose("/<int:pk>/select_star/<table_name>/", methods=["GET"])
|
||||
@expose("/<int:pk>/select_star/<table_name>/<schema_name>/", methods=["GET"])
|
||||
@protect()
|
||||
@check_datasource_access
|
||||
@safe
|
||||
@event_logger.log_this
|
||||
def select_star(
|
||||
self, database: Database, table_name: str, schema_name: Optional[str] = None
|
||||
) -> FlaskResponse:
|
||||
""" Table schema info
|
||||
---
|
||||
get:
|
||||
description: Get database select star for table
|
||||
parameters:
|
||||
- in: path
|
||||
schema:
|
||||
type: integer
|
||||
name: pk
|
||||
description: The database id
|
||||
- in: path
|
||||
schema:
|
||||
type: string
|
||||
name: table_name
|
||||
description: Table name
|
||||
- in: path
|
||||
schema:
|
||||
type: string
|
||||
name: schema_name
|
||||
description: Table schema
|
||||
responses:
|
||||
200:
|
||||
description: select star for table
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
result:
|
||||
type: string
|
||||
description: SQL select star
|
||||
400:
|
||||
$ref: '#/components/responses/400'
|
||||
401:
|
||||
$ref: '#/components/responses/401'
|
||||
404:
|
||||
$ref: '#/components/responses/404'
|
||||
422:
|
||||
$ref: '#/components/responses/422'
|
||||
500:
|
||||
$ref: '#/components/responses/500'
|
||||
"""
|
||||
self.incr_stats("init", self.select_star.__name__)
|
||||
try:
|
||||
result = database.select_star(
|
||||
table_name, schema_name, latest_partition=True, show_cols=True
|
||||
)
|
||||
except NoSuchTableError:
|
||||
self.incr_stats("error", self.select_star.__name__)
|
||||
return self.response(404, message="Table not found on the database")
|
||||
self.incr_stats("success", self.select_star.__name__)
|
||||
return self.response(200, result=result)
|
||||
@@ -1,68 +0,0 @@
|
||||
# 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 functools
|
||||
import logging
|
||||
from typing import Any, Callable, Optional
|
||||
|
||||
from flask import g
|
||||
from flask_babel import lazy_gettext as _
|
||||
|
||||
from superset.models.core import Database
|
||||
from superset.sql_parse import Table
|
||||
from superset.utils.core import parse_js_uri_path_item
|
||||
from superset.views.base_api import BaseSupersetModelRestApi
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def check_datasource_access(f: Callable[..., Any]) -> Callable[..., Any]:
|
||||
"""
|
||||
A Decorator that checks if a user has datasource access
|
||||
"""
|
||||
|
||||
def wraps(
|
||||
self: BaseSupersetModelRestApi,
|
||||
pk: int,
|
||||
table_name: str,
|
||||
schema_name: Optional[str] = None,
|
||||
) -> Any:
|
||||
schema_name_parsed = parse_js_uri_path_item(schema_name, eval_undefined=True)
|
||||
table_name_parsed = parse_js_uri_path_item(table_name)
|
||||
if not table_name_parsed:
|
||||
return self.response_422(message=_("Table name undefined"))
|
||||
database: Database = self.datamodel.get(pk)
|
||||
if not database:
|
||||
self.stats_logger.incr(
|
||||
f"database_not_found_{self.__class__.__name__}.select_star"
|
||||
)
|
||||
return self.response_404()
|
||||
if not self.appbuilder.sm.can_access_table(
|
||||
database, Table(table_name_parsed, schema_name_parsed)
|
||||
):
|
||||
self.stats_logger.incr(
|
||||
f"permisssion_denied_{self.__class__.__name__}.select_star"
|
||||
)
|
||||
logger.warning(
|
||||
"Permission denied for user %s on table: %s schema: %s",
|
||||
g.user,
|
||||
table_name_parsed,
|
||||
schema_name_parsed,
|
||||
)
|
||||
return self.response_404()
|
||||
return f(self, database, table_name_parsed, schema_name_parsed)
|
||||
|
||||
return functools.update_wrapper(wraps, f)
|
||||
Reference in New Issue
Block a user