Skip to content

Commit 77f1998

Browse files
datlechindatlechin
committed
feat: move SQL dialect behaviors into plugin system (#298)
1 parent 826b4d7 commit 77f1998

39 files changed

Lines changed: 464 additions & 372 deletions

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- Moved string literal escaping into plugin drivers via `escapeStringLiteral` on `PluginDatabaseDriver` and `DatabaseDriver` protocols; `SQLEscaping.escapeStringLiteral` now uses ANSI SQL escaping only (doubles single quotes, strips null bytes)
1313
- SQL autocomplete data types and CREATE TABLE options now use plugin-provided dialect data instead of hardcoded per-database switches
1414
- `FilterSQLGenerator` now uses `SQLDialectDescriptor` data (regex syntax, boolean literals, LIKE escape style, pagination style) instead of `DatabaseType` switch statements
15+
- Moved identifier quoting, autocomplete statement completions, view templates, and FK disable/enable into plugin system
16+
- Removed `DatabaseType` switches from `FilterSQLGenerator`, `SQLCompletionProvider`, `ImportDataSinkAdapter`, and `MainContentCoordinator+SidebarActions`
1517

1618
### Added
1719

1820
- `SQLDialectDescriptor` in TableProPluginKit: plugins can now self-describe their SQL dialect (keywords, functions, data types, identifier quoting), with `SQLDialectFactory` preferring plugin-provided dialect info over built-in structs
1921
- DDL schema generation protocol in TableProPluginKit: plugins can now optionally provide database-specific ALTER TABLE syntax (ADD/MODIFY/DROP COLUMN, ADD/DROP INDEX, ADD/DROP FK, MODIFY PK) via `PluginDatabaseDriver`, with `SchemaStatementGenerator` trying plugin methods first before falling back to built-in logic
2022
- Plugin-provided table operations: `truncateTableStatements`, `dropObjectStatement`, `foreignKeyDisableStatements`, `foreignKeyEnableStatements` in `PluginDatabaseDriver` protocol, allowing plugins to override TRUNCATE, DROP, and FK handling SQL
23+
- `CompletionEntry` struct and `statementCompletions` on `DriverPlugin` for plugin-provided autocomplete entries (MongoDB MQL methods, Redis commands)
24+
- `offsetFetchOrderBy` property on `SQLDialectDescriptor` for plugin-controlled ORDER BY in OFFSET/FETCH pagination
25+
- `createViewTemplate()`, `editViewFallbackTemplate(viewName:)`, and `castColumnToText(_:)` on `PluginDatabaseDriver` for plugin-provided view DDL templates and column casting
2126
- `buildExplainQuery` method in `PluginDatabaseDriver` protocol: plugins can now provide database-specific EXPLAIN syntax, with coordinator falling back to built-in logic when plugin returns nil
2227
- `SettablePlugin` protocol in TableProPluginKit SDK: unified settings pattern for all plugins with automatic persistence via `loadSettings()`/`saveSettings()`, replacing duplicated boilerplate across export/import/driver plugins
2328
- Plugin UI/capability metadata: each driver plugin now self-declares brand color, connection mode, supported features, column types, URL schemes, and grouping strategy via the `DriverPlugin` protocol

‎Plugins/ClickHouseDriverPlugin/ClickHousePlugin.swift‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -724,6 +724,16 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
724724
"EXPLAIN \(sql)"
725725
}
726726

727+
// MARK: - View Templates
728+
729+
func createViewTemplate() -> String? {
730+
"CREATE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
731+
}
732+
733+
func editViewFallbackTemplate(viewName: String) -> String? {
734+
"ALTER VIEW \(viewName) AS\nSELECT * FROM table_name;"
735+
}
736+
727737
// MARK: - Kill Query
728738

729739
private func killQuery(queryId: String) {

‎Plugins/DuckDBDriverPlugin/DuckDBPlugin.swift‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -821,6 +821,16 @@ final class DuckDBPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
821821
"EXPLAIN \(sql)"
822822
}
823823

824+
// MARK: - View Templates
825+
826+
func createViewTemplate() -> String? {
827+
"CREATE OR REPLACE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
828+
}
829+
830+
func editViewFallbackTemplate(viewName: String) -> String? {
831+
"CREATE OR REPLACE VIEW \(viewName) AS\nSELECT * FROM table_name;"
832+
}
833+
824834
// MARK: - Private Helpers
825835

826836
nonisolated private func setInterruptHandle(_ handle: duckdb_connection?) {

‎Plugins/MSSQLDriverPlugin/MSSQLPlugin.swift‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,20 @@ final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
428428
return "[\(escaped)]"
429429
}
430430

