# 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, Optional from sqlalchemy import types from superset.constants import TimeGrain from superset.db_engine_specs.base import BaseEngineSpec, DatabaseCategory class FireboltEngineSpec(BaseEngineSpec): """Engine spec for Firebolt""" engine = "firebolt" engine_name = "Firebolt" default_driver = "firebolt" metadata = { "description": ( "Firebolt is a cloud data warehouse designed for " "high-performance analytics." ), "logo": "firebolt.png", "homepage_url": "https://www.firebolt.io/", "categories": [ DatabaseCategory.CLOUD_DATA_WAREHOUSES, DatabaseCategory.ANALYTICAL_DATABASES, DatabaseCategory.PROPRIETARY, ], "pypi_packages": ["firebolt-sqlalchemy"], "connection_string": ( "firebolt://{client_id}:{client_secret}@{database}/{engine_name}" "?account_name={account_name}" ), "parameters": { "client_id": "Service account client ID", "client_secret": "Service account client secret", "database": "Database name", "engine_name": "Engine name", "account_name": "Account name", }, "drivers": [ { "name": "firebolt-sqlalchemy", "pypi_package": "firebolt-sqlalchemy", "connection_string": ( "firebolt://{client_id}:{client_secret}@{database}/{engine_name}" "?account_name={account_name}" ), "is_recommended": True, }, ], } _time_grain_expressions = { None: "{col}", TimeGrain.SECOND: "date_trunc('second', CAST({col} AS TIMESTAMP))", TimeGrain.MINUTE: "date_trunc('minute', CAST({col} AS TIMESTAMP))", TimeGrain.HOUR: "date_trunc('hour', CAST({col} AS TIMESTAMP))", TimeGrain.DAY: "date_trunc('day', CAST({col} AS TIMESTAMP))", TimeGrain.WEEK: "date_trunc('week', CAST({col} AS TIMESTAMP))", TimeGrain.MONTH: "date_trunc('month', CAST({col} AS TIMESTAMP))", TimeGrain.QUARTER: "date_trunc('quarter', CAST({col} AS TIMESTAMP))", TimeGrain.YEAR: "date_trunc('year', CAST({col} AS TIMESTAMP))", } @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"CAST('{dttm.date().isoformat()}' AS DATE)" if isinstance(sqla_type, types.TIMESTAMP): return f"""CAST('{dttm.isoformat(timespec="seconds")}' AS TIMESTAMP)""" if isinstance(sqla_type, types.DateTime): return f"""CAST('{dttm.isoformat(timespec="seconds")}' AS DATETIME)""" return None @classmethod def epoch_to_dttm(cls) -> str: return "from_unixtime({col})"