fix(datagrid): render query results before loading table metadata (#1574)

CHANGELOG.md

@@ -32,6 +32,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Query results appear as soon as the database returns rows. Column defaults, foreign keys, and row counts now load in the background instead of holding up the grid, which removes a multi-second wait on remote databases whose system tables are slow to query. (#1574)
+- MySQL and MariaDB queries are ready to edit right away. Primary key and nullability come back with the rows, so an editable query no longer waits on a separate metadata query. (#1574)
 - Pagination and other status bar buttons no longer get blocked by the window resize zone in the bottom-right corner. (#1569)
 - VoiceOver now reads clear labels for the Columns button, Filters toggle, and loading indicators in the results status bar. (#1569)
 - The custom rows-per-page popover now points at the page-size menu instead of the center of the pagination controls. (#1569)

Plugins/MySQLDriverPlugin/MariaDBPluginConnection.swift

@@ -12,13 +12,26 @@
 import TableProPluginKit
 
 // MySQL/MariaDB field flag and charset constants
+internal let mysqlNotNullFlag: UInt = 0x0001
+internal let mysqlPriKeyFlag: UInt = 0x0002
 internal let mysqlBinaryFlag: UInt = 0x0080
 internal let mysqlEnumFlag: UInt = 0x0100
+internal let mysqlAutoIncrementFlag: UInt = 0x0200
 internal let mysqlSetFlag: UInt = 0x0800
 internal let mysqlBinaryCharset: UInt32 = 63
 
 private let logger = Logger(subsystem: "com.TablePro", category: "MariaDBPluginConnection")
 
+internal func makeColumnMeta(name: String, typeName: String, flags: UInt) -> PluginColumnInfo {
+    PluginColumnInfo(
+        name: name,
+        dataType: typeName,
+        isNullable: (flags & mysqlNotNullFlag) == 0,
+        isPrimaryKey: (flags & mysqlPriKeyFlag) != 0,
+        identityKind: (flags & mysqlAutoIncrementFlag) != 0 ? .byDefault : nil
+    )
+}
+
 // MARK: - Error Types
 
 struct MariaDBPluginError: Error {
@@ -44,6 +57,7 @@
     let affectedRows: UInt64
     let insertId: UInt64
     let isTruncated: Bool
+    let columnMeta: [PluginColumnInfo]
 }
 
 // MARK: - SSL Configuration
@@ -53,7 +67,7 @@
 func mysqlTypeToString(_ fieldPtr: UnsafePointer<MYSQL_FIELD>) -> String {
     let field = fieldPtr.pointee
     let flags = UInt(field.flags)
     let length = field.length
 
     // MariaDB extended metadata: detect JSON stored as LONGTEXT.
     // `MARIADB_CONST_STRING` is length-prefixed (not null-terminated), so we must read
@@ -461,7 +475,8 @@
                 let insertId = mysql_insert_id(mysql)
                 return MariaDBPluginQueryResult(
                     columns: [], columnTypes: [], columnTypeNames: [],
-                    rows: [], affectedRows: affected, insertId: insertId, isTruncated: false
+                    rows: [], affectedRows: affected, insertId: insertId, isTruncated: false,
+                    columnMeta: []
                 )
             } else {
                 throw self.getError()
@@ -473,31 +488,32 @@
         var columnTypes: [UInt32] = []
         var columnTypeNames: [String] = []
         var columnIsBinary: [Bool] = []
+        var columnMeta: [PluginColumnInfo] = []
         columns.reserveCapacity(numFields)
         columnTypes.reserveCapacity(numFields)
         columnTypeNames.reserveCapacity(numFields)
         columnIsBinary.reserveCapacity(numFields)
+        columnMeta.reserveCapacity(numFields)
 
         if let fields = mysql_fetch_fields(resultPtr) {
             for i in 0..<numFields {
                 let field = fields[i]
-                if let namePtr = field.name {
-                    columns.append(String(cString: namePtr))
-                } else {
-                    columns.append("column_\(i)")
-                }
+                let columnName = field.name.map { String(cString: $0) } ?? "column_\(i)"
+                columns.append(columnName)
                 let fieldFlags = UInt(field.flags)
                 var fieldType = field.type.rawValue
                 if (fieldFlags & mysqlEnumFlag) != 0 { fieldType = 247 }
                 if (fieldFlags & mysqlSetFlag) != 0 { fieldType = 248 }
                 columnTypes.append(fieldType)
-                columnTypeNames.append(mysqlTypeToString(fields + i))
+                let typeName = mysqlTypeToString(fields + i)
+                columnTypeNames.append(typeName)
                 columnIsBinary.append(
                     MariaDBFieldClassifier.isBinary(
                         typeRaw: field.type.rawValue,
                         charset: field.charsetnr
                     )
                 )
+                columnMeta.append(makeColumnMeta(name: columnName, typeName: typeName, flags: fieldFlags))
             }
         }
 
@@ -576,7 +592,8 @@
 
         return MariaDBPluginQueryResult(
             columns: columns, columnTypes: columnTypes, columnTypeNames: columnTypeNames,
-            rows: rows, affectedRows: UInt64(rows.count), insertId: 0, isTruncated: truncated
+            rows: rows, affectedRows: UInt64(rows.count), insertId: 0, isTruncated: truncated,
+            columnMeta: columnMeta
         )
     }
 
@@ -815,7 +832,8 @@
             let insertId = mysql_stmt_insert_id(stmt)
             return MariaDBPluginQueryResult(
                 columns: [], columnTypes: [], columnTypeNames: [],
-                rows: [], affectedRows: UInt64(affected), insertId: UInt64(insertId), isTruncated: false
+                rows: [], affectedRows: UInt64(affected), insertId: UInt64(insertId), isTruncated: false,
+                columnMeta: []
             )
         }
 
@@ -831,28 +849,28 @@
         var columnTypes: [UInt32] = []
         var columnTypeNames: [String] = []
         var columnIsBinary: [Bool] = []
+        var columnMeta: [PluginColumnInfo] = []
         let numFields = Int(mysql_num_fields(metadata))
 
         if let fields = mysql_fetch_fields(metadata) {
             for i in 0..<numFields {
                 let field = fields[i]
-                if let namePtr = field.name {
-                    columns.append(String(cString: namePtr))
-                } else {
-                    columns.append("column_\(i)")
-                }
+                let columnName = field.name.map { String(cString: $0) } ?? "column_\(i)"
+                columns.append(columnName)
                 let fieldFlags = UInt(field.flags)
                 var fieldType = field.type.rawValue
                 if (fieldFlags & mysqlEnumFlag) != 0 { fieldType = 247 }
                 if (fieldFlags & mysqlSetFlag) != 0 { fieldType = 248 }
                 columnTypes.append(fieldType)
-                columnTypeNames.append(mysqlTypeToString(fields + i))
+                let typeName = mysqlTypeToString(fields + i)
+                columnTypeNames.append(typeName)
                 columnIsBinary.append(
                     MariaDBFieldClassifier.isBinary(
                         typeRaw: field.type.rawValue,
                         charset: field.charsetnr
                     )
                 )
+                columnMeta.append(makeColumnMeta(name: columnName, typeName: typeName, flags: fieldFlags))
             }
         }
 
@@ -865,7 +883,8 @@
         return MariaDBPluginQueryResult(
             columns: columns, columnTypes: columnTypes, columnTypeNames: columnTypeNames,
             rows: fetchResult.rows, affectedRows: UInt64(fetchResult.rows.count),
-            insertId: 0, isTruncated: fetchResult.isTruncated
+            insertId: 0, isTruncated: fetchResult.isTruncated,
+            columnMeta: columnMeta
         )
     }
 

Plugins/MySQLDriverPlugin/MySQLPluginDriver.swift

@@ -125,7 +125,8 @@ final class MySQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
             rows: result.rows,
             rowsAffected: Int(result.affectedRows),
             executionTime: Date().timeIntervalSince(startTime),
-            isTruncated: result.isTruncated
+            isTruncated: result.isTruncated,
+            columnMeta: result.columnMeta
         )
     }
 
@@ -165,7 +166,8 @@ final class MySQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
                 rows: result.rows,
                 rowsAffected: Int(result.affectedRows),
                 executionTime: Date().timeIntervalSince(startTime),
-                isTruncated: result.isTruncated
+                isTruncated: result.isTruncated,
+                columnMeta: result.columnMeta
             )
         } catch let error as MariaDBPluginError where !isRetry && isConnectionLostError(error) {
             try await reconnect()
@@ -962,5 +964,4 @@ final class MySQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
         }
         return columns
     }