431+
// MARK: - View Templates
432+
433+
func createViewTemplate() -> String? {
434+
"CREATE OR ALTER VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
435+
}
436+
437+
func editViewFallbackTemplate(viewName: String) -> String? {
438+
"CREATE OR ALTER VIEW \(viewName) AS\nSELECT * FROM table_name;"
439+
}
440+
441+
func castColumnToText(_ column: String) -> String {
442+
"CAST(\(column) AS NVARCHAR(MAX))"
443+
}
444+
431445
init(config: DriverConnectionConfig) {
432446
self.config = config
433447
self._currentSchema = config.additionalFields["mssqlSchema"]?.isEmpty == false

‎Plugins/MongoDBDriverPlugin/MongoDBPlugin.swift‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,33 @@ final class MongoDBPlugin: NSObject, TableProPlugin, DriverPlugin {
6868

6969
static let sqlDialect: SQLDialectDescriptor? = nil
7070

71+
static var statementCompletions: [CompletionEntry] {
72+
[
73+
CompletionEntry(label: "db.", insertText: "db."),
74+
CompletionEntry(label: "db.runCommand", insertText: "db.runCommand"),
75+
CompletionEntry(label: "db.adminCommand", insertText: "db.adminCommand"),
76+
CompletionEntry(label: "db.createView", insertText: "db.createView"),
77+
CompletionEntry(label: "db.createCollection", insertText: "db.createCollection"),
78+
CompletionEntry(label: "show dbs", insertText: "show dbs"),
79+
CompletionEntry(label: "show collections", insertText: "show collections"),
80+
CompletionEntry(label: ".find", insertText: ".find"),
81+
CompletionEntry(label: ".findOne", insertText: ".findOne"),
82+
CompletionEntry(label: ".aggregate", insertText: ".aggregate"),
83+
CompletionEntry(label: ".insertOne", insertText: ".insertOne"),
84+
CompletionEntry(label: ".insertMany", insertText: ".insertMany"),
85+
CompletionEntry(label: ".updateOne", insertText: ".updateOne"),
86+
CompletionEntry(label: ".updateMany", insertText: ".updateMany"),
87+
CompletionEntry(label: ".deleteOne", insertText: ".deleteOne"),
88+
CompletionEntry(label: ".deleteMany", insertText: ".deleteMany"),
89+
CompletionEntry(label: ".replaceOne", insertText: ".replaceOne"),
90+
CompletionEntry(label: ".findOneAndUpdate", insertText: ".findOneAndUpdate"),
91+
CompletionEntry(label: ".findOneAndReplace", insertText: ".findOneAndReplace"),
92+
CompletionEntry(label: ".findOneAndDelete", insertText: ".findOneAndDelete"),
93+
CompletionEntry(label: ".countDocuments", insertText: ".countDocuments"),
94+
CompletionEntry(label: ".createIndex", insertText: ".createIndex"),
95+
]
96+
}
97+
7198
func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
7299
MongoDBPluginDriver(config: config)
73100
}

‎Plugins/MongoDBDriverPlugin/MongoDBPluginDriver.swift‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,16 @@ final class MongoDBPluginDriver: PluginDatabaseDriver {
499499
}
500500
}
501501

502+
// MARK: - View Templates
503+
504+
func createViewTemplate() -> String? {
505+
"db.createView(\"view_name\", \"source_collection\", [\n {\"$match\": {}},\n {\"$project\": {\"_id\": 1}}\n])"
506+
}
507+
508+
func editViewFallbackTemplate(viewName: String) -> String? {
509+
"db.runCommand({\"collMod\": \"\(viewName)\", \"viewOn\": \"source_collection\", \"pipeline\": [{\"$match\": {}}]})"
510+
}
511+
502512
// MARK: - Query Building
503513

504514
func buildBrowseQuery(

‎Plugins/MySQLDriverPlugin/MySQLPluginDriver.swift‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,30 @@ final class MySQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
602602
"EXPLAIN \(sql)"
603603
}
604604

605+
// MARK: - View Templates
606+
607+
func createViewTemplate() -> String? {
608+
"CREATE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
609+
}
610+
611+
func editViewFallbackTemplate(viewName: String) -> String? {
612+
"ALTER VIEW \(viewName) AS\nSELECT * FROM table_name;"
613+
}
614+
615+
func castColumnToText(_ column: String) -> String {
616+
"CAST(\(column) AS CHAR)"
617+
}
618+
619+
// MARK: - Foreign Key Checks
620+
621+
func foreignKeyDisableStatements() -> [String]? {
622+
["SET FOREIGN_KEY_CHECKS=0"]
623+
}
624+
625+
func foreignKeyEnableStatements() -> [String]? {
626+
["SET FOREIGN_KEY_CHECKS=1"]
627+
}
628+
605629
// MARK: - Private Helpers
606630

607631
private func extractTableName(from query: String) -> String? {

‎Plugins/OracleDriverPlugin/OraclePlugin.swift‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,8 @@ final class OraclePlugin: NSObject, TableProPlugin, DriverPlugin {
8686
regexSyntax: .regexpLike,
8787
booleanLiteralStyle: .numeric,
8888
likeEscapeStyle: .explicit,
89-
paginationStyle: .offsetFetch
89+
paginationStyle: .offsetFetch,
90+
offsetFetchOrderBy: "ORDER BY 1"
9091
)
9192

9293
func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
@@ -111,6 +112,16 @@ final class OraclePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
111112
self.config = config
112113
}
113114

