-
-
Notifications
You must be signed in to change notification settings - Fork 295
Expand file tree
/
Copy pathMSSQLPlugin.swift
More file actions
1991 lines (1768 loc) · 78.8 KB
/
Copy pathMSSQLPlugin.swift
File metadata and controls
1991 lines (1768 loc) · 78.8 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
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//
// MSSQLPlugin.swift
// TablePro
//
import CFreeTDS
import Foundation
import os
import TableProPluginKit
final class MSSQLPlugin: NSObject, TableProPlugin, DriverPlugin {
static let pluginName = "MSSQL Driver"
static let pluginVersion = "1.0.0"
static let pluginDescription = "Microsoft SQL Server support via FreeTDS db-lib"
static let capabilities: [PluginCapability] = [.databaseDriver]
static let databaseTypeId = "SQL Server"
static let databaseDisplayName = "SQL Server"
static let iconName = "mssql-icon"
static let defaultPort = 1433
static let additionalConnectionFields: [ConnectionField] = [
ConnectionField(id: "mssqlSchema", label: "Schema", placeholder: "dbo", defaultValue: "dbo")
]
// MARK: - UI/Capability Metadata
static let supportsSchemaSwitching = true
static let postConnectActions: [PostConnectAction] = [.selectDatabaseFromLastSession, .selectSchemaFromLastSession]
static let brandColorHex = "#E34517"
static let systemDatabaseNames: [String] = ["master", "tempdb", "model", "msdb"]
static let defaultSchemaName = "dbo"
static let databaseGroupingStrategy: GroupingStrategy = .bySchema
static let columnTypesByCategory: [String: [String]] = [
"Integer": ["TINYINT", "SMALLINT", "INT", "BIGINT"],
"Float": ["FLOAT", "REAL", "DECIMAL", "NUMERIC", "MONEY", "SMALLMONEY"],
"String": ["CHAR", "VARCHAR", "TEXT", "NCHAR", "NVARCHAR", "NTEXT"],
"Date": ["DATE", "TIME", "DATETIME", "DATETIME2", "SMALLDATETIME", "DATETIMEOFFSET"],
"Binary": ["BINARY", "VARBINARY", "IMAGE"],
"Boolean": ["BIT"],
"XML": ["XML"],
"UUID": ["UNIQUEIDENTIFIER"],
"Spatial": ["GEOMETRY", "GEOGRAPHY"],
"Other": ["SQL_VARIANT", "TIMESTAMP", "ROWVERSION", "CURSOR", "TABLE", "HIERARCHYID"]
]
static let sqlDialect: SQLDialectDescriptor? = SQLDialectDescriptor(
identifierQuote: "[",
keywords: [
"SELECT", "FROM", "WHERE", "JOIN", "INNER", "LEFT", "RIGHT", "OUTER", "CROSS", "FULL",
"ON", "USING", "AND", "OR", "NOT", "IN", "LIKE", "BETWEEN", "AS",
"ORDER", "BY", "GROUP", "HAVING", "TOP", "OFFSET", "FETCH", "NEXT", "ROWS", "ONLY",
"INSERT", "INTO", "VALUES", "UPDATE", "SET", "DELETE",
"CREATE", "ALTER", "DROP", "TABLE", "INDEX", "VIEW", "DATABASE", "SCHEMA",
"PRIMARY", "KEY", "FOREIGN", "REFERENCES", "UNIQUE", "CONSTRAINT",
"ADD", "COLUMN", "RENAME", "EXEC",
"NULL", "IS", "ASC", "DESC", "DISTINCT", "ALL", "ANY", "SOME",
"IDENTITY", "NOLOCK", "WITH", "ROWCOUNT", "NEWID",
"CASE", "WHEN", "THEN", "ELSE", "END", "COALESCE", "NULLIF", "IIF",
"UNION", "INTERSECT", "EXCEPT",
"DECLARE", "BEGIN", "COMMIT", "ROLLBACK", "TRANSACTION",
"PRINT", "GO", "EXECUTE",
"OVER", "PARTITION", "ROW_NUMBER", "RANK", "DENSE_RANK",
"RETURNING", "OUTPUT", "INSERTED", "DELETED"
],
functions: [
"COUNT", "SUM", "AVG", "MAX", "MIN", "STRING_AGG",
"CONCAT", "SUBSTRING", "LEFT", "RIGHT", "LEN", "LOWER", "UPPER",
"TRIM", "LTRIM", "RTRIM", "REPLACE", "CHARINDEX", "PATINDEX",
"STUFF", "FORMAT",
"GETDATE", "GETUTCDATE", "SYSDATETIME", "CURRENT_TIMESTAMP",
"DATEADD", "DATEDIFF", "DATENAME", "DATEPART",
"CONVERT", "CAST",
"ROUND", "CEILING", "FLOOR", "ABS", "POWER", "SQRT", "RAND",
"ISNULL", "ISNUMERIC", "ISDATE", "COALESCE", "NEWID",
"OBJECT_ID", "OBJECT_NAME", "SCHEMA_NAME", "DB_NAME",
"SCOPE_IDENTITY", "@@IDENTITY", "@@ROWCOUNT"
],
dataTypes: [
"INT", "INTEGER", "TINYINT", "SMALLINT", "BIGINT",
"DECIMAL", "NUMERIC", "FLOAT", "REAL", "MONEY", "SMALLMONEY",
"CHAR", "VARCHAR", "NCHAR", "NVARCHAR", "TEXT", "NTEXT",
"BINARY", "VARBINARY", "IMAGE",
"DATE", "TIME", "DATETIME", "DATETIME2", "SMALLDATETIME", "DATETIMEOFFSET",
"BIT", "UNIQUEIDENTIFIER", "XML", "SQL_VARIANT",
"ROWVERSION", "TIMESTAMP", "HIERARCHYID"
],
tableOptions: [
"ON", "CLUSTERED", "NONCLUSTERED", "WITH", "TEXTIMAGE_ON"
],
regexSyntax: .unsupported,
booleanLiteralStyle: .numeric,
likeEscapeStyle: .explicit,
paginationStyle: .offsetFetch,
autoLimitStyle: .top
)
static let supportsDropDatabase = true
func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
MSSQLPluginDriver(config: config)
}
}
// MARK: - Global FreeTDS initialization
/// Per-connection error storage keyed by DBPROCESS pointer.
/// Falls back to a global error string when the DBPROCESS is nil (pre-connection errors).
private let freetdsErrorLock = NSLock()
private var freetdsConnectionErrors: [UnsafeRawPointer: String] = [:]
private var freetdsGlobalError = ""
private func freetdsGetError(for dbproc: UnsafeMutablePointer<DBPROCESS>?) -> String {
freetdsErrorLock.lock()
defer { freetdsErrorLock.unlock() }
if let dbproc {
return freetdsConnectionErrors[UnsafeRawPointer(dbproc)] ?? freetdsGlobalError
}
return freetdsGlobalError
}
private func freetdsClearError(for dbproc: UnsafeMutablePointer<DBPROCESS>?) {
freetdsErrorLock.lock()
defer { freetdsErrorLock.unlock() }
if let dbproc {
freetdsConnectionErrors[UnsafeRawPointer(dbproc)] = nil
} else {
freetdsGlobalError = ""
}
}
private func freetdsSetError(_ msg: String, for dbproc: UnsafeMutablePointer<DBPROCESS>?, overwrite: Bool = false) {
freetdsErrorLock.lock()
defer { freetdsErrorLock.unlock() }
if let dbproc {
let key = UnsafeRawPointer(dbproc)
if overwrite || (freetdsConnectionErrors[key]?.isEmpty ?? true) {
freetdsConnectionErrors[key] = msg
}
} else if overwrite || freetdsGlobalError.isEmpty {
freetdsGlobalError = msg
}
}
private func freetdsUnregister(_ dbproc: UnsafeMutablePointer<DBPROCESS>) {
freetdsErrorLock.lock()
defer { freetdsErrorLock.unlock() }
freetdsConnectionErrors.removeValue(forKey: UnsafeRawPointer(dbproc))
}
private let freetdsLogger = Logger(subsystem: "com.TablePro", category: "FreeTDSConnection")
private let freetdsInitOnce: Void = {
_ = dbinit()
_ = dberrhandle { dbproc, _, dberr, _, dberrstr, oserrstr in
var msg = "db-lib error \(dberr)"
if let s = dberrstr { msg += ": \(String(cString: s))" }
if let s = oserrstr, String(cString: s) != "Success" { msg += " (os: \(String(cString: s)))" }
freetdsLogger.error("FreeTDS: \(msg)")
freetdsSetError(msg, for: dbproc)
return INT_CANCEL
}
_ = dbmsghandle { dbproc, msgno, _, severity, msgtext, _, _, _ in
guard let text = msgtext else { return 0 }
let msg = String(cString: text)
if severity > 10 {
// SQL Server sends informational messages first, error messages last —
// overwrite so the most specific error is kept
freetdsSetError(msg, for: dbproc, overwrite: true)
freetdsLogger.error("FreeTDS msg \(msgno) sev \(severity): \(msg)")
} else {
freetdsLogger.debug("FreeTDS msg \(msgno): \(msg)")
}
return 0
}
}()
// MARK: - FreeTDS Connection
private struct FreeTDSQueryResult {
let columns: [String]
let columnTypeNames: [String]
let rows: [[PluginCellValue]]
let affectedRows: Int
let isTruncated: Bool
}
private final class FreeTDSConnection: @unchecked Sendable {
private var dbproc: UnsafeMutablePointer<DBPROCESS>?
private let queue: DispatchQueue
private let host: String
private let port: Int
private let user: String
private let password: String
private let database: String
private let lock = NSLock()
private var _isConnected = false
private var _isCancelled = false
var isConnected: Bool {
lock.lock()
defer { lock.unlock() }
return _isConnected
}
init(host: String, port: Int, user: String, password: String, database: String) {
self.queue = DispatchQueue(label: "com.TablePro.freetds.\(host).\(port)", qos: .userInitiated)
self.host = host
self.port = port
self.user = user
self.password = password
self.database = database
_ = freetdsInitOnce
}
func connect() async throws {
try await pluginDispatchAsync(on: queue) { [self] in
try self.connectSync()
}
}
private func connectSync() throws {
guard let login = dblogin() else {
throw MSSQLPluginError.connectionFailed("Failed to create login")
}
defer { dbloginfree(login) }
_ = dbsetlname(login, user, Int32(DBSETUSER))
_ = dbsetlname(login, password, Int32(DBSETPWD))
_ = dbsetlname(login, "TablePro", Int32(DBSETAPP))
_ = dbsetlname(login, "us_english", Int32(DBSETNATLANG))
_ = dbsetlname(login, "UTF-8", Int32(DBSETCHARSET))
_ = dbsetlversion(login, UInt8(DBVERSION_74))
freetdsClearError(for: nil)
let serverName = "\(host):\(port)"
guard let proc = dbopen(login, serverName) else {
let detail = freetdsGetError(for: nil)
let msg = detail.isEmpty ? "Check host, port, and credentials" : detail
throw MSSQLPluginError.connectionFailed("Failed to connect to \(host):\(port) — \(msg)")
}
if !database.isEmpty {
if dbuse(proc, database) == FAIL {
_ = dbclose(proc)
throw MSSQLPluginError.connectionFailed("Cannot open database '\(database)'")
}
}
self.dbproc = proc
lock.lock()
_isConnected = true
lock.unlock()
}
func switchDatabase(_ database: String) async throws {
try await pluginDispatchAsync(on: queue) { [self] in
guard let proc = self.dbproc else {
throw MSSQLPluginError.notConnected
}
if dbuse(proc, database) == FAIL {
throw MSSQLPluginError.queryFailed("Cannot switch to database '\(database)'")
}
}
}
func disconnect() {
let handle = dbproc
dbproc = nil
lock.lock()
_isConnected = false
lock.unlock()
if let handle = handle {
freetdsUnregister(handle)
queue.async {
_ = dbclose(handle)
}
}
}
func cancelCurrentQuery() {
lock.lock()
_isCancelled = true
let proc = dbproc
lock.unlock()
guard let proc else { return }
dbcancel(proc)
}
func executeQuery(_ query: String) async throws -> FreeTDSQueryResult {
let queryToRun = String(query)
return try await pluginDispatchAsync(on: queue) { [self] in
try self.executeQuerySync(queryToRun)
}
}
private func executeQuerySync(_ query: String) throws -> FreeTDSQueryResult {
guard let proc = dbproc else {
throw MSSQLPluginError.notConnected
}
_ = dbcanquery(proc)
lock.lock()
_isCancelled = false
lock.unlock()
freetdsClearError(for: proc)
if dbcmd(proc, query) == FAIL {
throw MSSQLPluginError.queryFailed("Failed to prepare query")
}
if dbsqlexec(proc) == FAIL {
let detail = freetdsGetError(for: proc)
let msg = detail.isEmpty ? "Query execution failed" : detail
throw MSSQLPluginError.queryFailed(msg)
}
var allColumns: [String] = []
var allTypeNames: [String] = []
var allRows: [[PluginCellValue]] = []
var firstResultSet = true
var truncated = false
while true {
lock.lock()
let cancelledBetweenResults = _isCancelled
if cancelledBetweenResults { _isCancelled = false }
lock.unlock()
if cancelledBetweenResults {
throw CancellationError()
}
let resCode = dbresults(proc)
if resCode == FAIL {
throw MSSQLPluginError.queryFailed("Query execution failed")
}
if resCode == Int32(NO_MORE_RESULTS) {
break
}
let numCols = dbnumcols(proc)
if numCols <= 0 { continue }
var cols: [String] = []
var typeNames: [String] = []
for i in 1...numCols {
let name = dbcolname(proc, Int32(i)).map { String(cString: $0) } ?? "col\(i)"
cols.append(name)
typeNames.append(Self.freetdsTypeName(dbcoltype(proc, Int32(i))))
}
if firstResultSet {
allColumns = cols
allTypeNames = typeNames
firstResultSet = false
}
while true {
let rowCode = dbnextrow(proc)
if rowCode == Int32(NO_MORE_ROWS) { break }
if rowCode == FAIL { break }
lock.lock()
let cancelled = _isCancelled
if cancelled { _isCancelled = false }
lock.unlock()
if cancelled {
throw CancellationError()
}
var row: [PluginCellValue] = []
for i in 1...numCols {
let len = dbdatlen(proc, Int32(i))
let colType = dbcoltype(proc, Int32(i))
if len <= 0 && colType != Int32(SYBBIT) {
row.append(.null)
} else if let ptr = dbdata(proc, Int32(i)) {
if Self.isBinaryType(colType) {
row.append(.bytes(Data(bytes: ptr, count: Int(len))))
} else {
let str = Self.columnValueAsString(proc: proc, ptr: ptr, srcType: colType, srcLen: len)
row.append(PluginCellValue.fromOptional(str))
}
} else {
row.append(.null)
}
}
allRows.append(row)
if allRows.count >= PluginRowLimits.emergencyMax {
truncated = true
break
}
}
}
let affectedRows = allColumns.isEmpty ? 0 : allRows.count
return FreeTDSQueryResult(
columns: allColumns,
columnTypeNames: allTypeNames,
rows: allRows,
affectedRows: affectedRows,
isTruncated: truncated
)
}
func streamQuery(
_ query: String,
continuation: AsyncThrowingStream<PluginStreamElement, Error>.Continuation
) async throws {
let queryToRun = String(query)
try await pluginDispatchAsync(on: queue) { [self] in
try self.streamQuerySync(queryToRun, continuation: continuation)
}
}
private func streamQuerySync(
_ query: String,
continuation: AsyncThrowingStream<PluginStreamElement, Error>.Continuation
) throws {
guard let proc = dbproc else {
throw MSSQLPluginError.notConnected
}
_ = dbcanquery(proc)
lock.lock()
_isCancelled = false
lock.unlock()
freetdsClearError(for: proc)
if dbcmd(proc, query) == FAIL {
throw MSSQLPluginError.queryFailed("Failed to prepare query")
}
if dbsqlexec(proc) == FAIL {
let detail = freetdsGetError(for: proc)
let msg = detail.isEmpty ? "Query execution failed" : detail
throw MSSQLPluginError.queryFailed(msg)
}
var headerSent = false
while true {
lock.lock()
let cancelledBetweenResults = _isCancelled || Task.isCancelled
if cancelledBetweenResults { _isCancelled = false }
lock.unlock()
if cancelledBetweenResults {
continuation.finish(throwing: CancellationError())
return
}
let resCode = dbresults(proc)
if resCode == FAIL {
continuation.finish(throwing: MSSQLPluginError.queryFailed("Query execution failed"))
return
}
if resCode == Int32(NO_MORE_RESULTS) {
break
}
let numCols = dbnumcols(proc)
if numCols <= 0 { continue }
if !headerSent {
var cols: [String] = []
var typeNames: [String] = []
for i in 1...numCols {
let name = dbcolname(proc, Int32(i)).map { String(cString: $0) } ?? "col\(i)"
cols.append(name)
typeNames.append(Self.freetdsTypeName(dbcoltype(proc, Int32(i))))
}
continuation.yield(.header(PluginStreamHeader(
columns: cols,
columnTypeNames: typeNames,
estimatedRowCount: nil
)))
headerSent = true
}
let batchSize = 5_000
var batch: [PluginRow] = []
batch.reserveCapacity(batchSize)
while true {
let rowCode = dbnextrow(proc)
if rowCode == Int32(NO_MORE_ROWS) { break }
if rowCode == FAIL { break }
lock.lock()
let cancelled = _isCancelled || Task.isCancelled
if cancelled { _isCancelled = false }
lock.unlock()
if cancelled {
if !batch.isEmpty {
continuation.yield(.rows(batch))
}
continuation.finish(throwing: CancellationError())
return
}
var row: [PluginCellValue] = []
for i in 1...numCols {
let len = dbdatlen(proc, Int32(i))
let colType = dbcoltype(proc, Int32(i))
if len <= 0 && colType != Int32(SYBBIT) {
row.append(.null)
} else if let ptr = dbdata(proc, Int32(i)) {
if Self.isBinaryType(colType) {
row.append(.bytes(Data(bytes: ptr, count: Int(len))))
} else {
let str = Self.columnValueAsString(proc: proc, ptr: ptr, srcType: colType, srcLen: len)
row.append(PluginCellValue.fromOptional(str))
}
} else {
row.append(.null)
}
}
batch.append(row)
if batch.count >= batchSize {
continuation.yield(.rows(batch))
batch.removeAll(keepingCapacity: true)
}
}
if !batch.isEmpty {
continuation.yield(.rows(batch))
}
}
continuation.finish()
}
private static func isBinaryType(_ srcType: Int32) -> Bool {
switch srcType {
case Int32(SYBBINARY), Int32(SYBVARBINARY), Int32(SYBIMAGE):
return true
default:
return false
}
}
private static func columnValueAsString(proc: UnsafeMutablePointer<DBPROCESS>, ptr: UnsafePointer<BYTE>, srcType: Int32, srcLen: DBINT) -> String? {
switch srcType {
case Int32(SYBCHAR), Int32(SYBVARCHAR), Int32(SYBTEXT):
return String(bytes: UnsafeBufferPointer(start: ptr, count: Int(srcLen)), encoding: .utf8)
?? String(bytes: UnsafeBufferPointer(start: ptr, count: Int(srcLen)), encoding: .isoLatin1)
case Int32(SYBNCHAR), Int32(SYBNVARCHAR), Int32(SYBNTEXT):
// With client charset UTF-8, FreeTDS converts UTF-16 wire data to UTF-8
// but may still report the original nvarchar type token
return String(bytes: UnsafeBufferPointer(start: ptr, count: Int(srcLen)), encoding: .utf8)
?? String(data: Data(bytes: ptr, count: Int(srcLen)), encoding: .utf16LittleEndian)
default:
let bufSize: DBINT = 256
var buf = [BYTE](repeating: 0, count: Int(bufSize))
let converted = buf.withUnsafeMutableBufferPointer { bufPtr in
dbconvert(proc, srcType, ptr, srcLen, Int32(SYBCHAR), bufPtr.baseAddress, bufSize)
}
guard converted > 0,
let raw = String(bytes: buf.prefix(Int(converted)), encoding: .utf8)
else { return nil }
return MSSQLDatetimeFormatter.reformat(raw, srcType: srcType) ?? raw
}
}
private static func freetdsTypeName(_ type: Int32) -> String {
switch type {
case Int32(SYBCHAR), Int32(SYBVARCHAR): return "varchar"
case Int32(SYBNCHAR), Int32(SYBNVARCHAR): return "nvarchar"
case Int32(SYBTEXT): return "text"
case Int32(SYBNTEXT): return "ntext"
case Int32(SYBINT1): return "tinyint"
case Int32(SYBINT2): return "smallint"
case Int32(SYBINT4): return "int"
case Int32(SYBINT8): return "bigint"
case Int32(SYBFLT8): return "float"
case Int32(SYBREAL): return "real"
case Int32(SYBDECIMAL), Int32(SYBNUMERIC): return "decimal"
case Int32(SYBMONEY), Int32(SYBMONEY4): return "money"
case Int32(SYBBIT): return "bit"
case Int32(SYBBINARY), Int32(SYBVARBINARY): return "varbinary"
case Int32(SYBIMAGE): return "image"
case Int32(SYBDATETIME), Int32(SYBDATETIMN): return "datetime"
case Int32(SYBDATETIME4): return "smalldatetime"
case Int32(SYBUNIQUE): return "uniqueidentifier"
default: return "unknown"
}
}
}
// MARK: - Datetime Reformatting
/// Reformats FreeTDS msdblib datetime output into ISO 8601 so values round-trip
/// through SQL Server's implicit string-to-datetime conversion.
///
/// FreeTDS dbconvert(... SYBCHAR) emits legacy datetime values as
/// "MMM d yyyy h:mm[:ss[:fffffff]]AM/PM" (msdblib mode). SQL Server's parser
/// rejects that format on subsequent UPDATE/WHERE binding. ISO 8601
/// (yyyy-MM-dd HH:mm:ss[.fffffff]) parses everywhere and preserves the original
/// fractional digits exactly without Foundation.Date precision loss.
internal enum MSSQLDatetimeFormatter {
/// Reformats a FreeTDS-emitted column value when the source type is one of
/// SQL Server's datetime variants. Returns nil for non-datetime types so the
/// caller falls back to the raw FreeTDS string.
static func reformat(_ raw: String, srcType: Int32) -> String? {
switch srcType {
case Int32(SYBDATETIME), Int32(SYBDATETIME4), Int32(SYBDATETIMN):
break
case 40, 41, 42:
// SYBMSDATE (40), SYBMSTIME (41), SYBMSDATETIME2 (42) from TDS 7.3+.
// Constants are not declared in the CFreeTDS stub header; matched
// by raw value. SYBMSDATETIMEOFFSET (43) is intentionally excluded
// because the offset suffix format is not verified.
break
default:
return nil
}
return parse(raw)
}
/// Returns ISO 8601 if the input is recognized, nil otherwise. Already-ISO
/// inputs pass through verbatim. Public so tests can exercise it directly.
static func parse(_ raw: String) -> String? {
let trimmed = raw.trimmingCharacters(in: .whitespacesAndNewlines)
guard !trimmed.isEmpty else { return nil }
if isAlreadyISO(trimmed) {
return trimmed
}
return parseLegacyAMPM(trimmed)
}
/// FreeTDS emits "yyyy-MM-dd ..." for some TDS 7.3+ types. Detect the prefix
/// and pass through, since the rest of the value is already SQL Server parseable.
static func isAlreadyISO(_ s: String) -> Bool {
let chars = Array(s)
guard chars.count >= 10 else { return false }
return chars[0].isASCIIDigit && chars[1].isASCIIDigit
&& chars[2].isASCIIDigit && chars[3].isASCIIDigit
&& chars[4] == "-"
&& chars[5].isASCIIDigit && chars[6].isASCIIDigit
&& chars[7] == "-"
&& chars[8].isASCIIDigit && chars[9].isASCIIDigit
}
/// Parses "MMM d yyyy h:mm[:ss[:fff[fffff]]] AM|PM" (msdblib 12-hour) or the
/// 24-hour variant without an AM/PM marker. Returns ISO 8601 with fractional
/// digits preserved verbatim.
private static func parseLegacyAMPM(_ raw: String) -> String? {
let scanner = Scanner(string: raw)
scanner.charactersToBeSkipped = nil
_ = scanner.scanCharacters(from: .whitespaces)
guard let monthToken = scanner.scanCharacters(from: .letters),
monthToken.count >= 3,
let month = monthNamesByPrefix[String(monthToken.prefix(3))]
else { return nil }
_ = scanner.scanCharacters(from: .whitespaces)
guard let day = scanner.scanInt(), (1...31).contains(day) else { return nil }
_ = scanner.scanCharacters(from: .whitespaces)
guard let year = scanner.scanInt(), (1...9999).contains(year) else { return nil }
_ = scanner.scanCharacters(from: .whitespaces)
guard var hour = scanner.scanInt() else { return nil }
var minute = 0
var second = 0
var fractional = ""
if scanner.scanString(":") != nil {
guard let m = scanner.scanInt(), (0...59).contains(m) else { return nil }
minute = m
}
if scanner.scanString(":") != nil {
guard let s = scanner.scanInt(), (0...59).contains(s) else { return nil }
second = s
}
if scanner.scanString(":") != nil || scanner.scanString(".") != nil {
fractional = scanner.scanCharacters(from: .decimalDigits) ?? ""
}
_ = scanner.scanCharacters(from: .whitespaces)
let ampm = scanner.scanCharacters(from: .letters)?.uppercased()
if let ampm {
guard ampm == "AM" || ampm == "PM" else { return nil }
guard (1...12).contains(hour) else { return nil }
if ampm == "PM", hour < 12 {
hour += 12
} else if ampm == "AM", hour == 12 {
hour = 0
}
} else {
guard (0...23).contains(hour) else { return nil }
}
var iso = String(format: "%04d-%02d-%02d %02d:%02d:%02d", year, month, day, hour, minute, second)
if !fractional.isEmpty {
iso += "." + fractional
}
return iso
}
private static let monthNamesByPrefix: [String: Int] = [
"Jan": 1, "Feb": 2, "Mar": 3, "Apr": 4, "May": 5, "Jun": 6,
"Jul": 7, "Aug": 8, "Sep": 9, "Oct": 10, "Nov": 11, "Dec": 12
]
}
private extension Character {
var isASCIIDigit: Bool { isASCII && isNumber }
}
// MARK: - MSSQL Plugin Driver
final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
private let config: DriverConnectionConfig
private var freeTDSConn: FreeTDSConnection?
private var _currentSchema: String
private var _serverVersion: String?
/// IDENTITY columns observed during `fetchColumns`, keyed by table name.
/// `generateMssqlInsert` reads this to skip IDENTITY columns: SQL Server
/// rejects explicit values for IDENTITY columns unless IDENTITY_INSERT is ON,
/// and the value the user typed is server-allocated anyway.
private var identityColumnsByTable: [String: Set<String>] = [:]
private let identityCacheLock = NSLock()
private static let logger = Logger(subsystem: "com.TablePro", category: "MSSQLPluginDriver")
var currentSchema: String? { _currentSchema }
var serverVersion: String? { _serverVersion }
var supportsSchemas: Bool { true }
var supportsTransactions: Bool { true }
var capabilities: PluginCapabilities {
[
.parameterizedQueries,
.transactions,
.alterTableDDL,
.multiSchema,
.cancelQuery,
.batchExecute,
]
}
func quoteIdentifier(_ name: String) -> String {
let escaped = name.replacingOccurrences(of: "]", with: "]]")
return "[\(escaped)]"
}
// MARK: - View Templates
func createViewTemplate() -> String? {
if MSSQLCapabilities.parse(serverVersion).hasCreateOrAlterView {
return "CREATE OR ALTER VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
}
return "CREATE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
}
func editViewFallbackTemplate(viewName: String) -> String? {
let quoted = quoteIdentifier(viewName)
if MSSQLCapabilities.parse(serverVersion).hasCreateOrAlterView {
return "CREATE OR ALTER VIEW \(quoted) AS\nSELECT * FROM table_name;"
}
return "IF OBJECT_ID('\(viewName)', 'V') IS NOT NULL DROP VIEW \(quoted);\nCREATE VIEW \(quoted) AS\nSELECT * FROM table_name;"
}
func castColumnToText(_ column: String) -> String {
"CAST(\(column) AS NVARCHAR(MAX))"
}
init(config: DriverConnectionConfig) {
self.config = config
self._currentSchema = config.additionalFields["mssqlSchema"]?.isEmpty == false
? config.additionalFields["mssqlSchema"]!
: "dbo"
}
private var escapedSchema: String {
_currentSchema.replacingOccurrences(of: "'", with: "''")
}
// MARK: - Connection
func connect() async throws {
let conn = FreeTDSConnection(
host: config.host,
port: config.port,
user: config.username,
password: config.password,
database: config.database
)
try await conn.connect()
self.freeTDSConn = conn
if let result = try? await conn.executeQuery("SELECT SCHEMA_NAME()"),
let serverSchema = result.rows.first?.first?.asText,
!serverSchema.isEmpty {
_currentSchema = serverSchema
} else {
Self.logger.warning("SELECT SCHEMA_NAME() returned no value; keeping \(self._currentSchema, privacy: .public)")
}
let formSchema = config.additionalFields["mssqlSchema"]
if let formSchema, !formSchema.isEmpty, formSchema != _currentSchema {
_currentSchema = formSchema
}
if let result = try? await conn.executeQuery("SELECT @@VERSION"),
let versionStr = result.rows.first?.first?.asText {
_serverVersion = String(versionStr.prefix(50))
}
}
func disconnect() {
freeTDSConn?.disconnect()
freeTDSConn = nil
}
func ping() async throws {
_ = try await execute(query: "SELECT 1")
}
// MARK: - Transaction Management
func beginTransaction() async throws {
_ = try await execute(query: "BEGIN TRANSACTION")
}
// MARK: - Query Execution
func execute(query: String) async throws -> PluginQueryResult {
guard let conn = freeTDSConn else {
throw MSSQLPluginError.notConnected
}
let startTime = Date()
let result = try await conn.executeQuery(query)
return PluginQueryResult(
columns: result.columns,
columnTypeNames: result.columnTypeNames,
rows: result.rows,
rowsAffected: result.affectedRows,
executionTime: Date().timeIntervalSince(startTime),
isTruncated: result.isTruncated
)
}
// MARK: - DML Statement Generation
func generateStatements(
table: String,
columns: [String],
primaryKeyColumns: [String],
changes: [PluginRowChange],
insertedRowData: [Int: [PluginCellValue]],
deletedRowIndices: Set<Int>,
insertedRowIndices: Set<Int>
) -> [(statement: String, parameters: [PluginCellValue])]? {
var statements: [(statement: String, parameters: [PluginCellValue])] = []
var deleteChanges: [PluginRowChange] = []
for change in changes {
switch change.type {
case .insert:
guard insertedRowIndices.contains(change.rowIndex) else { continue }
if let values = insertedRowData[change.rowIndex] {
if let stmt = generateMssqlInsert(table: table, columns: columns, values: values) {
statements.append(stmt)
}
}
case .update:
if let stmt = generateMssqlUpdate(
table: table, columns: columns,
primaryKeyColumns: primaryKeyColumns, change: change
) {
statements.append(stmt)
}
case .delete:
guard deletedRowIndices.contains(change.rowIndex) else { continue }
deleteChanges.append(change)
}
}
if !deleteChanges.isEmpty {
for change in deleteChanges {
if let stmt = generateMssqlDelete(
table: table, columns: columns,
primaryKeyColumns: primaryKeyColumns, change: change
) {
statements.append(stmt)
}
}
}
return statements.isEmpty ? nil : statements
}
private func generateMssqlInsert(
table: String,
columns: [String],
values: [PluginCellValue]
) -> (statement: String, parameters: [PluginCellValue])? {
var nonDefaultColumns: [String] = []
var parameters: [PluginCellValue] = []
let identityColumns = cachedIdentityColumns(for: table)
for (index, value) in values.enumerated() {
if value.asText == "__DEFAULT__" { continue }
guard index < columns.count else { continue }
let columnName = columns[index]
// SQL Server IDENTITY columns are server-allocated. INSERTs that include
// an explicit value fail unless `SET IDENTITY_INSERT <table> ON` was issued,
// so always omit them and let the server assign the next value.
if identityColumns.contains(columnName) { continue }
nonDefaultColumns.append("[\(columnName.replacingOccurrences(of: "]", with: "]]"))]")
parameters.append(value)
}
guard !nonDefaultColumns.isEmpty else { return nil }
let columnList = nonDefaultColumns.joined(separator: ", ")
let placeholders = parameters.map { _ in "?" }.joined(separator: ", ")
let escapedTable = "[\(table.replacingOccurrences(of: "]", with: "]]"))]"
let sql = "INSERT INTO \(escapedTable) (\(columnList)) VALUES (\(placeholders))"
return (statement: sql, parameters: parameters)
}
private func generateMssqlUpdate(
table: String,
columns: [String],
primaryKeyColumns: [String],
change: PluginRowChange
) -> (statement: String, parameters: [PluginCellValue])? {
guard !change.cellChanges.isEmpty else { return nil }
guard let originalRow = change.originalRow else { return nil }
let escapedTable = "[\(table.replacingOccurrences(of: "]", with: "]]"))]"
var parameters: [PluginCellValue] = []
let setClauses = change.cellChanges.map { cellChange -> String in
let col = "[\(cellChange.columnName.replacingOccurrences(of: "]", with: "]]"))]"
parameters.append(cellChange.newValue)
return "\(col) = ?"
}.joined(separator: ", ")
let whereColumns: [String] = primaryKeyColumns.isEmpty ? columns : primaryKeyColumns
var conditions: [String] = []
for whereColumn in whereColumns {
guard let columnIndex = columns.firstIndex(of: whereColumn),
columnIndex < originalRow.count
else { continue }
let col = "[\(whereColumn.replacingOccurrences(of: "]", with: "]]"))]"
let value = originalRow[columnIndex]
if value.isNull {
conditions.append("\(col) IS NULL")
} else {
parameters.append(value)
conditions.append("\(col) = ?")
}
}
guard !conditions.isEmpty else { return nil }
let whereClause = conditions.joined(separator: " AND ")
let topClause = primaryKeyColumns.isEmpty ? "TOP (1) " : ""
let sql = "UPDATE \(topClause)\(escapedTable) SET \(setClauses) WHERE \(whereClause)"
return (statement: sql, parameters: parameters)
}
private func generateMssqlDelete(
table: String,
columns: [String],
primaryKeyColumns: [String],
change: PluginRowChange
) -> (statement: String, parameters: [PluginCellValue])? {
guard let originalRow = change.originalRow else { return nil }
let escapedTable = "[\(table.replacingOccurrences(of: "]", with: "]]"))]"
var parameters: [PluginCellValue] = []
var conditions: [String] = []
let whereColumns: [String] = primaryKeyColumns.isEmpty ? columns : primaryKeyColumns
for whereColumn in whereColumns {
guard let columnIndex = columns.firstIndex(of: whereColumn),
columnIndex < originalRow.count
else { continue }
let col = "[\(whereColumn.replacingOccurrences(of: "]", with: "]]"))]"
let value = originalRow[columnIndex]
if value.isNull {
conditions.append("\(col) IS NULL")
} else {
parameters.append(value)
conditions.append("\(col) = ?")
}
}