Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add week time grain for Elasticsearch datasets #25683

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions superset/db_engine_specs/elasticsearch.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ class ElasticSearchEngineSpec(BaseEngineSpec): # pylint: disable=abstract-metho
TimeGrain.MINUTE: "HISTOGRAM({col}, INTERVAL 1 MINUTE)",
TimeGrain.HOUR: "HISTOGRAM({col}, INTERVAL 1 HOUR)",
TimeGrain.DAY: "HISTOGRAM({col}, INTERVAL 1 DAY)",
TimeGrain.WEEK: "DATE_TRUNC('week', {col})",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we using DATE_TRUNC and not HISTOGRAM? Ideally it would be great if these were consistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The HISTOGRAM groups the data by INTERVAL but there is no "week" interval in Elasticsearch.

Perhaps there is a refactor needed to use DATE_TRUNC for the other time grains as well? I could do it, but as I am new to this community, could you let me know if I should do it in this PR or open a separate one for refactoring? 😄

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikelv92 thanks for the explanation. I think it's ok to merge this PR as is, but if you're interested in doing a fast follow to change all the existing time grains to use DATE_TRUNC—which seems to be the blessed option—that would be great.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@john-bodley Here is the follow-up PR: #25717

TimeGrain.MONTH: "HISTOGRAM({col}, INTERVAL 1 MONTH)",
TimeGrain.YEAR: "HISTOGRAM({col}, INTERVAL 1 YEAR)",
}
Expand Down
54 changes: 54 additions & 0 deletions tests/integration_tests/db_engine_specs/elasticsearch_tests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Licensed to the Apache Software Foundation (ASF) under one
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woot! Thanks for adding a test.

# 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 sqlalchemy import column

from superset.db_engine_specs.elasticsearch import ElasticSearchEngineSpec
from tests.integration_tests.db_engine_specs.base_tests import TestDbEngineSpec


class TestElasticsearchDbEngineSpec(TestDbEngineSpec):
def test_timegrain_week_expression(self):
"""
mikelv92 marked this conversation as resolved.
Show resolved Hide resolved
DB Eng Specs (elasticsearch): Test time grain expressions
"""
col = column("ts")
test_cases = {
mikelv92 marked this conversation as resolved.
Show resolved Hide resolved
"date": "DATE_TRUNC('week', ts)",
"date_nanos": "DATE_TRUNC('week', ts)",
}
for type_, expected in test_cases.items():
col.type = type_
actual = ElasticSearchEngineSpec.get_timestamp_expr(
col=col, pdf=None, time_grain="P1W"
)
self.assertEqual(str(actual), expected)

def test_timegrain_hour_expression(self):
"""
DB Eng Specs (elasticsearch): Test time grain expressions
"""
col = column("ts")
test_cases = {
"date": "HISTOGRAM(ts, INTERVAL 1 HOUR)",
"date_nanos": "HISTOGRAM(ts, INTERVAL 1 HOUR)",
}
for type_, expected in test_cases.items():
col.type = type_
actual = ElasticSearchEngineSpec.get_timestamp_expr(
col=col, pdf=None, time_grain="PT1H"
)
self.assertEqual(str(actual), expected)