115+
// MARK: - View Templates
116+
117+
func createViewTemplate() -> String? {
118+
"CREATE OR REPLACE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
119+
}
120+
121+
func editViewFallbackTemplate(viewName: String) -> String? {
122+
"CREATE OR REPLACE VIEW \(viewName) AS\nSELECT * FROM table_name;"
123+
}
124+
114125
// MARK: - Connection
115126

116127
func connect() async throws {

‎Plugins/PostgreSQLDriverPlugin/PostgreSQLPluginDriver.swift‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,20 @@ final class PostgreSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
166166
"EXPLAIN \(sql)"
167167
}
168168

169+
// MARK: - View Templates
170+
171+
func createViewTemplate() -> String? {
172+
"CREATE OR REPLACE VIEW view_name AS\nSELECT column1, column2\nFROM table_name\nWHERE condition;"
173+
}
174+
175+
func editViewFallbackTemplate(viewName: String) -> String? {
176+
"CREATE OR REPLACE VIEW \(viewName) AS\nSELECT * FROM table_name;"
177+
}
178+
179+
func castColumnToText(_ column: String) -> String {
180+
"CAST(\(column) AS TEXT)"
181+
}
182+
169183
// MARK: - Schema
170184

171185
func fetchTables(schema: String?) async throws -> [PluginTableInfo] {

‎Plugins/RedisDriverPlugin/RedisPlugin.swift‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,49 @@ final class RedisPlugin: NSObject, TableProPlugin, DriverPlugin {
5858

5959
static let sqlDialect: SQLDialectDescriptor? = nil
6060

61+
static var statementCompletions: [CompletionEntry] {
62+
[
63+
CompletionEntry(label: "GET", insertText: "GET"),
64+
CompletionEntry(label: "SET", insertText: "SET"),
65+
CompletionEntry(label: "DEL", insertText: "DEL"),
66+
CompletionEntry(label: "EXISTS", insertText: "EXISTS"),
67+
CompletionEntry(label: "KEYS", insertText: "KEYS"),
68+
CompletionEntry(label: "HGET", insertText: "HGET"),
69+
CompletionEntry(label: "HSET", insertText: "HSET"),
70+
CompletionEntry(label: "HGETALL", insertText: "HGETALL"),
71+
CompletionEntry(label: "HDEL", insertText: "HDEL"),
72+
CompletionEntry(label: "LPUSH", insertText: "LPUSH"),
73+
CompletionEntry(label: "RPUSH", insertText: "RPUSH"),
74+
CompletionEntry(label: "LRANGE", insertText: "LRANGE"),
75+
CompletionEntry(label: "LLEN", insertText: "LLEN"),
76+
CompletionEntry(label: "SADD", insertText: "SADD"),
77+
CompletionEntry(label: "SMEMBERS", insertText: "SMEMBERS"),
78+
CompletionEntry(label: "SREM", insertText: "SREM"),
79+
CompletionEntry(label: "SCARD", insertText: "SCARD"),
80+
CompletionEntry(label: "ZADD", insertText: "ZADD"),
81+
CompletionEntry(label: "ZRANGE", insertText: "ZRANGE"),
82+
CompletionEntry(label: "ZREM", insertText: "ZREM"),
83+
CompletionEntry(label: "ZSCORE", insertText: "ZSCORE"),
84+
CompletionEntry(label: "EXPIRE", insertText: "EXPIRE"),
85+
CompletionEntry(label: "TTL", insertText: "TTL"),
86+
CompletionEntry(label: "PERSIST", insertText: "PERSIST"),
87+
CompletionEntry(label: "TYPE", insertText: "TYPE"),
88+
CompletionEntry(label: "SCAN", insertText: "SCAN"),
89+
CompletionEntry(label: "HSCAN", insertText: "HSCAN"),
90+
CompletionEntry(label: "SSCAN", insertText: "SSCAN"),
91+
CompletionEntry(label: "ZSCAN", insertText: "ZSCAN"),
92+
CompletionEntry(label: "INFO", insertText: "INFO"),
93+
CompletionEntry(label: "DBSIZE", insertText: "DBSIZE"),
94+
CompletionEntry(label: "FLUSHDB", insertText: "FLUSHDB"),
95+
CompletionEntry(label: "SELECT", insertText: "SELECT"),
96+
CompletionEntry(label: "INCR", insertText: "INCR"),
97+
CompletionEntry(label: "DECR", insertText: "DECR"),
98+
CompletionEntry(label: "APPEND", insertText: "APPEND"),
99+
CompletionEntry(label: "MGET", insertText: "MGET"),
100+
CompletionEntry(label: "MSET", insertText: "MSET"),
101+
]
102+
}
103+
61104
func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
62105
RedisPluginDriver(config: config)
63106
}

0 commit comments

Comments
 (0)