feat: SQL dialect extensibility (#295)

* feat: move SQL dialect behaviors into plugins (#295)

Move identifier quoting, string escaping, filter SQL generation, and
autocomplete data types from DatabaseType switches into plugin-provided
methods and SQLDialectDescriptor data.

* fix: address PR review comments for SQL dialect extensibility

Author: datlechin

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- 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)
+- SQL autocomplete data types and CREATE TABLE options now use plugin-provided dialect data instead of hardcoded per-database switches
+- `FilterSQLGenerator` now uses `SQLDialectDescriptor` data (regex syntax, boolean literals, LIKE escape style, pagination style) instead of `DatabaseType` switch statements
+
 ### Added
 
 - `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
@@ -27,10 +33,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Pre-connect script: run a shell command before each connection (e.g., to refresh credentials or update ~/.pgpass)
 - `ParameterStyle` enum in TableProPluginKit: plugins declare `?` or `$1` placeholder style via `parameterStyle` property on `PluginDatabaseDriver`
 - DML statement generation in ClickHouse, MSSQL, and Oracle plugins via `generateStatements()` for database-specific UPDATE/DELETE syntax
+- `quoteIdentifier` method on `PluginDatabaseDriver` and `DatabaseDriver` protocols: plugins provide database-specific identifier quoting (backticks for MySQL/SQLite/ClickHouse, brackets for MSSQL, double-quotes for PostgreSQL/Oracle/DuckDB, passthrough for MongoDB/Redis)
 
 ### Changed
 
 - Moved MSSQL and Oracle pagination query building (`OFFSET...FETCH NEXT`) from `TableQueryBuilder` into their respective plugin drivers via `buildBrowseQuery`/`buildFilteredQuery`/`buildQuickSearchQuery`/`buildCombinedQuery` hooks
+- Moved identifier quoting from `DatabaseType` into plugin drivers via `quoteIdentifier` method on `PluginDatabaseDriver` protocol, with each plugin providing its own quoting style (backtick, bracket, double-quote, or passthrough)
 
 ### Fixed
 

Plugins/ClickHouseDriverPlugin/ClickHousePlugin.swift

@@ -84,7 +84,14 @@ final class ClickHousePlugin: NSObject, TableProPlugin, DriverPlugin {
             "ENUM8", "ENUM16",
             "IPV4", "IPV6",
             "JSON", "BOOL"
-        ]
+        ],
+        tableOptions: [
+            "ENGINE=MergeTree()", "ORDER BY", "PARTITION BY", "SETTINGS"
+        ],
+        regexSyntax: .match,
+        booleanLiteralStyle: .numeric,
+        likeEscapeStyle: .implicit,
+        paginationStyle: .limit
     )
 
     func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
@@ -134,6 +141,25 @@ final class ClickHousePluginDriver: PluginDatabaseDriver, @unchecked Sendable {
     var serverVersion: String? { _serverVersion }
     var supportsSchemas: Bool { false }
     var supportsTransactions: Bool { false }
+
+    func quoteIdentifier(_ name: String) -> String {
+        let escaped = name.replacingOccurrences(of: "`", with: "``")
+        return "`\(escaped)`"
+    }
+
+    func escapeStringLiteral(_ value: String) -> String {
+        var result = value
+        result = result.replacingOccurrences(of: "\\", with: "\\\\")
+        result = result.replacingOccurrences(of: "'", with: "''")
+        result = result.replacingOccurrences(of: "\n", with: "\\n")
+        result = result.replacingOccurrences(of: "\r", with: "\\r")
+        result = result.replacingOccurrences(of: "\t", with: "\\t")
+        result = result.replacingOccurrences(of: "\0", with: "\\0")
+        result = result.replacingOccurrences(of: "\u{08}", with: "\\b")
+        result = result.replacingOccurrences(of: "\u{0C}", with: "\\f")
+        result = result.replacingOccurrences(of: "\u{1A}", with: "\\Z")
+        return result
+    }
     func beginTransaction() async throws {}
     func commitTransaction() async throws {}
     func rollbackTransaction() async throws {}

Plugins/DuckDBDriverPlugin/DuckDBPlugin.swift

