-
-
Notifications
You must be signed in to change notification settings - Fork 144
Expand file tree
/
Copy pathDuckDBPlugin.swift
More file actions
933 lines (794 loc) · 33 KB
/
DuckDBPlugin.swift
File metadata and controls
933 lines (794 loc) · 33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
//
// DuckDBPlugin.swift
// TablePro
//
import CDuckDB
import Foundation
import os
import TableProPluginKit
final class DuckDBPlugin: NSObject, TableProPlugin, DriverPlugin {
static let pluginName = "DuckDB Driver"
static let pluginVersion = "1.0.0"
static let pluginDescription = "DuckDB analytical database support"
static let capabilities: [PluginCapability] = [.databaseDriver]
static let databaseTypeId = "DuckDB"
static let databaseDisplayName = "DuckDB"
static let iconName = "duckdb-icon"
static let defaultPort = 0
// MARK: - UI/Capability Metadata
static let requiresAuthentication = false
static let connectionMode: ConnectionMode = .fileBased
static let urlSchemes: [String] = ["duckdb"]
static let fileExtensions: [String] = ["duckdb", "db"]
static let brandColorHex = "#FFD900"
static let supportsDatabaseSwitching = false
static let systemDatabaseNames: [String] = ["information_schema", "pg_catalog"]
static let databaseGroupingStrategy: GroupingStrategy = .flat
static let columnTypesByCategory: [String: [String]] = [
"Integer": ["TINYINT", "SMALLINT", "INTEGER", "BIGINT", "HUGEINT", "UTINYINT", "USMALLINT", "UINTEGER", "UBIGINT"],
"Float": ["FLOAT", "DOUBLE", "DECIMAL", "NUMERIC"],
"String": ["VARCHAR", "TEXT", "CHAR", "BPCHAR"],
"Date": ["DATE", "TIME", "TIMESTAMP", "TIMESTAMPTZ", "TIMESTAMP_S", "TIMESTAMP_MS", "TIMESTAMP_NS", "INTERVAL"],
"Binary": ["BLOB", "BYTEA", "BIT", "BITSTRING"],
"Boolean": ["BOOLEAN"],
"JSON": ["JSON"],
"UUID": ["UUID"],
"List": ["LIST"],
"Struct": ["STRUCT"],
"Map": ["MAP"],
"Union": ["UNION"],
"Enum": ["ENUM"]
]
func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
DuckDBPluginDriver(config: config)
}
}
// MARK: - DuckDB Connection Actor
private actor DuckDBConnectionActor {
private static let logger = Logger(subsystem: "com.TablePro", category: "DuckDBConnectionActor")
private var database: duckdb_database?
private var connection: duckdb_connection?
var isConnected: Bool { connection != nil }
var connectionHandleForInterrupt: duckdb_connection? { connection }
func open(path: String) throws {
var db: duckdb_database?
var errorPtr: UnsafeMutablePointer<CChar>?
let state = duckdb_open_ext(path, &db, nil, &errorPtr)
if state == DuckDBError {
let detail: String
if let errPtr = errorPtr {
detail = String(cString: errPtr)
duckdb_free(errPtr)
} else {
detail = "unknown error"
}
throw DuckDBPluginError.connectionFailed(
"Failed to open DuckDB database at '\(path)': \(detail)"
)
}
guard let openedDB = db else {
throw DuckDBPluginError.connectionFailed(
"Failed to open DuckDB database at '\(path)'"
)
}
var conn: duckdb_connection?
let connState = duckdb_connect(openedDB, &conn)
if connState == DuckDBError {
duckdb_close(&db)
throw DuckDBPluginError.connectionFailed("Failed to create DuckDB connection")
}
database = db
connection = conn
}
func close() {
if connection != nil {
duckdb_disconnect(&connection)
connection = nil
}
if database != nil {
duckdb_close(&database)
database = nil
}
}
func executeQuery(_ query: String) throws -> DuckDBRawResult {
guard let conn = connection else {
throw DuckDBPluginError.notConnected
}
let startTime = Date()
var result = duckdb_result()
let state = duckdb_query(conn, query, &result)
if state == DuckDBError {
let errorMsg: String
if let errPtr = duckdb_result_error(&result) {
errorMsg = String(cString: errPtr)
} else {
errorMsg = "Unknown DuckDB error"
}
duckdb_destroy_result(&result)
throw DuckDBPluginError.queryFailed(errorMsg)
}
defer {
duckdb_destroy_result(&result)
}
return Self.extractResult(from: &result, startTime: startTime)
}
func executePrepared(_ query: String, parameters: [String?]) throws -> DuckDBRawResult {
guard let conn = connection else {
throw DuckDBPluginError.notConnected
}
let startTime = Date()
var stmtOpt: duckdb_prepared_statement?
let prepState = duckdb_prepare(conn, query, &stmtOpt)
if prepState == DuckDBError {
let errorMsg: String
if let s = stmtOpt, let errPtr = duckdb_prepare_error(s) {
errorMsg = String(cString: errPtr)
} else {
errorMsg = "Failed to prepare statement"
}
duckdb_destroy_prepare(&stmtOpt)
throw DuckDBPluginError.queryFailed(errorMsg)
}
guard let stmt = stmtOpt else {
throw DuckDBPluginError.queryFailed("Failed to prepare statement")
}
defer {
duckdb_destroy_prepare(&stmtOpt)
}
for (index, param) in parameters.enumerated() {
let paramIdx = idx_t(index + 1)
if let value = param {
let bindState = duckdb_bind_varchar(stmt, paramIdx, value)
if bindState == DuckDBError {
throw DuckDBPluginError.queryFailed("Failed to bind parameter at index \(index)")
}
} else {
let bindState = duckdb_bind_null(stmt, paramIdx)
if bindState == DuckDBError {
throw DuckDBPluginError.queryFailed("Failed to bind NULL at index \(index)")
}
}
}
var result = duckdb_result()
let execState = duckdb_execute_prepared(stmt, &result)
if execState == DuckDBError {
let errorMsg: String
if let errPtr = duckdb_result_error(&result) {
errorMsg = String(cString: errPtr)
} else {
errorMsg = "Failed to execute prepared statement"
}
duckdb_destroy_result(&result)
throw DuckDBPluginError.queryFailed(errorMsg)
}
defer {
duckdb_destroy_result(&result)
}
return Self.extractResult(from: &result, startTime: startTime)
}
private static func extractResult(
from result: inout duckdb_result,
startTime: Date
) -> DuckDBRawResult {
let colCount = duckdb_column_count(&result)
let rowCount = duckdb_row_count(&result)
let rowsChanged = duckdb_rows_changed(&result)
var columns: [String] = []
var columnTypeNames: [String] = []
for i in 0..<colCount {
if let namePtr = duckdb_column_name(&result, i) {
columns.append(String(cString: namePtr))
} else {
columns.append("column_\(i)")
}
let colType = duckdb_column_type(&result, i)
columnTypeNames.append(Self.typeName(for: colType))
}
var rows: [[String?]] = []
var truncated = false
let maxRows = min(rowCount, UInt64(PluginRowLimits.defaultMax))
if rowCount > UInt64(PluginRowLimits.defaultMax) {
truncated = true
}
for row in 0..<maxRows {
var rowData: [String?] = []
for col in 0..<colCount {
if duckdb_value_is_null(&result, col, row) {
rowData.append(nil)
} else if let valPtr = duckdb_value_varchar(&result, col, row) {
rowData.append(String(cString: valPtr))
duckdb_free(valPtr)
} else {
rowData.append(nil)
}
}
rows.append(rowData)
}
let executionTime = Date().timeIntervalSince(startTime)
return DuckDBRawResult(
columns: columns,
columnTypeNames: columnTypeNames,
rows: rows,
rowsAffected: Int(rowsChanged),
executionTime: executionTime,
isTruncated: truncated
)
}
private static func typeName(for type: duckdb_type) -> String {
switch type {
case DUCKDB_TYPE_BOOLEAN: return "BOOLEAN"
case DUCKDB_TYPE_TINYINT: return "TINYINT"
case DUCKDB_TYPE_SMALLINT: return "SMALLINT"
case DUCKDB_TYPE_INTEGER: return "INTEGER"
case DUCKDB_TYPE_BIGINT: return "BIGINT"
case DUCKDB_TYPE_UTINYINT: return "UTINYINT"
case DUCKDB_TYPE_USMALLINT: return "USMALLINT"
case DUCKDB_TYPE_UINTEGER: return "UINTEGER"
case DUCKDB_TYPE_UBIGINT: return "UBIGINT"
case DUCKDB_TYPE_FLOAT: return "FLOAT"
case DUCKDB_TYPE_DOUBLE: return "DOUBLE"
case DUCKDB_TYPE_TIMESTAMP: return "TIMESTAMP"
case DUCKDB_TYPE_DATE: return "DATE"
case DUCKDB_TYPE_TIME: return "TIME"
case DUCKDB_TYPE_INTERVAL: return "INTERVAL"
case DUCKDB_TYPE_HUGEINT: return "HUGEINT"
case DUCKDB_TYPE_VARCHAR: return "VARCHAR"
case DUCKDB_TYPE_BLOB: return "BLOB"
case DUCKDB_TYPE_DECIMAL: return "DECIMAL"
case DUCKDB_TYPE_TIMESTAMP_S: return "TIMESTAMP_S"
case DUCKDB_TYPE_TIMESTAMP_MS: return "TIMESTAMP_MS"
case DUCKDB_TYPE_TIMESTAMP_NS: return "TIMESTAMP_NS"
case DUCKDB_TYPE_ENUM: return "ENUM"
case DUCKDB_TYPE_LIST: return "LIST"
case DUCKDB_TYPE_STRUCT: return "STRUCT"
case DUCKDB_TYPE_MAP: return "MAP"
case DUCKDB_TYPE_UUID: return "UUID"
case DUCKDB_TYPE_UNION: return "UNION"
case DUCKDB_TYPE_BIT: return "BIT"
default: return "VARCHAR"
}
}
}
private struct DuckDBRawResult: Sendable {
let columns: [String]
let columnTypeNames: [String]
let rows: [[String?]]
let rowsAffected: Int
let executionTime: TimeInterval
let isTruncated: Bool
}
// MARK: - DuckDB Plugin Driver
final class DuckDBPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
private let config: DriverConnectionConfig
private let connectionActor = DuckDBConnectionActor()
private let stateLock = NSLock()
nonisolated(unsafe) private var _connectionForInterrupt: duckdb_connection?
nonisolated(unsafe) private var _currentSchema: String = "main"
private static let logger = Logger(subsystem: "com.TablePro", category: "DuckDBPluginDriver")
var currentSchema: String? {
stateLock.lock()
defer { stateLock.unlock() }
return _currentSchema
}
var serverVersion: String? { String(cString: duckdb_library_version()) }
var supportsSchemas: Bool { true }
var supportsTransactions: Bool { true }
init(config: DriverConnectionConfig) {
self.config = config
}
private func resolveSchema(_ schema: String?) -> String {
if let schema { return schema }
stateLock.lock()
defer { stateLock.unlock() }
return _currentSchema
}
// MARK: - Connection
func connect() async throws {
let path = expandPath(config.database)
if !FileManager.default.fileExists(atPath: path) {
let directory = (path as NSString).deletingLastPathComponent
if !directory.isEmpty {
try? FileManager.default.createDirectory(
atPath: directory,
withIntermediateDirectories: true
)
}
}
try await connectionActor.open(path: path)
// Enable auto-install and auto-load of extensions (e.g. core_functions)
try? await connectionActor.executeQuery("SET autoinstall_known_extensions=1")
try? await connectionActor.executeQuery("SET autoload_known_extensions=1")
if let conn = await connectionActor.connectionHandleForInterrupt {
setInterruptHandle(conn)
}
}
func disconnect() {
stateLock.lock()
_connectionForInterrupt = nil
stateLock.unlock()
let actor = connectionActor
Task { await actor.close() }
}
func ping() async throws {
_ = try await execute(query: "SELECT 1")
}
func applyQueryTimeout(_ seconds: Int) async throws {
// DuckDB doesn't have a session-level query timeout like network databases
}
// MARK: - Query Execution
func execute(query: String) async throws -> PluginQueryResult {
let rawResult = try await connectionActor.executeQuery(query)
return PluginQueryResult(
columns: rawResult.columns,
columnTypeNames: rawResult.columnTypeNames,
rows: rawResult.rows,
rowsAffected: rawResult.rowsAffected,
executionTime: rawResult.executionTime,
isTruncated: rawResult.isTruncated
)
}
func executeParameterized(
query: String,
parameters: [String?]
) async throws -> PluginQueryResult {
let rawResult = try await connectionActor.executePrepared(query, parameters: parameters)
return PluginQueryResult(
columns: rawResult.columns,
columnTypeNames: rawResult.columnTypeNames,
rows: rawResult.rows,
rowsAffected: rawResult.rowsAffected,
executionTime: rawResult.executionTime,
isTruncated: rawResult.isTruncated
)
}
func cancelQuery() throws {
stateLock.lock()
let conn = _connectionForInterrupt
stateLock.unlock()
guard let conn else { return }
duckdb_interrupt(conn)
}
// MARK: - Pagination
func fetchRowCount(query: String) async throws -> Int {
let baseQuery = stripLimitOffset(from: query)
let countQuery = "SELECT COUNT(*) FROM (\(baseQuery)) AS _count_subquery"
let result = try await execute(query: countQuery)
guard let firstRow = result.rows.first, let countStr = firstRow.first else { return 0 }
return Int(countStr ?? "0") ?? 0
}
func fetchRows(query: String, offset: Int, limit: Int) async throws -> PluginQueryResult {
let baseQuery = stripLimitOffset(from: query)
let paginatedQuery = "\(baseQuery) LIMIT \(limit) OFFSET \(offset)"
return try await execute(query: paginatedQuery)
}
// MARK: - Schema Operations
func fetchTables(schema: String?) async throws -> [PluginTableInfo] {
let schemaName = resolveSchema(schema)
let query = """
SELECT table_name, table_type
FROM information_schema.tables
WHERE table_schema = $1
ORDER BY table_name
"""
let result = try await executeParameterized(query: query, parameters: [schemaName])
return result.rows.compactMap { row in
guard let name = row[safe: 0] ?? nil else { return nil }
let typeString = (row[safe: 1] ?? nil) ?? "BASE TABLE"
let tableType = typeString.uppercased().contains("VIEW") ? "VIEW" : "TABLE"
return PluginTableInfo(name: name, type: tableType)
}
}
func fetchColumns(table: String, schema: String?) async throws -> [PluginColumnInfo] {
let schemaName = resolveSchema(schema)
let query = """
SELECT column_name, data_type, is_nullable, column_default, ordinal_position
FROM information_schema.columns
WHERE table_schema = $1
AND table_name = $2
ORDER BY ordinal_position
"""
let result = try await executeParameterized(query: query, parameters: [schemaName, table])
let pkColumns = try await fetchPrimaryKeyColumns(table: table, schema: schemaName)
return result.rows.compactMap { row in
guard let name = row[safe: 0] ?? nil,
let dataType = row[safe: 1] ?? nil else {
return nil
}
let isNullable = (row[safe: 2] ?? nil) == "YES"
let defaultValue = row[safe: 3] ?? nil
let isPrimaryKey = pkColumns.contains(name)
return PluginColumnInfo(
name: name,
dataType: dataType,
isNullable: isNullable,
isPrimaryKey: isPrimaryKey,
defaultValue: defaultValue
)
}
}
func fetchAllColumns(schema: String?) async throws -> [String: [PluginColumnInfo]] {
let schemaName = resolveSchema(schema)
let query = """
SELECT table_name, column_name, data_type, is_nullable, column_default, ordinal_position
FROM information_schema.columns
WHERE table_schema = $1
ORDER BY table_name, ordinal_position
"""
let result = try await executeParameterized(query: query, parameters: [schemaName])
let pkQuery = """
SELECT tc.table_name, kcu.column_name
FROM information_schema.table_constraints tc
JOIN information_schema.key_column_usage kcu
ON tc.constraint_name = kcu.constraint_name
AND tc.table_schema = kcu.table_schema
WHERE tc.constraint_type = 'PRIMARY KEY'
AND tc.table_schema = $1
"""
let pkResult = try await executeParameterized(query: pkQuery, parameters: [schemaName])
var pkMap: [String: Set<String>] = [:]
for row in pkResult.rows {
if let tableName = row[safe: 0] ?? nil, let colName = row[safe: 1] ?? nil {
pkMap[tableName, default: []].insert(colName)
}
}
var allColumns: [String: [PluginColumnInfo]] = [:]
for row in result.rows {
guard let tableName = row[safe: 0] ?? nil,
let columnName = row[safe: 1] ?? nil,
let dataType = row[safe: 2] ?? nil else {
continue
}
let isNullable = (row[safe: 3] ?? nil) == "YES"
let defaultValue = row[safe: 4] ?? nil
let isPrimaryKey = pkMap[tableName]?.contains(columnName) ?? false
let column = PluginColumnInfo(
name: columnName,
dataType: dataType,
isNullable: isNullable,
isPrimaryKey: isPrimaryKey,
defaultValue: defaultValue
)
allColumns[tableName, default: []].append(column)
}
return allColumns
}
func fetchIndexes(table: String, schema: String?) async throws -> [PluginIndexInfo] {
let schemaName = resolveSchema(schema)
let query = """
SELECT index_name, is_unique, sql, index_oid
FROM duckdb_indexes()
WHERE schema_name = $1
AND table_name = $2
"""
do {
let result = try await executeParameterized(
query: query, parameters: [schemaName, table]
)
return result.rows.compactMap { row in
guard let name = row[safe: 0] ?? nil else { return nil }
let isUnique = (row[safe: 1] ?? nil) == "true"
let sql = row[safe: 2] ?? nil
let isPrimary = name.lowercased().contains("primary")
|| (sql?.uppercased().contains("PRIMARY KEY") ?? false)
let columns = extractIndexColumns(from: sql)
return PluginIndexInfo(
name: name,
columns: columns,
isUnique: isUnique || isPrimary,
isPrimary: isPrimary,
type: "ART"
)
}.sorted { $0.isPrimary && !$1.isPrimary }
} catch {
return []
}
}
func fetchForeignKeys(table: String, schema: String?) async throws -> [PluginForeignKeyInfo] {
let schemaName = resolveSchema(schema)
let query = """
SELECT
rc.constraint_name,
kcu.column_name,
kcu2.table_name AS referenced_table,
kcu2.column_name AS referenced_column,
rc.delete_rule,
rc.update_rule
FROM information_schema.referential_constraints rc
JOIN information_schema.key_column_usage kcu
ON rc.constraint_name = kcu.constraint_name
AND rc.constraint_schema = kcu.constraint_schema
JOIN information_schema.key_column_usage kcu2
ON rc.unique_constraint_name = kcu2.constraint_name
AND rc.unique_constraint_schema = kcu2.constraint_schema
AND kcu.ordinal_position = kcu2.ordinal_position
WHERE kcu.table_schema = $1
AND kcu.table_name = $2
"""
do {
let result = try await executeParameterized(
query: query, parameters: [schemaName, table]
)
return result.rows.compactMap { row in
guard let name = row[safe: 0] ?? nil,
let column = row[safe: 1] ?? nil,
let refTable = row[safe: 2] ?? nil,
let refColumn = row[safe: 3] ?? nil else {
return nil
}
let onDelete = (row[safe: 4] ?? nil) ?? "NO ACTION"
let onUpdate = (row[safe: 5] ?? nil) ?? "NO ACTION"
return PluginForeignKeyInfo(
name: name,
column: column,
referencedTable: refTable,
referencedColumn: refColumn,
onDelete: onDelete,
onUpdate: onUpdate
)
}
} catch {
return []
}
}
func fetchTableDDL(table: String, schema: String?) async throws -> String {
let schemaName = resolveSchema(schema)
// Try native DDL from duckdb_tables() first (preserves complex types like LIST, STRUCT, MAP)
let nativeQuery = "SELECT sql FROM duckdb_tables() WHERE schema_name = $1 AND table_name = $2"
let nativeResult = try await executeParameterized(query: nativeQuery, parameters: [schemaName, table])
if let firstRow = nativeResult.rows.first, let sql = firstRow[0] {
var ddl = sql.hasSuffix(";") ? sql : sql + ";"
// Append index definitions
let indexes = try await fetchIndexes(table: table, schema: schemaName)
for index in indexes where !index.isPrimary {
let uniqueStr = index.isUnique ? "UNIQUE " : ""
let cols = index.columns.map { "\"\(escapeIdentifier($0))\"" }.joined(separator: ", ")
ddl += "\n\nCREATE \(uniqueStr)INDEX \"\(escapeIdentifier(index.name))\""
+ " ON \"\(escapeIdentifier(schemaName))\".\"\(escapeIdentifier(table))\""
+ " (\(cols));"
}
return ddl
}
// Fallback: synthesize DDL from schema metadata
let columns = try await fetchColumns(table: table, schema: schemaName)
let indexes = try await fetchIndexes(table: table, schema: schemaName)
let fks = try await fetchForeignKeys(table: table, schema: schemaName)
var ddl = "CREATE TABLE \"\(escapeIdentifier(schemaName))\".\"\(escapeIdentifier(table))\" (\n"
let columnDefs = columns.map { col in
var def = " \"\(escapeIdentifier(col.name))\" \(col.dataType)"
if !col.isNullable { def += " NOT NULL" }
if let defaultVal = col.defaultValue { def += " DEFAULT \(defaultVal)" }
return def
}
var allDefs = columnDefs
let pkColumns = columns.filter(\.isPrimaryKey)
if !pkColumns.isEmpty {
let pkCols = pkColumns.map { "\"\(escapeIdentifier($0.name))\"" }
.joined(separator: ", ")
allDefs.append(" PRIMARY KEY (\(pkCols))")
}
for fk in fks {
let fkDef = " FOREIGN KEY (\"\(escapeIdentifier(fk.column))\")"
+ " REFERENCES \"\(escapeIdentifier(fk.referencedTable))\""
+ "(\"\(escapeIdentifier(fk.referencedColumn))\")"
+ " ON DELETE \(fk.onDelete) ON UPDATE \(fk.onUpdate)"
allDefs.append(fkDef)
}
ddl += allDefs.joined(separator: ",\n")
ddl += "\n);"
for index in indexes where !index.isPrimary {
let uniqueStr = index.isUnique ? "UNIQUE " : ""
let cols = index.columns.map { "\"\(escapeIdentifier($0))\"" }.joined(separator: ", ")
ddl += "\n\nCREATE \(uniqueStr)INDEX \"\(escapeIdentifier(index.name))\""
+ " ON \"\(escapeIdentifier(schemaName))\".\"\(escapeIdentifier(table))\""
+ " (\(cols));"
}
return ddl
}
func fetchViewDefinition(view: String, schema: String?) async throws -> String {
let schemaName = resolveSchema(schema)
let query = """
SELECT view_definition
FROM information_schema.views
WHERE table_schema = $1
AND table_name = $2
"""
let result = try await executeParameterized(query: query, parameters: [schemaName, view])
guard let firstRow = result.rows.first,
let definition = firstRow[0] else {
throw DuckDBPluginError.queryFailed(
"Failed to fetch definition for view '\(view)'"
)
}
return "CREATE VIEW \"\(escapeIdentifier(schemaName))\".\"\(escapeIdentifier(view))\" AS\n\(definition)"
}
func fetchTableMetadata(table: String, schema: String?) async throws -> PluginTableMetadata {
let schemaName = resolveSchema(schema)
let safeTable = escapeIdentifier(table)
let safeSchema = escapeIdentifier(schemaName)
let countQuery =
"SELECT COUNT(*) FROM (SELECT 1 FROM \"\(safeSchema)\".\"\(safeTable)\" LIMIT 100001) AS _t"
let countResult = try await execute(query: countQuery)
let rowCount: Int64? = {
guard let row = countResult.rows.first, let countStr = row.first else { return nil }
return Int64(countStr ?? "0")
}()
return PluginTableMetadata(
tableName: table,
rowCount: rowCount,
engine: "DuckDB"
)
}
// MARK: - Schema Navigation
func fetchSchemas() async throws -> [String] {
let query = "SELECT schema_name FROM information_schema.schemata ORDER BY schema_name"
let result = try await execute(query: query)
return result.rows.compactMap { $0[safe: 0] ?? nil }
}
func switchSchema(to schema: String) async throws {
let safeSchema = escapeIdentifier(schema)
_ = try await execute(query: "SET schema = \"\(safeSchema)\"")
stateLock.lock()
_currentSchema = schema
stateLock.unlock()
}
// MARK: - Database Operations
func fetchDatabases() async throws -> [String] {
let query = "SELECT database_name FROM duckdb_databases() ORDER BY database_name"
let result = try await execute(query: query)
return result.rows.compactMap { row in
row[safe: 0] ?? nil
}
}
func fetchDatabaseMetadata(_ database: String) async throws -> PluginDatabaseMetadata {
PluginDatabaseMetadata(name: database)
}
func createDatabase(name: String, charset: String, collation: String?) async throws {
throw DuckDBPluginError.unsupportedOperation
}
// MARK: - Private Helpers
nonisolated private func setInterruptHandle(_ handle: duckdb_connection?) {
stateLock.lock()
_connectionForInterrupt = handle
stateLock.unlock()
}
private func expandPath(_ path: String) -> String {
if path.hasPrefix("~") {
return NSString(string: path).expandingTildeInPath
}
return path
}
private func escapeIdentifier(_ value: String) -> String {
value.replacingOccurrences(of: "\"", with: "\"\"")
}
private func stripLimitOffset(from query: String) -> String {
var result = query.trimmingCharacters(in: .whitespacesAndNewlines)
// Strip trailing semicolons
while result.hasSuffix(";") {
result = String(result.dropLast()).trimmingCharacters(in: .whitespaces)
}
// Only strip LIMIT/OFFSET at the top level (depth 0) from the end.
// Strip OFFSET first (comes after LIMIT), then LIMIT.
for keyword in ["OFFSET", "LIMIT"] {
let upper = result.uppercased() as NSString
if let pos = findLastTopLevelKeyword(keyword, upper: upper, length: upper.length) {
result = (result as NSString).substring(to: pos)
.trimmingCharacters(in: .whitespaces)
}
}
return result
}
private func findLastTopLevelKeyword(
_ keyword: String,
upper: NSString,
length: Int
) -> Int? {
let keyLen = keyword.count
let parenOpen = UInt16(UnicodeScalar("(").value)
let parenClose = UInt16(UnicodeScalar(")").value)
let singleQuote = UInt16(UnicodeScalar("'").value)
let doubleQuote = UInt16(UnicodeScalar("\"").value)
var depth = 0
var inString = false
var inIdentifier = false
var i = length - 1
while i >= 0 {
let ch = upper.character(at: i)
if inString {
if ch == singleQuote {
if i > 0 && upper.character(at: i - 1) == singleQuote {
i -= 1
} else {
inString = false
}
}
} else if inIdentifier {
if ch == doubleQuote {
if i > 0 && upper.character(at: i - 1) == doubleQuote {
i -= 1
} else {
inIdentifier = false
}
}
} else {
if ch == singleQuote {
inString = true
} else if ch == doubleQuote {
inIdentifier = true
} else if ch == parenClose {
depth += 1
} else if ch == parenOpen {
depth -= 1
} else if depth == 0 {
let start = i - keyLen + 1
if start >= 0 {
let candidate = upper.substring(with: NSRange(location: start, length: keyLen))
if candidate == keyword {
let beforeOk = start == 0 || {
guard let scalar = Unicode.Scalar(upper.character(at: start - 1)) else {
return false
}
return CharacterSet.whitespaces.contains(scalar)
}()
if beforeOk {
return start
}
}
}
}
}
i -= 1
}
return nil
}
private func fetchPrimaryKeyColumns(
table: String,
schema: String
) async throws -> Set<String> {
let query = """
SELECT kcu.column_name
FROM information_schema.table_constraints tc
JOIN information_schema.key_column_usage kcu
ON tc.constraint_name = kcu.constraint_name
AND tc.table_schema = kcu.table_schema
WHERE tc.constraint_type = 'PRIMARY KEY'
AND tc.table_schema = $1
AND tc.table_name = $2
"""
let result = try await executeParameterized(query: query, parameters: [schema, table])
return Set(result.rows.compactMap { $0[safe: 0] ?? nil })
}
private static let indexColumnsRegex = try? NSRegularExpression(
pattern: #"ON\s+(?:(?:"[^"]*"|[^\s(]+)\s*\.\s*)*(?:"[^"]*"|[^\s(]+)\s*\(([^)]+)\)"#,
options: .caseInsensitive
)
private func extractIndexColumns(from sql: String?) -> [String] {
guard let sql, let regex = Self.indexColumnsRegex else { return [] }
let range = NSRange(sql.startIndex..., in: sql)
guard let match = regex.firstMatch(in: sql, range: range),
match.numberOfRanges > 1,
let columnsRange = Range(match.range(at: 1), in: sql) else {
return []
}
return String(sql[columnsRange]).split(separator: ",").map {
$0.trimmingCharacters(in: .whitespaces)
.replacingOccurrences(of: "\"", with: "")
}
}
}
// MARK: - Errors
enum DuckDBPluginError: Error {
case connectionFailed(String)
case notConnected
case queryFailed(String)
case unsupportedOperation
}
extension DuckDBPluginError: PluginDriverError {
var pluginErrorMessage: String {
switch self {
case .connectionFailed(let msg): return msg
case .notConnected: return String(localized: "Not connected to database")
case .queryFailed(let msg): return msg
case .unsupportedOperation: return String(localized: "Operation not supported")
}
}
}