-
 }

Plugins/TableProPluginKit/PluginQueryResult.swift

@@ -8,6 +8,7 @@ public struct PluginQueryResult: Codable, Sendable {
     public let executionTime: TimeInterval
     public let isTruncated: Bool
     public let statusMessage: String?
+    public let columnMeta: [PluginColumnInfo]?
 
     public init(
         columns: [String],
@@ -16,7 +17,8 @@ public struct PluginQueryResult: Codable, Sendable {
         rowsAffected: Int,
         executionTime: TimeInterval,
         isTruncated: Bool = false,
-        statusMessage: String? = nil
+        statusMessage: String? = nil,
+        columnMeta: [PluginColumnInfo]? = nil
     ) {
         self.columns = columns
         self.columnTypeNames = columnTypeNames
@@ -25,6 +27,7 @@ public struct PluginQueryResult: Codable, Sendable {
         self.executionTime = executionTime
         self.isTruncated = isTruncated
         self.statusMessage = statusMessage
+        self.columnMeta = columnMeta
     }
 
     public static let empty = PluginQueryResult(

TablePro/Core/ChangeTracking/DataChangeManager.swift

@@ -111,6 +111,10 @@ final class DataChangeManager: ChangeManaging {
         }
     }
 
+    func setPrimaryKeyColumns(_ primaryKeyColumns: [String]) {
+        self.primaryKeyColumns = primaryKeyColumns
+    }
+
     // MARK: - Change Tracking
 
     func recordCellChange(

TablePro/Core/Coordinators/QueryExecutionCoordinator+Helpers.swift

@@ -19,17 +19,6 @@ extension QueryExecutionCoordinator {
         QueryExecutor.parseSchemaMetadata(schema)
     }
 
-    func awaitSchemaResult(
-        parallelTask: Task<SchemaResult, Error>?,
-        tableName: String
-    ) async -> SchemaResult? {
-        await QueryExecutor.awaitSchemaResult(
-            connectionId: parent.connectionId,
-            parallelTask: parallelTask,
-            tableName: tableName
-        )
-    }
-
     func isMetadataCached(tabId: UUID, tableName: String) -> Bool {
         guard let idx = parent.tabManager.tabs.firstIndex(where: { $0.id == tabId }) else {
             return false
@@ -301,32 +290,33 @@ extension QueryExecutionCoordinator {
         tabId: UUID,
         capturedGeneration: Int,
         connectionType: DatabaseType,
-        schemaResult: SchemaResult?
+        schemaTask: Task<SchemaResult, Error>?
     ) {
-        resolveRowCount(
-            tableName: tableName,
-            tabId: tabId,
-            capturedGeneration: capturedGeneration,
-            connectionType: connectionType
-        )
-
         let isNonSQL = PluginManager.shared.editorLanguage(for: connectionType) != .sql
-        guard !isNonSQL else { return }
         Task(priority: .utility) { [weak self, parent] in
             guard let self else { return }
             guard !parent.isTearingDown else { return }
 
-            let columnInfo: [ColumnInfo]
-            if let schema = schemaResult {
-                columnInfo = schema.columnInfo
-            } else {
-                columnInfo = (try? await DatabaseManager.shared.withMetadataDriver(connectionId: parent.connectionId) { driver in
-                    try await driver.fetchColumns(table: tableName)
-                }) ?? []
+            let schema = try? await schemaTask?.value
+
+            await MainActor.run { [weak self] in
+                guard let self else { return }
+                guard capturedGeneration == parent.queryGeneration else { return }
+                if let schema {
+                    applyPhase2Metadata(parsed: QueryExecutor.parseSchemaMetadata(schema), tabId: tabId)
+                }
+                resolveRowCount(
+                    tableName: tableName,
+                    tabId: tabId,
+                    capturedGeneration: capturedGeneration,
+                    connectionType: connectionType
+                )
             }
 
+            guard !isNonSQL, let schema else { return }
+
             let columnEnumValues = await parent.fetchEnumValues(
-                columnInfo: columnInfo,
+                columnInfo: schema.columnInfo,
                 tableName: tableName,
                 connectionType: connectionType
             )
@@ -361,6 +351,40 @@ extension QueryExecutionCoordinator {
         }
     }
 
+    private func applyPhase2Metadata(parsed: ParsedSchemaMetadata, tabId: UUID) {
+        guard parent.tabManager.tabs.contains(where: { $0.id == tabId }) else { return }
+
+        parent.mutateActiveTableRows(for: tabId) { rows in
+            rows.updateDisplayMetadata(
+                columnDefaults: parsed.columnDefaults,
+                columnForeignKeys: parsed.columnForeignKeys,
+                columnNullable: parsed.columnNullable
+            )
+        }
+
+        parent.tabManager.mutate(tabId: tabId) { tab in
+            if !parsed.primaryKeyColumns.isEmpty {
+                tab.tableContext.primaryKeyColumns = parsed.primaryKeyColumns
+            }
+            if let approxCount = parsed.approximateRowCount, approxCount > 0,
+               !tab.filterState.hasAppliedFilters {
+                tab.pagination.totalRowCount = approxCount
+                tab.pagination.isApproximateRowCount = true
+            }
+            tab.metadataVersion += 1
+        }
+
+        if parent.tabManager.selectedTabId == tabId, !parsed.primaryKeyColumns.isEmpty {
+            parent.changeManager.setPrimaryKeyColumns(parsed.primaryKeyColumns)
+        }
+
+        if let activeIdx = parent.tabManager.selectedTabIndex,
+           activeIdx < parent.tabManager.tabs.count,
+           parent.tabManager.tabs[activeIdx].id == tabId {
+            parent.dataTabDelegate?.tableViewCoordinator?.refreshForeignKeyColumns()
+        }
+    }
+
     func launchPhase2Count(
         tableName: String,
         tabId: UUID,