villebro commented on code in PR #24172: URL: https://github.com/apache/superset/pull/24172#discussion_r1200455733
########## superset/db_engine_specs/questdb.py: ########## @@ -0,0 +1,311 @@ +# 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 re +from datetime import datetime +from typing import Any, Dict, List, Optional, Tuple + +from flask_babel import gettext as __ +from flask_babel import lazy_gettext as _ +from marshmallow import Schema, fields +from sqlalchemy.engine.interfaces import Dialect +from sqlalchemy.sql import text +from sqlalchemy.types import TypeEngine +from superset.db_engine_specs.base import ( + BaseEngineSpec, + BasicParametersMixin, + BasicParametersType, + TimeGrain, + builtin_time_grains, +) +from superset.utils import core as utils +from superset.utils.core import GenericDataType + +from questdb_connect import remove_public_schema, types +from questdb_connect.dialect import connection_uri +from questdb_connect.function_names import FUNCTION_NAMES + +# Apache Superset requires a Python DB-API database driver, and a SQLAlchemy dialect +# https://superset.apache.org/docs/databases/installing-database-drivers +# https://preset.io/blog/building-database-connector/ +# https://preset.io/blog/improving-apache-superset-integration-database-sqlalchemy/ + + +class QDBParametersSchema(Schema): + username = fields.String(allow_none=True, description=__('user')) + password = fields.String(allow_none=True, description=__('password')) + host = fields.String(required=True, description=__('host')) + port = fields.Integer(allow_none=True, description=__('port')) + database = fields.String(allow_none=True, description=__('database')) + + +class QDBEngineSpec(BaseEngineSpec, BasicParametersMixin): + engine = 'questdb' + engine_name = 'QuestDB Connect' + default_driver = "psycopg2" + encryption_parameters = {"sslmode": "prefer"} + sqlalchemy_uri_placeholder = "questdb://user:password@host:port/database" + parameters_schema = QDBParametersSchema() + time_groupby_inline = False + allows_hidden_cc_in_orderby = True + time_secondary_columns = True + try_remove_schema_from_table_name = True + max_column_name_length = 120 + supports_dynamic_schema = False + top_keywords = {} + # https://en.wikipedia.org/wiki/ISO_8601#Durations + # https://questdb.io/docs/reference/function/date-time/#date_trunc + _time_grain_expressions = { + None: '{col}', + "PT1S": "date_trunc('second', {col})", + "PT5S": "date_trunc('second', {col}) + 5000000L", + "PT30S": "date_trunc('second', {col}) + 30000000L", + "PT1M": "date_trunc('minute', {col})", + "PT5M": "date_trunc('minute', {col}) + 300000000L", + "PT10M": "date_trunc('minute', {col}) + 600000000L", + "PT15M": "date_trunc('minute', {col}) + 900000000L", + "PT30M": "date_trunc('minute', {col}) + 1800000000L", + "PT1H": "date_trunc('hour', {col})", + "PT6H": "date_trunc('hour', {col}) + 21600000000L", + "P1D": "date_trunc('day', {col})", + "P1W": "date_trunc('week', {col})", + "P1M": "date_trunc('month', {col})", + "P1Y": "date_trunc('year', {col})", + "P3M": "date_trunc('quarter', {col})", + } + ret_list = [] + for duration, func in _time_grain_expressions.items(): + if duration: + name = builtin_time_grains[duration] + ret_list.append(TimeGrain(name, _(name), func, duration)) + _engine_time_grains = tuple(ret_list) + _default_column_type_mappings = ( Review Comment: `_default_column_type_mappings` should not be overridden - please define `column_type_mappings` instead ########## superset/db_engine_specs/questdb.py: ########## @@ -0,0 +1,311 @@ +# 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 re +from datetime import datetime +from typing import Any, Dict, List, Optional, Tuple + +from flask_babel import gettext as __ +from flask_babel import lazy_gettext as _ +from marshmallow import Schema, fields +from sqlalchemy.engine.interfaces import Dialect +from sqlalchemy.sql import text +from sqlalchemy.types import TypeEngine +from superset.db_engine_specs.base import ( + BaseEngineSpec, + BasicParametersMixin, + BasicParametersType, + TimeGrain, + builtin_time_grains, +) +from superset.utils import core as utils +from superset.utils.core import GenericDataType + +from questdb_connect import remove_public_schema, types +from questdb_connect.dialect import connection_uri +from questdb_connect.function_names import FUNCTION_NAMES + +# Apache Superset requires a Python DB-API database driver, and a SQLAlchemy dialect +# https://superset.apache.org/docs/databases/installing-database-drivers +# https://preset.io/blog/building-database-connector/ +# https://preset.io/blog/improving-apache-superset-integration-database-sqlalchemy/ + + +class QDBParametersSchema(Schema): + username = fields.String(allow_none=True, description=__('user')) + password = fields.String(allow_none=True, description=__('password')) + host = fields.String(required=True, description=__('host')) + port = fields.Integer(allow_none=True, description=__('port')) + database = fields.String(allow_none=True, description=__('database')) + + +class QDBEngineSpec(BaseEngineSpec, BasicParametersMixin): + engine = 'questdb' + engine_name = 'QuestDB Connect' + default_driver = "psycopg2" + encryption_parameters = {"sslmode": "prefer"} + sqlalchemy_uri_placeholder = "questdb://user:password@host:port/database" + parameters_schema = QDBParametersSchema() + time_groupby_inline = False + allows_hidden_cc_in_orderby = True + time_secondary_columns = True + try_remove_schema_from_table_name = True + max_column_name_length = 120 + supports_dynamic_schema = False + top_keywords = {} + # https://en.wikipedia.org/wiki/ISO_8601#Durations + # https://questdb.io/docs/reference/function/date-time/#date_trunc + _time_grain_expressions = { + None: '{col}', + "PT1S": "date_trunc('second', {col})", + "PT5S": "date_trunc('second', {col}) + 5000000L", + "PT30S": "date_trunc('second', {col}) + 30000000L", + "PT1M": "date_trunc('minute', {col})", + "PT5M": "date_trunc('minute', {col}) + 300000000L", + "PT10M": "date_trunc('minute', {col}) + 600000000L", + "PT15M": "date_trunc('minute', {col}) + 900000000L", + "PT30M": "date_trunc('minute', {col}) + 1800000000L", + "PT1H": "date_trunc('hour', {col})", + "PT6H": "date_trunc('hour', {col}) + 21600000000L", + "P1D": "date_trunc('day', {col})", + "P1W": "date_trunc('week', {col})", + "P1M": "date_trunc('month', {col})", + "P1Y": "date_trunc('year', {col})", + "P3M": "date_trunc('quarter', {col})", + } + ret_list = [] + for duration, func in _time_grain_expressions.items(): + if duration: + name = builtin_time_grains[duration] + ret_list.append(TimeGrain(name, _(name), func, duration)) + _engine_time_grains = tuple(ret_list) + _default_column_type_mappings = ( + (re.compile("^LONG256", re.IGNORECASE), types.Long256, GenericDataType.STRING), + (re.compile("^BOOLEAN", re.IGNORECASE), types.Boolean, GenericDataType.BOOLEAN), + (re.compile("^BYTE", re.IGNORECASE), types.Byte, GenericDataType.BOOLEAN), + (re.compile("^SHORT", re.IGNORECASE), types.Short, GenericDataType.NUMERIC), + (re.compile("^INT", re.IGNORECASE), types.Int, GenericDataType.NUMERIC), + (re.compile("^LONG", re.IGNORECASE), types.Long, GenericDataType.NUMERIC), + (re.compile("^FLOAT", re.IGNORECASE), types.Float, GenericDataType.NUMERIC), + (re.compile("^DOUBLE'", re.IGNORECASE), types.Double, GenericDataType.NUMERIC), + (re.compile("^SYMBOL", re.IGNORECASE), types.Symbol, GenericDataType.STRING), + (re.compile("^STRING", re.IGNORECASE), types.String, GenericDataType.STRING), + (re.compile("^UUID", re.IGNORECASE), types.UUID, GenericDataType.STRING), + (re.compile("^CHAR", re.IGNORECASE), types.Char, GenericDataType.STRING), + (re.compile("^TIMESTAMP", re.IGNORECASE), types.Timestamp, GenericDataType.TEMPORAL), + (re.compile("^DATE", re.IGNORECASE), types.Date, GenericDataType.TEMPORAL), + (re.compile(r"^GEOHASH\(\d+[b|c]\)", re.IGNORECASE), types.GeohashLong, GenericDataType.STRING) + ) + column_type_mappings = _default_column_type_mappings + + @classmethod + def build_sqlalchemy_uri( + cls, + parameters: BasicParametersType, + encrypted_extra: Optional[Dict[str, str]] = None + ) -> str: + return connection_uri( + parameters.get("host"), + int(parameters.get("port")), + parameters.get("username"), + parameters.get("password"), + parameters.get("database")) + + @classmethod + def get_default_schema_for_query(cls, database, query) -> Optional[str]: + return 'public' + + @classmethod + def get_text_clause(cls, clause): + """SQLAlchemy wrapper to ensure text clauses are escaped properly + :param clause: string clause with potentially unescaped characters + :return: text clause with escaped characters + """ + if cls.allows_escaped_colons: + clause = clause.replace(":", "\\:") + return text(remove_public_schema(clause)) + + @classmethod + def get_time_grain_expressions(cls) -> Dict[Optional[str], str]: + """Return a dict of all supported time grains including any + potential added grains but excluding any potentially disabled + grains in the config file. + :return: All time grain expressions supported by the engine + """ + return cls._time_grain_expressions + Review Comment: I don't think you need to override this - it should already be handled by `BaseEngineSpec`. Or is there some reason why that method doesn't work here? ########## superset/db_engine_specs/questdb.py: ########## @@ -0,0 +1,311 @@ +# 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 re +from datetime import datetime +from typing import Any, Dict, List, Optional, Tuple + +from flask_babel import gettext as __ +from flask_babel import lazy_gettext as _ +from marshmallow import Schema, fields +from sqlalchemy.engine.interfaces import Dialect +from sqlalchemy.sql import text +from sqlalchemy.types import TypeEngine +from superset.db_engine_specs.base import ( + BaseEngineSpec, + BasicParametersMixin, + BasicParametersType, + TimeGrain, + builtin_time_grains, +) +from superset.utils import core as utils +from superset.utils.core import GenericDataType + +from questdb_connect import remove_public_schema, types +from questdb_connect.dialect import connection_uri +from questdb_connect.function_names import FUNCTION_NAMES + +# Apache Superset requires a Python DB-API database driver, and a SQLAlchemy dialect +# https://superset.apache.org/docs/databases/installing-database-drivers +# https://preset.io/blog/building-database-connector/ +# https://preset.io/blog/improving-apache-superset-integration-database-sqlalchemy/ + + +class QDBParametersSchema(Schema): + username = fields.String(allow_none=True, description=__('user')) + password = fields.String(allow_none=True, description=__('password')) + host = fields.String(required=True, description=__('host')) + port = fields.Integer(allow_none=True, description=__('port')) + database = fields.String(allow_none=True, description=__('database')) + + +class QDBEngineSpec(BaseEngineSpec, BasicParametersMixin): + engine = 'questdb' + engine_name = 'QuestDB Connect' + default_driver = "psycopg2" + encryption_parameters = {"sslmode": "prefer"} + sqlalchemy_uri_placeholder = "questdb://user:password@host:port/database" + parameters_schema = QDBParametersSchema() + time_groupby_inline = False + allows_hidden_cc_in_orderby = True + time_secondary_columns = True + try_remove_schema_from_table_name = True + max_column_name_length = 120 + supports_dynamic_schema = False + top_keywords = {} + # https://en.wikipedia.org/wiki/ISO_8601#Durations + # https://questdb.io/docs/reference/function/date-time/#date_trunc + _time_grain_expressions = { + None: '{col}', + "PT1S": "date_trunc('second', {col})", + "PT5S": "date_trunc('second', {col}) + 5000000L", + "PT30S": "date_trunc('second', {col}) + 30000000L", + "PT1M": "date_trunc('minute', {col})", + "PT5M": "date_trunc('minute', {col}) + 300000000L", + "PT10M": "date_trunc('minute', {col}) + 600000000L", + "PT15M": "date_trunc('minute', {col}) + 900000000L", + "PT30M": "date_trunc('minute', {col}) + 1800000000L", + "PT1H": "date_trunc('hour', {col})", + "PT6H": "date_trunc('hour', {col}) + 21600000000L", + "P1D": "date_trunc('day', {col})", + "P1W": "date_trunc('week', {col})", + "P1M": "date_trunc('month', {col})", + "P1Y": "date_trunc('year', {col})", + "P3M": "date_trunc('quarter', {col})", + } + ret_list = [] + for duration, func in _time_grain_expressions.items(): + if duration: + name = builtin_time_grains[duration] + ret_list.append(TimeGrain(name, _(name), func, duration)) + _engine_time_grains = tuple(ret_list) + _default_column_type_mappings = ( + (re.compile("^LONG256", re.IGNORECASE), types.Long256, GenericDataType.STRING), + (re.compile("^BOOLEAN", re.IGNORECASE), types.Boolean, GenericDataType.BOOLEAN), + (re.compile("^BYTE", re.IGNORECASE), types.Byte, GenericDataType.BOOLEAN), + (re.compile("^SHORT", re.IGNORECASE), types.Short, GenericDataType.NUMERIC), + (re.compile("^INT", re.IGNORECASE), types.Int, GenericDataType.NUMERIC), + (re.compile("^LONG", re.IGNORECASE), types.Long, GenericDataType.NUMERIC), + (re.compile("^FLOAT", re.IGNORECASE), types.Float, GenericDataType.NUMERIC), + (re.compile("^DOUBLE'", re.IGNORECASE), types.Double, GenericDataType.NUMERIC), + (re.compile("^SYMBOL", re.IGNORECASE), types.Symbol, GenericDataType.STRING), + (re.compile("^STRING", re.IGNORECASE), types.String, GenericDataType.STRING), + (re.compile("^UUID", re.IGNORECASE), types.UUID, GenericDataType.STRING), + (re.compile("^CHAR", re.IGNORECASE), types.Char, GenericDataType.STRING), + (re.compile("^TIMESTAMP", re.IGNORECASE), types.Timestamp, GenericDataType.TEMPORAL), + (re.compile("^DATE", re.IGNORECASE), types.Date, GenericDataType.TEMPORAL), + (re.compile(r"^GEOHASH\(\d+[b|c]\)", re.IGNORECASE), types.GeohashLong, GenericDataType.STRING) + ) + column_type_mappings = _default_column_type_mappings + + @classmethod + def build_sqlalchemy_uri( + cls, + parameters: BasicParametersType, + encrypted_extra: Optional[Dict[str, str]] = None + ) -> str: + return connection_uri( + parameters.get("host"), + int(parameters.get("port")), + parameters.get("username"), + parameters.get("password"), + parameters.get("database")) + + @classmethod + def get_default_schema_for_query(cls, database, query) -> Optional[str]: + return 'public' + + @classmethod + def get_text_clause(cls, clause): + """SQLAlchemy wrapper to ensure text clauses are escaped properly + :param clause: string clause with potentially unescaped characters + :return: text clause with escaped characters + """ + if cls.allows_escaped_colons: + clause = clause.replace(":", "\\:") + return text(remove_public_schema(clause)) + + @classmethod + def get_time_grain_expressions(cls) -> Dict[Optional[str], str]: + """Return a dict of all supported time grains including any + potential added grains but excluding any potentially disabled + grains in the config file. + :return: All time grain expressions supported by the engine + """ + return cls._time_grain_expressions + + @classmethod + def epoch_to_dttm(cls) -> str: + """SQL expression that converts epoch (seconds) to datetime that can be used in a + query. The reference column should be denoted as `{col}` in the return + expression, e.g. "FROM_UNIXTIME({col})" + :return: SQL Expression + """ + return '{col} * 1000000' + + @classmethod + def convert_dttm(cls, target_type: str, dttm: datetime, *_args, **_kwargs) -> Optional[str]: + """Convert a Python `datetime` object to a SQL expression. + :param target_type: The target type of expression + :param dttm: The datetime object + :return: The SQL expression + """ + type_u = target_type.upper() + if type_u == 'DATE': + return f"TO_DATE('{dttm.date().isoformat()}', 'YYYY-MM-DD')" + if type_u in ('DATETIME', 'TIMESTAMP'): + dttm_formatted = dttm.isoformat(sep=" ", timespec="microseconds") + return f"TO_TIMESTAMP('{dttm_formatted}', 'yyyy-MM-ddTHH:mm:ss.SSSUUUZ')" + return None + + @classmethod + def get_datatype(cls, type_code: Any) -> Optional[str]: + """Change column type code from cursor description to string representation. + :param type_code: Type code from cursor description + :return: String representation of type code + """ + return type_code.upper() if type_code and isinstance(type_code, str) else str(type_code) + + @classmethod + def get_time_grains(cls) -> Tuple[TimeGrain, ...]: + """Generate a tuple of supported time grains. + :return: All time grains supported by the engine + """ + return cls._engine_time_grains Review Comment: same here ########## superset/db_engine_specs/questdb.py: ########## @@ -0,0 +1,311 @@ +# 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 re +from datetime import datetime +from typing import Any, Dict, List, Optional, Tuple + +from flask_babel import gettext as __ +from flask_babel import lazy_gettext as _ +from marshmallow import Schema, fields +from sqlalchemy.engine.interfaces import Dialect +from sqlalchemy.sql import text +from sqlalchemy.types import TypeEngine +from superset.db_engine_specs.base import ( + BaseEngineSpec, + BasicParametersMixin, + BasicParametersType, + TimeGrain, + builtin_time_grains, +) +from superset.utils import core as utils +from superset.utils.core import GenericDataType + +from questdb_connect import remove_public_schema, types +from questdb_connect.dialect import connection_uri +from questdb_connect.function_names import FUNCTION_NAMES + +# Apache Superset requires a Python DB-API database driver, and a SQLAlchemy dialect +# https://superset.apache.org/docs/databases/installing-database-drivers +# https://preset.io/blog/building-database-connector/ +# https://preset.io/blog/improving-apache-superset-integration-database-sqlalchemy/ + + +class QDBParametersSchema(Schema): + username = fields.String(allow_none=True, description=__('user')) + password = fields.String(allow_none=True, description=__('password')) + host = fields.String(required=True, description=__('host')) + port = fields.Integer(allow_none=True, description=__('port')) + database = fields.String(allow_none=True, description=__('database')) + + +class QDBEngineSpec(BaseEngineSpec, BasicParametersMixin): + engine = 'questdb' + engine_name = 'QuestDB Connect' + default_driver = "psycopg2" + encryption_parameters = {"sslmode": "prefer"} + sqlalchemy_uri_placeholder = "questdb://user:password@host:port/database" + parameters_schema = QDBParametersSchema() + time_groupby_inline = False + allows_hidden_cc_in_orderby = True + time_secondary_columns = True + try_remove_schema_from_table_name = True + max_column_name_length = 120 + supports_dynamic_schema = False + top_keywords = {} + # https://en.wikipedia.org/wiki/ISO_8601#Durations + # https://questdb.io/docs/reference/function/date-time/#date_trunc + _time_grain_expressions = { + None: '{col}', + "PT1S": "date_trunc('second', {col})", + "PT5S": "date_trunc('second', {col}) + 5000000L", + "PT30S": "date_trunc('second', {col}) + 30000000L", + "PT1M": "date_trunc('minute', {col})", + "PT5M": "date_trunc('minute', {col}) + 300000000L", + "PT10M": "date_trunc('minute', {col}) + 600000000L", + "PT15M": "date_trunc('minute', {col}) + 900000000L", + "PT30M": "date_trunc('minute', {col}) + 1800000000L", + "PT1H": "date_trunc('hour', {col})", + "PT6H": "date_trunc('hour', {col}) + 21600000000L", + "P1D": "date_trunc('day', {col})", + "P1W": "date_trunc('week', {col})", + "P1M": "date_trunc('month', {col})", + "P1Y": "date_trunc('year', {col})", + "P3M": "date_trunc('quarter', {col})", + } + ret_list = [] + for duration, func in _time_grain_expressions.items(): + if duration: + name = builtin_time_grains[duration] + ret_list.append(TimeGrain(name, _(name), func, duration)) + _engine_time_grains = tuple(ret_list) + _default_column_type_mappings = ( + (re.compile("^LONG256", re.IGNORECASE), types.Long256, GenericDataType.STRING), + (re.compile("^BOOLEAN", re.IGNORECASE), types.Boolean, GenericDataType.BOOLEAN), + (re.compile("^BYTE", re.IGNORECASE), types.Byte, GenericDataType.BOOLEAN), + (re.compile("^SHORT", re.IGNORECASE), types.Short, GenericDataType.NUMERIC), + (re.compile("^INT", re.IGNORECASE), types.Int, GenericDataType.NUMERIC), Review Comment: I believe most of these are redundant, as they're covered by the defaults in `BaseEngineSpec`. So you may want to consider only implementing whichever types are only specific to QuestDB. ########## superset/db_engine_specs/questdb.py: ########## @@ -0,0 +1,311 @@ +# 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 re +from datetime import datetime +from typing import Any, Dict, List, Optional, Tuple + +from flask_babel import gettext as __ +from flask_babel import lazy_gettext as _ +from marshmallow import Schema, fields +from sqlalchemy.engine.interfaces import Dialect +from sqlalchemy.sql import text +from sqlalchemy.types import TypeEngine +from superset.db_engine_specs.base import ( + BaseEngineSpec, + BasicParametersMixin, + BasicParametersType, + TimeGrain, + builtin_time_grains, +) +from superset.utils import core as utils +from superset.utils.core import GenericDataType + +from questdb_connect import remove_public_schema, types +from questdb_connect.dialect import connection_uri +from questdb_connect.function_names import FUNCTION_NAMES + +# Apache Superset requires a Python DB-API database driver, and a SQLAlchemy dialect +# https://superset.apache.org/docs/databases/installing-database-drivers +# https://preset.io/blog/building-database-connector/ +# https://preset.io/blog/improving-apache-superset-integration-database-sqlalchemy/ + + +class QDBParametersSchema(Schema): + username = fields.String(allow_none=True, description=__('user')) + password = fields.String(allow_none=True, description=__('password')) + host = fields.String(required=True, description=__('host')) + port = fields.Integer(allow_none=True, description=__('port')) + database = fields.String(allow_none=True, description=__('database')) + + +class QDBEngineSpec(BaseEngineSpec, BasicParametersMixin): + engine = 'questdb' + engine_name = 'QuestDB Connect' + default_driver = "psycopg2" + encryption_parameters = {"sslmode": "prefer"} + sqlalchemy_uri_placeholder = "questdb://user:password@host:port/database" + parameters_schema = QDBParametersSchema() + time_groupby_inline = False + allows_hidden_cc_in_orderby = True + time_secondary_columns = True + try_remove_schema_from_table_name = True + max_column_name_length = 120 + supports_dynamic_schema = False + top_keywords = {} + # https://en.wikipedia.org/wiki/ISO_8601#Durations + # https://questdb.io/docs/reference/function/date-time/#date_trunc + _time_grain_expressions = { + None: '{col}', + "PT1S": "date_trunc('second', {col})", + "PT5S": "date_trunc('second', {col}) + 5000000L", + "PT30S": "date_trunc('second', {col}) + 30000000L", + "PT1M": "date_trunc('minute', {col})", + "PT5M": "date_trunc('minute', {col}) + 300000000L", + "PT10M": "date_trunc('minute', {col}) + 600000000L", + "PT15M": "date_trunc('minute', {col}) + 900000000L", + "PT30M": "date_trunc('minute', {col}) + 1800000000L", + "PT1H": "date_trunc('hour', {col})", + "PT6H": "date_trunc('hour', {col}) + 21600000000L", + "P1D": "date_trunc('day', {col})", + "P1W": "date_trunc('week', {col})", + "P1M": "date_trunc('month', {col})", + "P1Y": "date_trunc('year', {col})", + "P3M": "date_trunc('quarter', {col})", + } + ret_list = [] + for duration, func in _time_grain_expressions.items(): + if duration: + name = builtin_time_grains[duration] + ret_list.append(TimeGrain(name, _(name), func, duration)) + _engine_time_grains = tuple(ret_list) + _default_column_type_mappings = ( + (re.compile("^LONG256", re.IGNORECASE), types.Long256, GenericDataType.STRING), + (re.compile("^BOOLEAN", re.IGNORECASE), types.Boolean, GenericDataType.BOOLEAN), + (re.compile("^BYTE", re.IGNORECASE), types.Byte, GenericDataType.BOOLEAN), + (re.compile("^SHORT", re.IGNORECASE), types.Short, GenericDataType.NUMERIC), + (re.compile("^INT", re.IGNORECASE), types.Int, GenericDataType.NUMERIC), + (re.compile("^LONG", re.IGNORECASE), types.Long, GenericDataType.NUMERIC), + (re.compile("^FLOAT", re.IGNORECASE), types.Float, GenericDataType.NUMERIC), + (re.compile("^DOUBLE'", re.IGNORECASE), types.Double, GenericDataType.NUMERIC), + (re.compile("^SYMBOL", re.IGNORECASE), types.Symbol, GenericDataType.STRING), + (re.compile("^STRING", re.IGNORECASE), types.String, GenericDataType.STRING), + (re.compile("^UUID", re.IGNORECASE), types.UUID, GenericDataType.STRING), + (re.compile("^CHAR", re.IGNORECASE), types.Char, GenericDataType.STRING), + (re.compile("^TIMESTAMP", re.IGNORECASE), types.Timestamp, GenericDataType.TEMPORAL), + (re.compile("^DATE", re.IGNORECASE), types.Date, GenericDataType.TEMPORAL), + (re.compile(r"^GEOHASH\(\d+[b|c]\)", re.IGNORECASE), types.GeohashLong, GenericDataType.STRING) + ) + column_type_mappings = _default_column_type_mappings + + @classmethod + def build_sqlalchemy_uri( + cls, + parameters: BasicParametersType, + encrypted_extra: Optional[Dict[str, str]] = None + ) -> str: + return connection_uri( + parameters.get("host"), + int(parameters.get("port")), + parameters.get("username"), + parameters.get("password"), + parameters.get("database")) + + @classmethod + def get_default_schema_for_query(cls, database, query) -> Optional[str]: + return 'public' + + @classmethod + def get_text_clause(cls, clause): + """SQLAlchemy wrapper to ensure text clauses are escaped properly + :param clause: string clause with potentially unescaped characters + :return: text clause with escaped characters + """ + if cls.allows_escaped_colons: + clause = clause.replace(":", "\\:") + return text(remove_public_schema(clause)) + + @classmethod + def get_time_grain_expressions(cls) -> Dict[Optional[str], str]: + """Return a dict of all supported time grains including any + potential added grains but excluding any potentially disabled + grains in the config file. + :return: All time grain expressions supported by the engine + """ + return cls._time_grain_expressions + + @classmethod + def epoch_to_dttm(cls) -> str: + """SQL expression that converts epoch (seconds) to datetime that can be used in a + query. The reference column should be denoted as `{col}` in the return + expression, e.g. "FROM_UNIXTIME({col})" + :return: SQL Expression + """ + return '{col} * 1000000' + + @classmethod + def convert_dttm(cls, target_type: str, dttm: datetime, *_args, **_kwargs) -> Optional[str]: + """Convert a Python `datetime` object to a SQL expression. + :param target_type: The target type of expression + :param dttm: The datetime object + :return: The SQL expression + """ + type_u = target_type.upper() + if type_u == 'DATE': + return f"TO_DATE('{dttm.date().isoformat()}', 'YYYY-MM-DD')" + if type_u in ('DATETIME', 'TIMESTAMP'): + dttm_formatted = dttm.isoformat(sep=" ", timespec="microseconds") + return f"TO_TIMESTAMP('{dttm_formatted}', 'yyyy-MM-ddTHH:mm:ss.SSSUUUZ')" + return None + + @classmethod + def get_datatype(cls, type_code: Any) -> Optional[str]: + """Change column type code from cursor description to string representation. + :param type_code: Type code from cursor description + :return: String representation of type code + """ + return type_code.upper() if type_code and isinstance(type_code, str) else str(type_code) + + @classmethod + def get_time_grains(cls) -> Tuple[TimeGrain, ...]: + """Generate a tuple of supported time grains. + :return: All time grains supported by the engine + """ + return cls._engine_time_grains + + @classmethod + def get_column_types( + cls, + column_type: Optional[str], + ) -> Optional[Tuple[TypeEngine, GenericDataType]]: + """Return a sqlalchemy native column type and generic data type that + corresponds to the column type defined in the data source (return None + to use default type inferred by SQLAlchemy). Override `column_type_mappings` + for specific needs (see MSSQL for example of NCHAR/NVARCHAR handling). + :param column_type: Column type returned by inspector + :return: SQLAlchemy and generic Superset column types + """ + if not column_type: + return None + for regex, sqla_type, generic_type in cls._default_column_type_mappings: + matching_name = regex.search(column_type) + if matching_name: + return ( + types.resolve_type_from_name(sqla_type.__visit_name__).impl, + generic_type + ) + return None Review Comment: and here -- 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]
