rusackas commented on code in PR #38174:
URL: https://github.com/apache/superset/pull/38174#discussion_r2898606906
##########
superset/databases/api.py:
##########
@@ -1079,15 +1079,23 @@ def table_metadata(self, pk: int) -> FlaskResponse:
parameters = QualifiedTableSchema().load(request.args)
except ValidationError as ex:
raise InvalidPayloadSchemaError(ex) from ex
-
- table = Table(parameters["name"], parameters["schema"],
parameters["catalog"])
+ table_name = str(parameters["name"])
+ table = Table(table_name, parameters["schema"], parameters["catalog"])
+ is_partitioned_table, partition_fields =
DatabaseDAO.is_odps_partitioned_table(
+ database, table_name
+ )
Review Comment:
Mostly a false alarm. `is_odps_partitioned_table` returns immediately with
`(False, [])` for any non-ODPS backend — there's no network call in that path.
For ODPS databases the concern about connection reuse is real, but that's an
optimization for a follow-up once the feature is proven. No change for now.
##########
superset/daos/database.py:
##########
@@ -239,6 +241,49 @@ def get_datasets(
.all()
)
+ @classmethod
+ def is_odps_partitioned_table(
+ cls, database: Database, table_name: str
+ ) -> tuple[bool, list[str]]:
+ """
+ This function is used to determine and retrieve
+ partition information of the ODPS table.
+ The return values are whether the partition
+ table is partitioned and the names of all partition fields.
+ """
+ if not database:
+ raise ValueError("Database not found")
+ if database.backend != "odps":
+ return False, []
+ try:
+ from odps import ODPS
+ except ImportError:
+ logger.warning("pyodps is not installed, cannot check ODPS
partition info")
+ return False, []
+ uri = database.sqlalchemy_uri
+ access_key = database.password
+ pattern = re.compile(
+
r"odps://(?P<username>[^:]+):(?P<password>[^@]+)@(?P<project>[^/]+)/(?:\?"
+ r"endpoint=(?P<endpoint>[^&]+))"
+ )
+ if not uri or not isinstance(uri, str):
+ logger.warning(
+ "Invalid or missing sqlalchemy URI, please provide a correct
URI"
+ )
+ return False, []
+ if match := pattern.match(unquote(uri)):
+ access_id = match.group("username")
+ project = match.group("project")
+ endpoint = match.group("endpoint")
+ odps_client = ODPS(access_id, access_key, project,
endpoint=endpoint)
+ table = odps_client.get_table(table_name)
+ if table.exist_partition:
+ partition_spec = table.table_schema.partitions
+ partition_fields = [partition.name for partition in
partition_spec]
+ return True, partition_fields
+ return False, []
+ return False, []
Review Comment:
Valid. If the URI doesn't match the expected pattern for an ODPS database,
the function silently returns `(False, [])`, which could mask a misconfigured
connection string and make a partitioned table appear non-partitioned with no
indication of why. Will add a `logger.warning` when the regex fails to match on
an ODPS backend.
##########
superset/db_engine_specs/odps.py:
##########
@@ -0,0 +1,192 @@
+# 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 __future__ import annotations
+
+import logging
+from typing import Any, Optional, TYPE_CHECKING
+
+from sqlalchemy import select, text
+from sqlalchemy.engine.base import Engine
+
+from superset.databases.schemas import (
+ TableMetadataColumnsResponse,
+ TableMetadataResponse,
+)
+from superset.databases.utils import (
+ get_col_type,
+ get_foreign_keys_metadata,
+ get_indexes_metadata,
+)
+from superset.db_engine_specs.base import BaseEngineSpec, BasicParametersMixin
+from superset.sql.parse import Partition, SQLScript, Table
+from superset.superset_typing import ResultSetColumnType
+
+if TYPE_CHECKING:
+ from superset.models.core import Database
+
+logger = logging.getLogger(__name__)
+
+
+class OdpsBaseEngineSpec(BaseEngineSpec):
+ @classmethod
+ def get_table_metadata(
+ cls,
+ database: Database,
+ table: Table,
+ partition: Optional[Partition] = None,
+ ) -> TableMetadataResponse:
+ """
+ Returns basic table metadata
+ :param database: Database instance
+ :param table: A Table instance
+ :param partition: A Table partition info
+ :return: Basic table metadata
+ """
+ return cls.get_table_metadata(database, table, partition)
+
+
+class OdpsEngineSpec(BasicParametersMixin, OdpsBaseEngineSpec):
+ engine = "odps"
+ engine_name = "ODPS (MaxCompute)"
+ default_driver = "odps"
+
+ @classmethod
+ def get_table_metadata(
+ cls, database: Any, table: Table, partition: Optional[Partition] = None
+ ) -> TableMetadataResponse:
+ """
+ Get table metadata information, including type, pk, fks.
+ This function raises SQLAlchemyError when a schema is not found.
+
+ :param partition: The table's partition info
+ :param database: The database model
+ :param table: Table instance
+ :return: Dict table metadata ready for API response
+ """
+ keys = []
+ columns = database.get_columns(table)
+ primary_key = database.get_pk_constraint(table)
+ 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)
+ indexes = get_indexes_metadata(database, table)
+ keys += foreign_keys + indexes
+ payload_columns: list[TableMetadataColumnsResponse] = []
+ table_comment = database.get_table_comment(table)
+ for col in columns:
+ dtype = get_col_type(col)
+ payload_columns.append(
+ {
+ "name": col["column_name"],
+ "type": dtype.split("(")[0] if "(" in dtype else dtype,
+ "longType": dtype,
+ "keys": [
+ k for k in keys if col["column_name"] in
k["column_names"]
+ ],
+ "comment": col.get("comment"),
+ }
+ )
+
+ with database.get_sqla_engine(
+ catalog=table.catalog, schema=table.schema
+ ) as engine:
+ return {
+ "name": table.table,
+ "columns": payload_columns,
+ "selectStar": cls.select_star(
+ database=database,
+ table=table,
+ engine=engine,
+ limit=100,
+ show_cols=False,
+ indent=True,
+ latest_partition=True,
+ cols=columns,
+ partition=partition,
+ ),
+ "primaryKey": primary_key,
+ "foreignKeys": foreign_keys,
+ "indexes": keys,
+ "comment": table_comment,
+ }
+
+ @classmethod
+ def select_star( # pylint: disable=too-many-arguments
+ cls,
+ database: Database,
+ table: Table,
+ engine: Engine,
+ limit: int = 100,
+ show_cols: bool = False,
+ indent: bool = True,
+ latest_partition: bool = True,
+ cols: list[ResultSetColumnType] | None = None,
+ partition: Optional[Partition] = None,
Review Comment:
Valid — the PR description explicitly called out modernizing to `X | None`
style but `Optional[Partition]` was missed in a few places. Will fix to
`Partition | None`.
##########
superset/databases/api.py:
##########
@@ -1079,15 +1079,23 @@ def table_metadata(self, pk: int) -> FlaskResponse:
parameters = QualifiedTableSchema().load(request.args)
except ValidationError as ex:
raise InvalidPayloadSchemaError(ex) from ex
-
- table = Table(parameters["name"], parameters["schema"],
parameters["catalog"])
+ table_name = str(parameters["name"])
+ table = Table(table_name, parameters["schema"], parameters["catalog"])
+ is_partitioned_table, partition_fields =
DatabaseDAO.is_odps_partitioned_table(
+ database, table_name
+ )
try:
security_manager.raise_for_access(database=database, table=table)
except SupersetSecurityException as ex:
# instead of raising 403, raise 404 to hide table existence
raise TableNotFoundException("No such table") from ex
Review Comment:
Valid — same security ordering issue flagged by CodeAnt. The ODPS backend
call must not happen before `raise_for_access`. Will move
`is_odps_partitioned_table` to after the security check.
--
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]
