# 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 datetime import datetime from typing import Any, Dict, Optional, Tuple from urllib import parse from sqlalchemy import types from sqlalchemy.engine.url import URL from superset.db_engine_specs.base import BaseEngineSpec from superset.db_engine_specs.exceptions import SupersetDBAPIProgrammingError class DrillEngineSpec(BaseEngineSpec): """Engine spec for Apache Drill""" engine = "drill" engine_name = "Apache Drill" default_driver = "sadrill" supports_dynamic_schema = True _time_grain_expressions = { None: "{col}", "PT1S": "NEARESTDATE({col}, 'SECOND')", "PT1M": "NEARESTDATE({col}, 'MINUTE')", "PT15M": "NEARESTDATE({col}, 'QUARTER_HOUR')", "PT30M": "NEARESTDATE({col}, 'HALF_HOUR')", "PT1H": "NEARESTDATE({col}, 'HOUR')", "P1D": "NEARESTDATE({col}, 'DAY')", "P1W": "NEARESTDATE({col}, 'WEEK_SUNDAY')", "P1M": "NEARESTDATE({col}, 'MONTH')", "P3M": "NEARESTDATE({col}, 'QUARTER')", "P1Y": "NEARESTDATE({col}, 'YEAR')", } # Returns a function to convert a Unix timestamp in milliseconds to a date @classmethod def epoch_to_dttm(cls) -> str: return cls.epoch_ms_to_dttm().replace("{col}", "({col}*1000)") @classmethod def epoch_ms_to_dttm(cls) -> str: return "TO_DATE({col})" @classmethod def convert_dttm( cls, target_type: str, dttm: datetime, db_extra: Optional[Dict[str, Any]] = None ) -> Optional[str]: sqla_type = cls.get_sqla_column_type(target_type) if isinstance(sqla_type, types.Date): return f"TO_DATE('{dttm.date().isoformat()}', 'yyyy-MM-dd')" if isinstance(sqla_type, types.TIMESTAMP): datetime_formatted = dttm.isoformat(sep=" ", timespec="seconds") return f"""TO_TIMESTAMP('{datetime_formatted}', 'yyyy-MM-dd HH:mm:ss')""" return None @classmethod def adjust_engine_params( cls, uri: URL, connect_args: Dict[str, Any], catalog: Optional[str] = None, schema: Optional[str] = None, ) -> Tuple[URL, Dict[str, Any]]: if schema: uri = uri.set(database=parse.quote(schema.replace(".", "/"), safe="")) return uri, connect_args @classmethod def get_schema_from_engine_params( cls, sqlalchemy_uri: URL, connect_args: Dict[str, Any], ) -> Optional[str]: """ Return the configured schema. """ return parse.unquote(sqlalchemy_uri.database).replace("/", ".") @classmethod def get_url_for_impersonation( cls, url: URL, impersonate_user: bool, username: Optional[str] ) -> URL: """ Return a modified URL with the username set. :param url: SQLAlchemy URL object :param impersonate_user: Flag indicating if impersonation is enabled :param username: Effective username """ if impersonate_user and username is not None: if url.drivername == "drill+odbc": url = url.update_query_dict({"DelegationUID": username}) elif url.drivername in ["drill+sadrill", "drill+jdbc"]: url = url.update_query_dict({"impersonation_target": username}) else: raise SupersetDBAPIProgrammingError( f"impersonation is not supported for {url.drivername}" ) return url