@@ -88,7 +88,11 @@ final class DuckDBPlugin: NSObject, TableProPlugin, DriverPlugin {
             "DATE", "TIME", "TIMESTAMP", "TIMESTAMP WITH TIME ZONE", "INTERVAL",
             "UUID", "JSON",
             "LIST", "MAP", "STRUCT", "UNION", "ENUM", "BIT"
-        ]
+        ],
+        regexSyntax: .regexpMatches,
+        booleanLiteralStyle: .truefalse,
+        likeEscapeStyle: .explicit,
+        paginationStyle: .limit
     )
 
     func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {

Plugins/MSSQLDriverPlugin/MSSQLPlugin.swift

@@ -80,7 +80,14 @@ final class MSSQLPlugin: NSObject, TableProPlugin, DriverPlugin {
             "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
     )
 
     func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {
@@ -416,6 +423,11 @@ final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
     var supportsSchemas: Bool { true }
     var supportsTransactions: Bool { true }
 
+    func quoteIdentifier(_ name: String) -> String {
+        let escaped = name.replacingOccurrences(of: "]", with: "]]")
+        return "[\(escaped)]"
+    }
+
     init(config: DriverConnectionConfig) {
         self.config = config
         self._currentSchema = config.additionalFields["mssqlSchema"]?.isEmpty == false
@@ -1250,7 +1262,7 @@ final class MSSQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
     // MARK: - Query Building Helpers
 
     private func mssqlQuoteIdentifier(_ identifier: String) -> String {
-        "[\(identifier.replacingOccurrences(of: "]", with: "]]"))]"
+        quoteIdentifier(identifier)
     }
 
     private func mssqlBuildOrderByClause(

Plugins/MongoDBDriverPlugin/MongoDBPluginDriver.swift

@@ -20,6 +20,7 @@ final class MongoDBPluginDriver: PluginDatabaseDriver {
     func beginTransaction() async throws {}
     func commitTransaction() async throws {}
     func rollbackTransaction() async throws {}
+    func quoteIdentifier(_ name: String) -> String { name }
 
     init(config: DriverConnectionConfig) {
         self.config = config

Plugins/MySQLDriverPlugin/MySQLPlugin.swift

@@ -73,7 +73,15 @@ final class MySQLPlugin: NSObject, TableProPlugin, DriverPlugin {
             "BLOB", "TINYBLOB", "MEDIUMBLOB", "LONGBLOB",
             "DATE", "TIME", "DATETIME", "TIMESTAMP", "YEAR",
             "ENUM", "SET", "JSON", "BOOL", "BOOLEAN"
-        ]
+        ],
+        tableOptions: [
+            "ENGINE=InnoDB", "DEFAULT CHARSET=utf8mb4", "COLLATE=utf8mb4_unicode_ci",
+            "AUTO_INCREMENT=", "COMMENT=", "ROW_FORMAT="
+        ],
+        regexSyntax: .regexp,
+        booleanLiteralStyle: .numeric,
+        likeEscapeStyle: .implicit,
+        paginationStyle: .limit
     )
 
     func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {

Plugins/MySQLDriverPlugin/MySQLPluginDriver.swift

@@ -24,6 +24,25 @@ final class MySQLPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
     var supportsSchemas: Bool { false }
     var supportsTransactions: Bool { true }
 
+    func quoteIdentifier(_ name: String) -> String {
+        let escaped = name.replacingOccurrences(of: "`", with: "``")
+        return "`\(escaped)`"
+    }
+
+    func escapeStringLiteral(_ value: String) -> String {
+        var result = value
+        result = result.replacingOccurrences(of: "\\", with: "\\\\")
+        result = result.replacingOccurrences(of: "'", with: "''")
+        result = result.replacingOccurrences(of: "\n", with: "\\n")
+        result = result.replacingOccurrences(of: "\r", with: "\\r")
+        result = result.replacingOccurrences(of: "\t", with: "\\t")
+        result = result.replacingOccurrences(of: "\0", with: "\\0")
+        result = result.replacingOccurrences(of: "\u{08}", with: "\\b")
+        result = result.replacingOccurrences(of: "\u{0C}", with: "\\f")
+        result = result.replacingOccurrences(of: "\u{1A}", with: "\\Z")
+        return result
+    }
+
     private static let tableNameRegex = try? NSRegularExpression(pattern: "(?i)\\bFROM\\s+[`\"']?([\\w]+)[`\"']?")
     private static let limitRegex = try? NSRegularExpression(pattern: "(?i)\\s+LIMIT\\s+\\d+(\\s*,\\s*\\d+)?")
     private static let offsetRegex = try? NSRegularExpression(pattern: "(?i)\\s+OFFSET\\s+\\d+")

Plugins/OracleDriverPlugin/OraclePlugin.swift

@@ -79,7 +79,14 @@ final class OraclePlugin: NSObject, TableProPlugin, DriverPlugin {
             "DATE", "TIMESTAMP", "TIMESTAMP WITH TIME ZONE", "TIMESTAMP WITH LOCAL TIME ZONE",
             "INTERVAL YEAR TO MONTH", "INTERVAL DAY TO SECOND",
             "BOOLEAN", "ROWID", "UROWID", "XMLTYPE", "SDO_GEOMETRY"
-        ]
+        ],
+        tableOptions: [
+            "TABLESPACE", "PCTFREE", "INITRANS"
+        ],
+        regexSyntax: .regexpLike,
+        booleanLiteralStyle: .numeric,
+        likeEscapeStyle: .explicit,
+        paginationStyle: .offsetFetch
     )
 
     func createDriver(config: DriverConnectionConfig) -> any PluginDatabaseDriver {

Plugins/PostgreSQLDriverPlugin/PostgreSQLPlugin.swift

@@ -81,7 +81,14 @@ final class PostgreSQLPlugin: NSObject, TableProPlugin, DriverPlugin {
             "CHAR", "CHARACTER", "VARCHAR", "TEXT",
             "DATE", "TIME", "TIMESTAMP", "TIMESTAMPTZ", "INTERVAL",
             "BOOLEAN", "BOOL", "JSON", "JSONB", "UUID", "BYTEA", "ARRAY"
-        ]
+        ],
+        tableOptions: [
+            "INHERITS", "PARTITION BY", "TABLESPACE", "WITH", "WITHOUT OIDS"
+        ],
+        regexSyntax: .tilde,
+        booleanLiteralStyle: .truefalse,
+        likeEscapeStyle: .explicit,
+        paginationStyle: .limit
     )
 
     static func driverVariant(for databaseTypeId: String) -> String? {

Plugins/RedisDriverPlugin/RedisPluginDriver.swift

@@ -23,6 +23,8 @@ final class RedisPluginDriver: PluginDatabaseDriver, @unchecked Sendable {
         redisConnection?.serverVersion()
     }
 
+    func quoteIdentifier(_ name: String) -> String { name }
+
     init(config: DriverConnectionConfig) {
         self.config = config
     }