Add QuestDB Tool to Kindling (#314)

ia-beklund · Joshlha · paul-griffith · web-flow · commit 63627fbe9610 · 2025-10-01T15:38:53.000-07:00
Co-authored-by: Joshua Hansen &lt;joshlha16@gmail.com&gt;
Co-authored-by: Paul Griffith &lt;pgriffith@inductiveautomation.com&gt;
diff --git a/NOTICES b/NOTICES
@@ -28,3 +28,5 @@ This repository incorporates material as listed below or described in the code.
 
 ### Assets
 - BoxIcons - MIT License - https://boxicons.com/usage#license
+- QuestDB - CC by SA 4.0 - https://en.wikipedia.org/wiki/File:Questdb-logo.svg
+    - Modifications: Monochrome version of original, redistributed CC-by-SA
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -33,10 +33,10 @@ dependencies {
         isTransitive = false
     }
     api(libs.jfreechart)
+    api(libs.questdb)
     api(libs.rsyntaxtextarea)
     api(libs.bundles.jackson)
     runtimeOnly(libs.bundles.ia.transitive)
-
     testImplementation(libs.bundles.kotest)
 }
 
@@ -103,6 +103,11 @@ kotlin {
             resources.srcDir(javadocDirectory)
         }
     }
+    compilerOptions {
+        freeCompilerArgs.addAll(
+            "-Xcontext-parameters",
+        )
+    }
 }
 
 spotless {
diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,4 @@
 version=1.4.1-SNAPSHOT
 org.gradle.jvmargs=-Xmx2G
 org.gradle.caching=true
+
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -60,6 +60,9 @@ ia-jython = { module = "org.python:jython-ia", version = "2.7.3.5" }
 kotest-junit = { group = "io.kotest", name = "kotest-runner-junit5", version.ref = "kotest" }
 kotest-assertions-core = { group = "io.kotest", name = "kotest-assertions-core", version.ref = "kotest" }
 
+# questdb
+questdb = { module = "org.questdb:questdb", version = "9.0.3" }
+
 [bundles]
 coroutines = [
     "coroutines-core",
diff --git a/readme.md b/readme.md
@@ -27,6 +27,10 @@ Has special handling for:
 - Images in the configuration DB
 - Tag configuration data
 
+### QuestDB Viewer
+
+Opens a QuestDB zip archive (such as a backup of the Core Historian's data) in a generic SQL exploration view.
+
 ### Log Viewer
 
 Open one (or multiple) wrapper.log files. If the output format is Ignition's default, they will be automatically parsed
@@ -117,6 +121,7 @@ Contributions of any kind (additional tools, polish to existing tools, test file
 - [SerializationDumper](https://github.com/NickstaDB/SerializationDumper)
 - [Hydraulic Conveyor](https://www.hydraulic.software/)
 - [Terai Atsuhiro](https://java-swing-tips.blogspot.com/)
+- [Bsmth](https://bsky.app/profile/bsmth.de) for their original [Quest DB Logo](https://en.wikipedia.org/wiki/File:Questdb-logo.svg)
 
 > [!WARNING]
 > Kindling is **not** an official Inductive Automation product and is provided as-is with no warranty. 
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/MainPanel.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/MainPanel.kt
@@ -144,7 +144,7 @@ class MainPanel : JPanel(MigLayout("ins 6, fill, hidemode 3")) {
                 putClientProperty("FlatLaf.styleClass", "h1")
             },
         )
-        for (tools in Tool.sortedByTitle.filterNot { it.isAdvanced }.chunked(3)) {
+        for (tools in Tool.sortedByTitle.filterNot { it.isAdvanced }.chunked(4)) {
             add(toolTile(tools[0]), "sg tile, h 200!, newline, split, gaptop 20")
             for (tool in tools.drop(1)) {
                 add(toolTile(tool), "sg tile, gap 20 0 20 0")
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/cache/CacheView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/cache/CacheView.kt
@@ -277,7 +277,6 @@ class CacheView(path: Path) : ToolPanel() {
 
         add(JLabel("${data.size} ${if (data.size == 1) "entry" else "entries"}"))
         add(settings, "right, wrap")
-
         add(mainSplitPane, "push, grow, span")
 
         schemaList.selectionModel.addListSelectionListener {
@@ -341,7 +340,7 @@ data object CacheViewer : Tool {
     override val serialKey = "sf-cache"
     override val title = "Store & Forward Cache"
     override val description = "S&F Cache (.data, .script, .zip)"
-    override val icon = FlatSVGIcon("icons/bx-data.svg")
+    override val icon = FlatSVGIcon("icons/bx-hdd.svg")
     internal val extensions = arrayOf("data", "script", "zip")
     override val filter = FileFilter(description, *extensions)
 
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/Tool.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/Tool.kt
@@ -7,6 +7,7 @@ import io.github.inductiveautomation.kindling.gatewaynetwork.GatewayNetworkTool
 import io.github.inductiveautomation.kindling.idb.IdbViewer
 import io.github.inductiveautomation.kindling.localization.TranslationTool
 import io.github.inductiveautomation.kindling.log.LogViewer
+import io.github.inductiveautomation.kindling.quest.QuestDbViewer
 import io.github.inductiveautomation.kindling.serial.SerialViewer
 import io.github.inductiveautomation.kindling.thread.MultiThreadViewer
 import io.github.inductiveautomation.kindling.utils.FileFilter
@@ -53,16 +54,17 @@ interface Tool : KindlingSerializable {
     companion object {
         val tools: List<Tool> by lazy {
             listOf(
-                ZipViewer,
-                MultiThreadViewer,
-                LogViewer,
-                IdbViewer,
+                AlarmViewer,
                 CacheViewer,
                 GatewayNetworkTool,
-                AlarmViewer,
-                XmlTool,
+                IdbViewer,
+                LogViewer,
+                MultiThreadViewer,
+                QuestDbViewer,
                 SerialViewer,
                 TranslationTool,
+                XmlTool,
+                ZipViewer,
             )
         }
 
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/Column.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/Column.kt
@@ -1,4 +1,4 @@
-package io.github.inductiveautomation.kindling.idb.generic
+package io.github.inductiveautomation.kindling.core.db
 
 import java.util.Collections
 import java.util.Enumeration
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/DBMetaDataTree.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/DBMetaDataTree.kt
@@ -1,4 +1,4 @@
-package io.github.inductiveautomation.kindling.idb.generic
+package io.github.inductiveautomation.kindling.core.db
 
 import com.formdev.flatlaf.extras.components.FlatTree
 import com.jidesoft.swing.TreeSearchable
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/QueryResult.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/QueryResult.kt
@@ -1,4 +1,4 @@
-package io.github.inductiveautomation.kindling.idb.generic
+package io.github.inductiveautomation.kindling.core.db
 
 import javax.swing.table.AbstractTableModel
 
@@ -7,7 +7,8 @@ sealed interface QueryResult {
         val columnNames: List<String>,
         private val columnTypes: List<Class<*>>,
         val data: List<List<*>>,
-    ) : QueryResult, AbstractTableModel() {
+    ) : AbstractTableModel(),
+        QueryResult {
         constructor() : this(emptyList(), emptyList(), emptyList())
 
         init {
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/ResultsPanel.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/ResultsPanel.kt
@@ -1,4 +1,4 @@
-package io.github.inductiveautomation.kindling.idb.generic
+package io.github.inductiveautomation.kindling.core.db
 
 import com.formdev.flatlaf.extras.FlatSVGIcon
 import com.inductiveautomation.ignition.common.util.csv.CSVWriter
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/SortableTree.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/SortableTree.kt
@@ -0,0 +1,106 @@
+package io.github.inductiveautomation.kindling.core.db
+
+import com.formdev.flatlaf.extras.FlatSVGIcon
+import com.jidesoft.comparator.AlphanumComparator
+import io.github.inductiveautomation.kindling.utils.Action
+import io.github.inductiveautomation.kindling.utils.ButtonPanel
+import io.github.inductiveautomation.kindling.utils.FlatActionIcon
+import io.github.inductiveautomation.kindling.utils.FlatScrollPane
+import java.util.Collections
+import java.util.Enumeration
+import javax.swing.ButtonGroup
+import javax.swing.JToggleButton
+import javax.swing.tree.DefaultTreeModel
+import javax.swing.tree.TreeNode
+import kotlin.collections.indexOf
+
+enum class TableComparator(
+    val tooltip: String,
+    val icon: FlatSVGIcon,
+    val comparator: Comparator<Table>,
+) : Comparator<Table> by comparator {
+    ByNameAscending(
+        tooltip = "Sort A-Z",
+        icon = FlatActionIcon("icons/bx-sort-a-z.svg"),
+        comparator = compareBy(nullsFirst(AlphanumComparator(false))) { it.name },
+    ),
+    ByNameDescending(
+        tooltip = "Sort Z-A",
+        icon = FlatActionIcon("icons/bx-sort-z-a.svg"),
+        comparator = ByNameAscending.reversed(),
+    ),
+    BySizeAscending(
+        tooltip = "Sort by Size",
+        icon = FlatActionIcon("icons/bx-sort-up.svg"),
+        comparator = compareBy(Table::size),
+    ),
+    BySizeDescending(
+        tooltip = "Sort by Size (descending)",
+        icon = FlatActionIcon("icons/bx-sort-down.svg"),
+        comparator = BySizeAscending.reversed(),
+    ),
+}
+
+class SortableTree(val tables: List<Table>) {
+    var comparator = TableComparator.BySizeDescending
+        set(value) {
+            field = value
+            root = sortedTreeNode()
+            tree.model = DefaultTreeModel(root)
+        }
+
+    private fun sortedTreeNode() = object : TreeNode {
+        private val sortedTables = tables.sortedWith(comparator)
+
+        override fun getChildAt(childIndex: Int): TreeNode = sortedTables[childIndex]
+        override fun getChildCount(): Int = sortedTables.size
+        override fun getIndex(node: TreeNode): Int = sortedTables.indexOf(node)
+        override fun children(): Enumeration<out TreeNode> = Collections.enumeration(sortedTables)
+        override fun getParent(): TreeNode? = null
+        override fun getAllowsChildren(): Boolean = true
+        override fun isLeaf(): Boolean = false
+    }
+
+    var root: TreeNode = sortedTreeNode()
+
+    val tree = DBMetaDataTree(DefaultTreeModel(root))
+
+    private val sortActions: List<SortAction> = TableComparator.entries.map { tableComparator ->
+        SortAction(tableComparator)
+    }
+
+    inner class SortAction(comparator: TableComparator) :
+        Action(
+            description = comparator.tooltip,
+            icon = comparator.icon,
+            selected = this@SortableTree.comparator == comparator,
+            action = {
+                this@SortableTree.comparator = comparator
+                selected = true
+            },
+        ) {
+        var comparator: TableComparator by actionValue("tableComparator", comparator)
+    }
+
+    private fun createSortButtons(): ButtonGroup = ButtonGroup().apply {
+        for (sortAction in sortActions) {
+            add(
+                JToggleButton(
+                    Action(
+                        description = sortAction.description,
+                        icon = sortAction.icon,
+                        selected = sortAction.selected,
+                    ) { e ->
+                        sortAction.actionPerformed(e)
+                    },
+                ),
+            )
+        }
+    }
+
+    private val sortButtons = createSortButtons()
+
+    val component = ButtonPanel(sortButtons).apply {
+        add(FlatScrollPane(tree), "newline, push, grow")
+    }
+}
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/Table.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/core/db/Table.kt
@@ -1,4 +1,4 @@
-package io.github.inductiveautomation.kindling.idb.generic
+package io.github.inductiveautomation.kindling.core.db
 
 import java.util.Collections
 import java.util.Enumeration
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/idb/IdbView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/idb/IdbView.kt
@@ -128,7 +128,7 @@ data object IdbViewer : MultiTool {
     override val serialKey = "idb-viewer"
     override val title = "SQLite Database"
     override val description = "SQLite Database (.idb)"
-    override val icon = FlatSVGIcon("icons/bx-hdd.svg")
+    override val icon = FlatSVGIcon("icons/bx-data.svg")
     override val filter = FileFilter(description, "idb", "db", "sqlite")
 
     override fun open(path: Path): ToolPanel = IdbView(listOf(path))
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/idb/generic/GenericView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/idb/generic/GenericView.kt
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/quest/QuestDbView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/quest/QuestDbView.kt
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/quest/Utils.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/quest/Utils.kt
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/thread/comparison/ThreadDiffView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/thread/comparison/ThreadDiffView.kt
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/utils/Components.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/utils/Components.kt
diff --git a/src/main/kotlin/io/github/inductiveautomation/kindling/zip/views/FileView.kt b/src/main/kotlin/io/github/inductiveautomation/kindling/zip/views/FileView.kt
diff --git a/src/main/resources/icons/Questdb-logo.svg b/src/main/resources/icons/Questdb-logo.svg

Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,10 @@ dependencies {`
`33`	`33`	`isTransitive = false`
`34`	`34`	`}`
`35`	`35`	`api(libs.jfreechart)`
	`36`	`+ api(libs.questdb)`
`36`	`37`	`api(libs.rsyntaxtextarea)`
`37`	`38`	`api(libs.bundles.jackson)`
`38`	`39`	`runtimeOnly(libs.bundles.ia.transitive)`
`39`		`-`
`40`	`40`	`testImplementation(libs.bundles.kotest)`
`41`	`41`	`}`
`42`	`42`
`@@ -103,6 +103,11 @@ kotlin {`
`103`	`103`	`resources.srcDir(javadocDirectory)`
`104`	`104`	`}`
`105`	`105`	`}`
	`106`	`+ compilerOptions {`
	`107`	`+ freeCompilerArgs.addAll(`
	`108`	`+ "-Xcontext-parameters",`
	`109`	`+ )`
	`110`	`+ }`
`106`	`111`	`}`
`107`	`112`
`108`	`113`	`spotless {`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ class MainPanel : JPanel(MigLayout("ins 6, fill, hidemode 3")) {`
`144`	`144`	`putClientProperty("FlatLaf.styleClass", "h1")`
`145`	`145`	`},`
`146`	`146`	`)`
`147`		`- for (tools in Tool.sortedByTitle.filterNot { it.isAdvanced }.chunked(3)) {`
	`147`	`+ for (tools in Tool.sortedByTitle.filterNot { it.isAdvanced }.chunked(4)) {`
`148`	`148`	`add(toolTile(tools[0]), "sg tile, h 200!, newline, split, gaptop 20")`
`149`	`149`	`for (tool in tools.drop(1)) {`
`150`	`150`	`add(toolTile(tool), "sg tile, gap 20 0 20 0")`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package io.github.inductiveautomation.kindling.idb.generic`
	`1`	`+package io.github.inductiveautomation.kindling.core.db`
`2`	`2`
`3`	`3`	`import java.util.Collections`
`4`	`4`	`import java.util.Enumeration`