From b32de3dd9eba41dd850fafb35f24d276bd48c32f Mon Sep 17 00:00:00 2001 From: Peng Ren Date: Tue, 15 Nov 2022 12:57:04 +0800 Subject: [PATCH] feat: Add a new database driver for Amazon DynamoDB (#22077) --- setup.py | 1 + superset/db_engine_specs/dynamodb.py | 62 +++++++++++++++++++ .../db_engine_specs/test_dynamodb.py | 37 +++++++++++ 3 files changed, 100 insertions(+) create mode 100644 superset/db_engine_specs/dynamodb.py create mode 100644 tests/unit_tests/db_engine_specs/test_dynamodb.py diff --git a/setup.py b/setup.py index 5f18427f4785..fb05f2248c2f 100644 --- a/setup.py +++ b/setup.py @@ -142,6 +142,7 @@ def get_git_sha() -> str: "dremio": ["sqlalchemy-dremio>=1.1.5, <1.3"], "drill": ["sqlalchemy-drill==0.1.dev"], "druid": ["pydruid>=0.6.5,<0.7"], + "dynamodb": ["pydynamodb>=0.4.2"], "solr": ["sqlalchemy-solr >= 0.2.0"], "elasticsearch": ["elasticsearch-dbapi>=0.2.9, <0.3.0"], "exasol": ["sqlalchemy-exasol >= 2.4.0, <3.0"], diff --git a/superset/db_engine_specs/dynamodb.py b/superset/db_engine_specs/dynamodb.py new file mode 100644 index 000000000000..06dcafbb5de3 --- /dev/null +++ b/superset/db_engine_specs/dynamodb.py @@ -0,0 +1,62 @@ +# 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 + +from superset.db_engine_specs.base import BaseEngineSpec +from superset.utils import core as utils + + +class DynamoDBEngineSpec(BaseEngineSpec): + engine = "dynamodb" + engine_name = "Amazon DynamoDB" + + _time_grain_expressions = { + None: "{col}", + "PT1S": "DATETIME(STRFTIME('%Y-%m-%dT%H:%M:%S', {col}))", + "PT1M": "DATETIME(STRFTIME('%Y-%m-%dT%H:%M:00', {col}))", + "PT1H": "DATETIME(STRFTIME('%Y-%m-%dT%H:00:00', {col}))", + "P1D": "DATETIME({col}, 'start of day')", + "P1W": "DATETIME({col}, 'start of day', -strftime('%w', {col}) || ' days')", + "P1M": "DATETIME({col}, 'start of month')", + "P3M": ( + "DATETIME({col}, 'start of month', " + "printf('-%d month', (strftime('%m', {col}) - 1) % 3))" + ), + "P1Y": "DATETIME({col}, 'start of year')", + "P1W/1970-01-03T00:00:00Z": "DATETIME({col}, 'start of day', 'weekday 6')", + "P1W/1970-01-04T00:00:00Z": "DATETIME({col}, 'start of day', 'weekday 0')", + "1969-12-28T00:00:00Z/P1W": ( + "DATETIME({col}, 'start of day', 'weekday 0', '-7 days')" + ), + "1969-12-29T00:00:00Z/P1W": ( + "DATETIME({col}, 'start of day', 'weekday 1', '-7 days')" + ), + } + + @classmethod + def epoch_to_dttm(cls) -> str: + return "datetime({col}, 'unixepoch')" + + @classmethod + def convert_dttm( + cls, target_type: str, dttm: datetime, db_extra: Optional[Dict[str, Any]] = None + ) -> Optional[str]: + tt = target_type.upper() + if tt in (utils.TemporalType.TEXT, utils.TemporalType.DATETIME): + return f"""'{dttm.isoformat(sep=" ", timespec="seconds")}'""" + return None diff --git a/tests/unit_tests/db_engine_specs/test_dynamodb.py b/tests/unit_tests/db_engine_specs/test_dynamodb.py new file mode 100644 index 000000000000..bf2b555ce75e --- /dev/null +++ b/tests/unit_tests/db_engine_specs/test_dynamodb.py @@ -0,0 +1,37 @@ +# 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 tests.unit_tests.fixtures.common import dttm + + +def test_convert_dttm(dttm: datetime) -> None: + from superset.db_engine_specs.dynamodb import DynamoDBEngineSpec + + assert DynamoDBEngineSpec.convert_dttm("TEXT", dttm) == "'2019-01-02 03:04:05'" + + +def test_convert_dttm_lower(dttm: datetime) -> None: + from superset.db_engine_specs.dynamodb import DynamoDBEngineSpec + + assert DynamoDBEngineSpec.convert_dttm("text", dttm) == "'2019-01-02 03:04:05'" + + +def test_convert_dttm_invalid_type(dttm: datetime) -> None: + from superset.db_engine_specs.dynamodb import DynamoDBEngineSpec + + assert DynamoDBEngineSpec.convert_dttm("other", dttm) is None