# 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 import re from datetime import datetime from typing import Any, Dict, List, Optional, Pattern, Tuple from flask_babel import gettext as __ from superset.db_engine_specs.base import BaseEngineSpec, LimitMethod from superset.errors import SupersetErrorType from superset.utils import core as utils logger = logging.getLogger(__name__) # Regular expressions to catch custom errors CONNECTION_ACCESS_DENIED_REGEX = re.compile("Adaptive Server connection failed") CONNECTION_INVALID_HOSTNAME_REGEX = re.compile( r"Adaptive Server is unavailable or does not exist \((?P.*?)\)" "(?!.*Net-Lib error).*$" ) CONNECTION_PORT_CLOSED_REGEX = re.compile( r"Net-Lib error during Connection refused \(61\)" ) CONNECTION_HOST_DOWN_REGEX = re.compile( r"Net-Lib error during Operation timed out \(60\)" ) class MssqlEngineSpec(BaseEngineSpec): engine = "mssql" engine_name = "Microsoft SQL" limit_method = LimitMethod.WRAP_SQL max_column_name_length = 128 _time_grain_expressions = { None: "{col}", "PT1S": "DATEADD(second, DATEDIFF(second, '2000-01-01', {col}), '2000-01-01')", "PT1M": "DATEADD(minute, DATEDIFF(minute, 0, {col}), 0)", "PT5M": "DATEADD(minute, DATEDIFF(minute, 0, {col}) / 5 * 5, 0)", "PT10M": "DATEADD(minute, DATEDIFF(minute, 0, {col}) / 10 * 10, 0)", "PT15M": "DATEADD(minute, DATEDIFF(minute, 0, {col}) / 15 * 15, 0)", "PT0.5H": "DATEADD(minute, DATEDIFF(minute, 0, {col}) / 30 * 30, 0)", "PT1H": "DATEADD(hour, DATEDIFF(hour, 0, {col}), 0)", "P1D": "DATEADD(day, DATEDIFF(day, 0, {col}), 0)", "P1W": "DATEADD(week, DATEDIFF(week, 0, {col}), 0)", "P1M": "DATEADD(month, DATEDIFF(month, 0, {col}), 0)", "P0.25Y": "DATEADD(quarter, DATEDIFF(quarter, 0, {col}), 0)", "P1Y": "DATEADD(year, DATEDIFF(year, 0, {col}), 0)", } custom_errors: Dict[Pattern[str], Tuple[str, SupersetErrorType, Dict[str, Any]]] = { CONNECTION_ACCESS_DENIED_REGEX: ( __( 'Either the username "%(username)s", password, ' 'or database name "%(database)s" is incorrect.' ), SupersetErrorType.CONNECTION_ACCESS_DENIED_ERROR, {}, ), CONNECTION_INVALID_HOSTNAME_REGEX: ( __('The hostname "%(hostname)s" cannot be resolved.'), SupersetErrorType.CONNECTION_INVALID_HOSTNAME_ERROR, {}, ), CONNECTION_PORT_CLOSED_REGEX: ( __('Port %(port)s on hostname "%(hostname)s" refused the connection.'), SupersetErrorType.CONNECTION_PORT_CLOSED_ERROR, {}, ), CONNECTION_HOST_DOWN_REGEX: ( __( 'The host "%(hostname)s" might be down, and can\'t be ' "reached on port %(port)s." ), SupersetErrorType.CONNECTION_HOST_DOWN_ERROR, {}, ), } @classmethod def epoch_to_dttm(cls) -> str: return "dateadd(S, {col}, '1970-01-01')" @classmethod def convert_dttm(cls, target_type: str, dttm: datetime) -> Optional[str]: tt = target_type.upper() if tt == utils.TemporalType.DATE: return f"CONVERT(DATE, '{dttm.date().isoformat()}', 23)" if tt == utils.TemporalType.DATETIME: datetime_formatted = dttm.isoformat(timespec="milliseconds") return f"""CONVERT(DATETIME, '{datetime_formatted}', 126)""" if tt == utils.TemporalType.SMALLDATETIME: datetime_formatted = dttm.isoformat(sep=" ", timespec="seconds") return f"""CONVERT(SMALLDATETIME, '{datetime_formatted}', 20)""" return None @classmethod def fetch_data( cls, cursor: Any, limit: Optional[int] = None ) -> List[Tuple[Any, ...]]: data = super().fetch_data(cursor, limit) # Lists of `pyodbc.Row` need to be unpacked further return cls.pyodbc_rows_to_tuples(data) @classmethod def extract_error_message(cls, ex: Exception) -> str: if str(ex).startswith("(8155,"): return ( f"{cls.engine} error: All your SQL functions need to " "have an alias on MSSQL. For example: SELECT COUNT(*) AS C1 FROM TABLE1" ) return f"{cls.engine} error: {cls._extract_error_message(ex)}"