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

Add column type to a query result of InfluxDB #6505

Merged
merged 6 commits into from
Oct 8, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
38 changes: 30 additions & 8 deletions redash/query_runner/influx_db.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import logging

from redash.query_runner import BaseQueryRunner, register
from redash.query_runner import (
TYPE_FLOAT,
TYPE_INTEGER,
TYPE_STRING,
BaseQueryRunner,
register,
)
from redash.utils import json_dumps

logger = logging.getLogger(__name__)
Expand All @@ -14,25 +20,36 @@
enabled = False


TYPES_MAP = {
str: TYPE_STRING,
int: TYPE_INTEGER,
float: TYPE_FLOAT,
}


def _get_type(value):
return TYPES_MAP.get(type(value), TYPE_STRING)


def _transform_result(results):
result_columns = []
column_names = []
result_rows = []

for result in results:
for series in result.raw.get("series", []):
for column in series["columns"]:
if column not in result_columns:
result_columns.append(column)
if column not in column_names:
column_names.append(column)
tags = series.get("tags", {})
for key in tags.keys():
if key not in result_columns:
result_columns.append(key)
if key not in column_names:
column_names.append(key)

for result in results:
for series in result.raw.get("series", []):
for point in series["values"]:
result_row = {}
for column in result_columns:
for column in column_names:
tags = series.get("tags", {})
if column in tags:
result_row[column] = tags[column]
Expand All @@ -42,7 +59,12 @@ def _transform_result(results):
result_row[column] = value
result_rows.append(result_row)

return json_dumps({"columns": [{"name": c} for c in result_columns], "rows": result_rows})
if len(result_rows) > 0:
result_columns = [{"name": c, "type": _get_type(result_rows[0][c])} for c in result_rows[0].keys()]
else:
result_columns = [{"name": c, "type": TYPE_STRING} for c in column_names]

return json_dumps({"columns": result_columns, "rows": result_rows})


class InfluxDB(BaseQueryRunner):
Expand Down
59 changes: 59 additions & 0 deletions tests/query_runner/test_influx_db.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import json
from unittest import TestCase

from influxdb.resultset import ResultSet

from redash.query_runner import (
TYPE_FLOAT,
TYPE_INTEGER,
TYPE_STRING,
)
from redash.query_runner.influx_db import _transform_result

raw = {
"series": [
{
"name": "typetest",
"columns": ["time", "k1", "v1", "v2"],
"values": [
["2023-10-06T13:30:51.323358136Z", "foo", 0.5, 2],
["2023-10-06T13:31:08.882953339Z", "bar", 0.6, 4],
],
}
]
}

raw_no_rows = {"series": [{"name": "typetest", "columns": ["time", "k1", "v1", "v2"], "values": []}]}


class TestTransformResult(TestCase):
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind rewriting these as pytest tests? We want to move our codebase away from unittest.

def test_result(self):
result = ResultSet(raw)
transformed = _transform_result([result])
expected = {
"columns": [
{"name": "time", "type": TYPE_STRING},
{"name": "k1", "type": TYPE_STRING},
{"name": "v1", "type": TYPE_FLOAT},
{"name": "v2", "type": TYPE_INTEGER},
],
"rows": [
{"k1": "foo", "time": "2023-10-06T13:30:51.323358136Z", "v1": 0.5, "v2": 2},
{"k1": "bar", "time": "2023-10-06T13:31:08.882953339Z", "v1": 0.6, "v2": 4},
],
}
self.assertDictEqual(json.loads(transformed), expected)

def test_no_rows_result(self):
result = ResultSet(raw_no_rows)
transformed = _transform_result([result])
expected = {
"columns": [
{"name": "time", "type": TYPE_STRING},
{"name": "k1", "type": TYPE_STRING},
{"name": "v1", "type": TYPE_STRING},
{"name": "v2", "type": TYPE_STRING},
],
"rows": [],
}
self.assertDictEqual(json.loads(transformed), expected)