Add firebird query runner

Dockerfile

@@ -67,7 +67,7 @@ RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
  curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor -o /usr/share/keyrings/microsoft-prod.gpg \
  && curl https://packages.microsoft.com/config/debian/12/prod.list > /etc/apt/sources.list.d/mssql-release.list \
  && apt-get update \
- && ACCEPT_EULA=Y apt-get install -y --no-install-recommends msodbcsql17 \
+ && ACCEPT_EULA=Y apt-get install -y --no-install-recommends msodbcsql17 libtommath1 \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/* \
  && curl "$databricks_odbc_driver_url" --location --output /tmp/simba_odbc.zip \
@@ -76,7 +76,19 @@ RUN if [ "$TARGETPLATFORM" = "linux/amd64" ]; then \
  && dpkg -i /tmp/simba/*.deb \
  && printf "[Simba]\nDriver = /opt/simba/spark/lib/64/libsparkodbc_sb64.so" >> /etc/odbcinst.ini \
  && rm /tmp/simba_odbc.zip \
- && rm -rf /tmp/simba; fi
+ && rm -rf /tmp/simba; fi \
+ && curl "https://github.com/FirebirdSQL/firebird/releases/download/v5.0.0/Firebird-5.0.0.1306-0-linux-x64.tar.gz" --location --output /tmp/firebird.tar.gz \
+ && mkdir /tmp/firebird \
+ && tar -xvf /tmp/firebird.tar.gz --directory /tmp/firebird \
+ && mkdir /tmp/firebird/buildroot \
+ && tar -xvf /tmp/firebird/Firebird-*/buildroot.tar.gz --directory /tmp/firebird/buildroot \
+ && cp /tmp/firebird/buildroot/opt/firebird/lib/libfbclient.so /usr/lib/libfbclient.so.2 \
+ && ln -s /usr/lib/libfbclient.so.2 /usr/lib/libfbclient.so \
+ && cp /tmp/firebird/buildroot/opt/firebird/lib/libtomcrypt.so /usr/lib/libtomcrypt.so.1 \
+ && ln -s /usr/lib/libtomcrypt.so.1 /usr/lib/libtomcrypt.so \
+ && rm /tmp/firebird.tar.gz \
+ && rm -rf /tmp/firebird \
+ && ln -s /usr/lib/x86_64-linux-gnu/libtommath.so.1 /usr/lib/x86_64-linux-gnu/libtommath.so.0
 
 WORKDIR /app
 

README.md

@@ -51,6 +51,7 @@ Redash supports more than 35 SQL and NoSQL [data sources](https://redash.io/help
 - Elasticsearch
 - Exasol
 - Microsoft Excel
+- Firebird
 - Firebolt
 - Databend
 - Google Analytics

pyproject.toml

@@ -85,6 +85,7 @@ werkzeug = "2.3.8"
 wtforms = "2.2.1"
 xlsxwriter = "1.2.2"
 tzlocal = "4.3.1"
+fdb = "^2.0.2"
 
 [tool.poetry.group.all_ds]
 optional = true

redash/query_runner/firebird.py

@@ -0,0 +1,152 @@
+import datetime
+import logging
+
+from redash.query_runner import (
+ TYPE_DATE,
+ TYPE_DATETIME,
+ TYPE_FLOAT,
+ TYPE_INTEGER,
+ TYPE_STRING,
+ BaseSQLQueryRunner,
+ JobTimeoutException,
+ register,
+)
+
+logger = logging.getLogger(__name__)
+
+try:
+ import fdb
+
+ enabled = True
+except ImportError:
+ enabled = False
+
+types_map = {
+ str: TYPE_STRING,
+ int: TYPE_INTEGER,
+ float: TYPE_FLOAT,
+ datetime.date: TYPE_DATE,
+ datetime.datetime: TYPE_DATETIME,
+}
+
+
+class firebird(BaseSQLQueryRunner):
+ noop_query = "SELECT 1 FROM RDB$DATABASE;"
+
+ limit_query = " FIRST 1000"
+ limit_keywords = ["FIRST"]
+ limit_after_select = True
+
+ @classmethod
+ def configuration_schema(cls):
+ return {
+ "type": "object",
+ "properties": {
+ "user": {"type": "string"},
+ "password": {"type": "string"},
+ "server": {"type": "string", "default": "127.0.0.1"},
+ "port": {"type": "number", "default": 3050},
+ "charset": {
+ "type": "string",
+ "default": "UTF-8",
+ "title": "Character Set",
+ },
+ "db": {"type": "string", "title": "Database Name"},
+ },
+ "required": ["db"],
+ "secret": ["password"],
+ }
+
+ @classmethod
+ def enabled(cls):
+ return enabled
+
+ @classmethod
+ def name(cls):
+ return "Firebird"
+
+ @classmethod
+ def type(cls):
+ return "firebird"
+
+ def _get_tables(self, schema):
+ query = """
+ SELECT TRIM(f.rdb$relation_name) AS table_name
+ ,TRIM(f.rdb$field_name) AS column_name
+ FROM rdb$relation_fields f
+ JOIN rdb$relations r ON f.rdb$relation_name = r.rdb$relation_name
+ AND r.rdb$view_blr IS NULL
+ AND (r.rdb$system_flag IS NULL OR r.rdb$system_flag = 0)
+ ORDER BY 1, f.rdb$field_position;
+ """
+
+ results, error = self.run_query(query, None)
+
+ if error is not None:
+ self._handle_run_query_error(error)
+
+ for row in results["rows"]:
+ table_name = row["TABLE_NAME"]
+
+ if table_name not in schema:
+ schema[table_name] = {"name": table_name, "columns": []}
+
+ schema[table_name]["columns"].append(row["COLUMN_NAME"])
+
+ return list(schema.values())
+
+ def run_query(self, query, user):
+ connection = None
+
+ try:
+ server = self.configuration.get("server", "")
+ user = self.configuration.get("user", "")
+ password = self.configuration.get("password", "")
+ db = self.configuration["db"]
+ port = self.configuration.get("port", 3050)
+ charset = self.configuration.get("charset", "UTF-8")
+
+ if port != 3050:
+ server = server + "/" + str(port)
+
+ connection = fdb.connect(
+ database=f"{server}:{db}",
+ user=user,
+ password=password,
+ charset=charset,
+ )
+
+ if isinstance(query, str):
+ query = query.encode(charset)
+
+ cursor = connection.cursor()
+
+ cursor.execute(query)
+ data = cursor.fetchall()
+
+ if cursor.description is not None:
+ columns = self.fetch_columns([(i[0], types_map.get(i[1], None)) for i in cursor.description])
+ rows = [dict(zip((column["name"] for column in columns), row)) for row in data]
+
+ data = {"columns": columns, "rows": rows}
+ error = None
+ else:
+ error = "No data was returned."
+ data = None
+
+ cursor.close()
+ connection.commit()
+ except fdb.Error as e:
+ error = e.args[0]
+ data = None
+ except (KeyboardInterrupt, JobTimeoutException):
+ connection.cancel()
+ raise
+ finally:
+ if connection:
+ connection.close()
+
+ return data, error
+
+
+register(firebird)

redash/settings/__init__.py

@@ -339,6 +339,7 @@ def email_server_is_configured():
  "redash.query_runner.ignite",
  "redash.query_runner.oracle",
  "redash.query_runner.e6data",
+ "redash.query_runner.firebird",
 ]
 
 enabled_query_runners = array_from_string(