Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .claude/rules/data-sync-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ paths:
- "apple/TablePro/Core/RoutineDebugging/RoutineDebugOptionStore.swift"
- "apple/TablePro/Core/RowGeneration/RowGenerationModel.swift"
- "apple/TablePro/Core/SSH/HostKeyStore.swift"
- "apple/TableProMobile/TableProMobile/SSH/HostKeyStore.swift"
- "apple/TablePro/Core/Transfer/Shared/ImportColumnMatcher.swift"
- "apple/TablePro/Core/Services/Formatting/ValueDisplayFormat.swift"
- "apple/TablePro/Core/Services/TeamLibrary/TeamLibraryState.swift"
Expand Down Expand Up @@ -123,6 +124,7 @@ paths:
- "apple/Packages/TableProMacCore/Sources/TableProUtilities/File/FileTextEncoding.swift"
- "apple/Packages/TableProMacCore/Sources/TableProUtilities/UI/QuickSwitcherFrecencyStore.swift"
- "apple/Packages/TableProMacCore/Sources/TableProMCP/Outside/MCPServerConfiguration.swift"
- "apple/Packages/TableProCore/Sources/TableProSSHTransport/HostKeyStore.swift"
- "apple/Packages/TableProCore/Sources/TableProSSHTransport/PublishedSSHRoute.swift"
- "apple/Packages/TableProCore/Sources/TableProSSHTransport/TOTPConfiguration.swift"
- "apple/Packages/TableProCore/Sources/TableProConnectionLibrary/RecentConnectionsLedger.swift"
Expand Down
1 change: 1 addition & 0 deletions .claude/rules/plugin-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ TableProPluginKit is built with Library Evolution, so an already-built plugin ke

- The `TablePro` scheme builds only the bundled plugins, and a registry plugin's compile error still ends in `BUILD SUCCEEDED`. Run `verify.sh plugins` (the `AllPlugins` aggregate) after any change under `apple/Plugins/`.
- `apple/scripts/ci/verify-plugin-loads.sh <dir>...` dlopens every built `.tableplugin` and names any that will not load. It does not instantiate the principal class.
- The curated entry in `PluginMetadataRegistry` answers for a type until its plugin's code loads, so it declares what the plugin declares. `PluginMetadataCuratedParityTests` (Unit plan) loads every driver plugin built beside the test host, builds its snapshot as registration does and fails on each field that differs from the curated entry. CI builds `AllPlugins` before the Unit plan when the `plugins` suite runs, so the registry plugins are compared then; locally, run `verify.sh plugins` first. A variant keeps its own curated entry and is not compared.

## Column type corpus

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,6 @@ jobs:
- name: Check every plugin Info.plist declares the ids its class provides
run: python3 apple/scripts/ci/check-plugin-provides.py

# The curated entry answers until the plugin loads, then the plugin's static replaces it (#2700).
- name: Check curated driver capabilities match their plugins
run: python3 apple/scripts/ci/check-capability-parity.py

# Import, export and sync drop a field the trust catalog does not classify.
- name: Check every connection field has a trust class
run: python3 apple/scripts/ci/check-connection-field-trust.py
Expand Down Expand Up @@ -184,6 +180,10 @@ jobs:
- name: Check the statement classifiers read words through the grammar's tokens
run: python3 apple/scripts/ci/check-classifier-text-matching.py

# A new engine belongs in a plugin (apple/AGENTS.md, Scope); a view reads services through injection.
- name: Check engine-name comparisons and view singleton reads do not grow
run: python3 apple/scripts/ci/check-source-ratchets.py

# The corpora run by hand against servers (scripts/probes/check-column-type-corpus.sh), so a type a driver
# starts listing is caught here.
- name: Check every listed column type has a corpus column
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/macos-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ jobs:
scripts/build-dameng.sh arm64
scripts/build-hana.sh arm64

# Before the Unit plan, whose PluginMetadataCuratedParityTests loads the plugins built here.
- name: Compile every plugin
if: ${{ !cancelled() && steps.bridges.outcome == 'success' }}
run: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,14 @@ public extension SQLLexicalReadings {
// quote opens `'''`, has no such form and takes the execution reading.
static func stringEscapes(
databaseTypeId: String,
queryLanguage: String? = nil,
declared: SQLLexicalGrammar?,
session: SQLSessionLexicalFacts?
) -> SQLStringEscapes {
if databaseTypeId == "SQL Server" { return .sqlServer }
let readings = resolve(databaseTypeId: databaseTypeId, declared: declared, session: session)
let readings = resolve(
databaseTypeId: databaseTypeId, queryLanguage: queryLanguage, declared: declared, session: session
)
if let session, session.determined.contains(.backslashEscapesInSingleQuotes) {
return readings.execution.stringEscapes
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ public struct SQLLexicalProfile: Sendable, Hashable {
profiles[typeId]
}

/// A query language several engines share, named as a plugin's `EditorLanguage.custom` names it, so an engine
/// TablePro does not curate still lexes as its language does.
public static func curated(forQueryLanguage language: String) -> SQLLexicalProfile? {
language == "cypher" ? cypherProfile : nil
}

/// The database type ids the curated table covers.
public static var curatedDatabaseTypeIds: Set<String> {
Set(profiles.keys)
Expand Down Expand Up @@ -221,6 +227,8 @@ public struct SQLLexicalProfile: Sendable, Hashable {
.withoutDashComments,
]

private static let cypherProfile = SQLLexicalProfile(grammar: cypher, undetermined: [.carriageReturnEndsLineComments])

/// DynamoDB, from the driver's statement forms: a request is `<Action> {JSON}`, and a backslash escapes inside a
/// JSON string. PartiQL, the other form, documents only a doubled quote, so plain ANSI is kept as an alternative
/// and a gate reads both. Not measured.
Expand Down Expand Up @@ -350,7 +358,7 @@ public struct SQLLexicalProfile: Sendable, Hashable {
.backslashEscapesInBackticks, .backslashEscapesInAngleQuotes, .carriageReturnEndsLineComments,
]
),
"Neo4j": SQLLexicalProfile(grammar: cypher, undetermined: [.carriageReturnEndsLineComments]),
"Neo4j": cypherProfile,
"InfluxDB": SQLLexicalProfile(
grammar: influxDB,
alternatives: [.ansi],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,17 @@ public struct SQLLexicalReadings: Sendable, Hashable {
all.count > 1
}

/// Resolves the readings for a connection: the curated profile when TablePro knows the engine, which wins over
/// anything a plugin declares because a registry plugin may be built against an older kit; otherwise what the
/// plugin declared; otherwise every grammar TablePro knows, split for execution as standard SQL.
/// Resolves the readings for a connection: the curated profile when TablePro knows the engine or the query language
/// its plugin names, which wins over anything a plugin declares because a registry plugin may be built against an
/// older kit; otherwise what the plugin declared; otherwise every grammar TablePro knows, split for execution as
/// standard SQL.
public static func resolve(
databaseTypeId: String,
queryLanguage: String? = nil,
declared: SQLLexicalGrammar?,
session: SQLSessionLexicalFacts?
) -> SQLLexicalReadings {
let base = baseReadings(databaseTypeId: databaseTypeId, declared: declared)
let base = baseReadings(databaseTypeId: databaseTypeId, queryLanguage: queryLanguage, declared: declared)
guard let session else { return base }
let execution = session.applied(to: base.execution)
return SQLLexicalReadings(execution: execution, all: base.all)
Expand Down Expand Up @@ -96,8 +98,13 @@ public struct SQLLexicalReadings: Sendable, Hashable {
})
}

private static func baseReadings(databaseTypeId: String, declared: SQLLexicalGrammar?) -> SQLLexicalReadings {
if let profile = SQLLexicalProfile.curated(forDatabaseTypeId: databaseTypeId) {
private static func baseReadings(
databaseTypeId: String,
queryLanguage: String?,
declared: SQLLexicalGrammar?
) -> SQLLexicalReadings {
if let profile = SQLLexicalProfile.curated(forDatabaseTypeId: databaseTypeId)
?? queryLanguage.flatMap({ SQLLexicalProfile.curated(forQueryLanguage: $0) }) {
return SQLLexicalReadings(execution: profile.grammar, all: profile.readings)
}
if let declared {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,116 @@ public extension SQLEngineVocabulary {
],
dataTypes: PostgreSQLLists.dataTypes,
tableOptions: ["INHERITS", "PARTITION BY", "TABLESPACE", "WITH", "WITHOUT OIDS"],
operators: PostgreSQLLists.operators
operators: PostgreSQLLists.operators,
keywords: PostgreSQLLists.keywords
)
}

private enum PostgreSQLLists {
typealias Operator = SQLEngineVocabulary.Operator

static let keywords: Set<String> = reservedKeywords
.union(nonReservedKeywords)
.union(multiWordConstructs)

private static let reservedKeywords: Set<String> = [
"ALL", "ANALYSE", "ANALYZE", "AND", "ANY", "ARRAY", "AS", "ASC", "ASYMMETRIC", "BOTH",
"CASE", "CAST", "CHECK", "COLLATE", "COLUMN", "CONSTRAINT", "CREATE", "CURRENT_CATALOG",
"CURRENT_DATE", "CURRENT_ROLE", "CURRENT_TIME", "CURRENT_TIMESTAMP", "CURRENT_USER",
"DEFAULT", "DEFERRABLE", "DESC", "DISTINCT", "DO", "ELSE", "END", "EXCEPT", "FALSE",
"FETCH", "FOR", "FOREIGN", "FROM", "GRANT", "GROUP", "HAVING", "IN", "INITIALLY",
"INTERSECT", "INTO", "LATERAL", "LEADING", "LIMIT", "LOCALTIME", "LOCALTIMESTAMP",
"NOT", "NULL", "OFFSET", "ON", "ONLY", "OR", "ORDER", "PLACING", "PRIMARY", "REFERENCES",
"RETURNING", "SELECT", "SESSION_USER", "SOME", "SYMMETRIC", "SYSTEM_USER", "TABLE",
"THEN", "TO", "TRAILING", "TRUE", "UNION", "UNIQUE", "USER", "USING", "VARIADIC",
"WHEN", "WHERE", "WINDOW", "WITH",
"AUTHORIZATION", "BINARY", "COLLATION", "CONCURRENTLY", "CROSS", "CURRENT_SCHEMA",
"FREEZE", "FULL", "ILIKE", "INNER", "IS", "ISNULL", "JOIN", "LEFT", "LIKE", "NATURAL",
"NOTNULL", "OUTER", "OVERLAPS", "RIGHT", "SIMILAR", "TABLESAMPLE", "VERBOSE"
]

private static let nonReservedKeywords: Set<String> = [
"ABORT", "ABSENT", "ABSOLUTE", "ACCESS", "ACTION", "ADD", "ADMIN", "AFTER", "AGGREGATE",
"ALTER", "ALWAYS", "AT", "ATOMIC", "ATTACH", "ATTRIBUTE", "BACKWARD", "BEFORE", "BEGIN",
"BREADTH", "BY", "CACHE", "CALL", "CALLED", "CASCADE", "CASCADED", "CHAIN",
"CHARACTERISTICS", "CHECKPOINT", "CLASS", "CLOSE", "CLUSTER", "COLUMNS", "COMMENT",
"COMMENTS", "COMMIT", "COMMITTED", "COMPRESSION", "CONDITIONAL", "CONFIGURATION",
"CONFLICT", "CONNECTION", "CONSTRAINTS", "CONTENT", "CONTINUE", "CONVERSION", "COPY",
"COST", "CSV", "CUBE", "CURRENT", "CURSOR", "CYCLE", "DATA", "DATABASE", "DAY",
"DEALLOCATE", "DECLARE", "DEFAULTS", "DEFERRED", "DEFINER", "DELETE", "DELIMITER",
"DELIMITERS", "DEPENDS", "DEPTH", "DETACH", "DICTIONARY", "DISABLE", "DISCARD",
"DOCUMENT", "DOMAIN", "DOUBLE", "DROP", "EACH", "EMPTY", "ENABLE", "ENCODING",
"ENCRYPTED", "ENUM", "ERROR", "ESCAPE", "EVENT", "EXCLUDE", "EXCLUDING", "EXCLUSIVE",
"EXECUTE", "EXPLAIN", "EXPRESSION", "EXTENSION", "EXTERNAL", "FAMILY", "FILTER",
"FINALIZE", "FIRST", "FOLLOWING", "FORCE", "FORMAT", "FORWARD", "FUNCTION", "FUNCTIONS",
"GENERATED", "GLOBAL", "GRANTED", "GROUPS", "HANDLER", "HEADER", "HOLD", "HOUR",
"IDENTITY", "IF", "IMMEDIATE", "IMMUTABLE", "IMPLICIT", "IMPORT", "INCLUDE", "INCLUDING",
"INCREMENT", "INDENT", "INDEX", "INDEXES", "INHERIT", "INHERITS", "INPUT", "INSENSITIVE",
"INSERT", "INSTEAD", "INVOKER", "ISOLATION", "KEEP", "KEY", "KEYS", "LABEL", "LANGUAGE",
"LARGE", "LAST", "LEAKPROOF", "LEVEL", "LISTEN", "LOAD", "LOCAL", "LOCATION", "LOCK",
"LOCKED", "LOGGED", "MAPPING", "MATCH", "MATCHED", "MATERIALIZED", "MAXVALUE", "MERGE",
"METHOD", "MINUTE", "MINVALUE", "MODE", "MONTH", "MOVE", "NAME", "NAMES", "NESTED",
"NEW", "NEXT", "NO", "NORMALIZED", "NOTHING", "NOTIFY", "NOWAIT", "NULLS", "OBJECT",
"OF", "OFF", "OLD", "OMIT", "OPERATOR", "OPTION", "OPTIONS", "ORDINALITY", "OTHERS",
"OVER", "OVERRIDING", "OWNED", "OWNER", "PARALLEL", "PARAMETER", "PARSER", "PARTIAL",
"PARTITION", "PASSING", "PASSWORD", "PATH", "POLICY", "PRECEDING", "PREPARE", "PREPARED",
"PRESERVE", "PRIOR", "PRIVILEGES", "PROCEDURE", "PROCEDURES", "PROGRAM", "PUBLICATION",
"QUOTE", "QUOTES", "RANGE", "READ", "REASSIGN", "RECURSIVE", "REFERENCING", "REFRESH",
"REINDEX", "RELATIVE", "RELEASE", "RENAME", "REPEATABLE", "REPLACE", "REPLICA", "RESET",
"RESTART", "RESTRICT", "RETURN", "RETURNS", "REVOKE", "ROLE", "ROLLBACK", "ROLLUP",
"ROUTINE", "ROUTINES", "ROWS", "RULE", "SAVEPOINT", "SCALAR", "SCHEMA", "SCHEMAS",
"SCROLL", "SEARCH", "SECOND", "SECURITY", "SEQUENCE", "SEQUENCES", "SERIALIZABLE",
"SERVER", "SESSION", "SET", "SETS", "SHARE", "SHOW", "SIMPLE", "SKIP", "SNAPSHOT",
"SOURCE", "SQL", "STABLE", "STANDALONE", "START", "STATEMENT", "STATISTICS", "STDIN",
"STDOUT", "STORAGE", "STORED", "STRICT", "STRING", "STRIP", "SUBSCRIPTION", "SUPPORT",
"SYSTEM", "TABLES", "TABLESPACE", "TARGET", "TEMP", "TEMPLATE", "TEMPORARY", "TEXT",
"TIES", "TRANSACTION", "TRANSFORM", "TRIGGER", "TRUNCATE", "TRUSTED", "TYPE", "TYPES",
"UNBOUNDED", "UNCOMMITTED", "UNCONDITIONAL", "UNENCRYPTED", "UNKNOWN", "UNLISTEN",
"UNLOGGED", "UNTIL", "UPDATE", "VACUUM", "VALID", "VALIDATE", "VALIDATOR", "VALUE",
"VARYING", "VERSION", "VIEW", "VIEWS", "VOLATILE", "WHITESPACE", "WITHIN", "WITHOUT",
"WORK", "WRAPPER", "WRITE", "XML", "YEAR", "YES", "ZONE",
"BETWEEN", "COALESCE", "EXISTS", "GREATEST", "GROUPING", "LEAST", "MERGE_ACTION",
"NULLIF", "OVERLAY", "POSITION", "SETOF", "SUBSTRING", "TREAT", "TRIM", "VALUES"
]

private static let multiWordConstructs: Set<String> = [
"ON CONFLICT", "ON CONFLICT DO NOTHING", "ON CONFLICT DO UPDATE SET", "ON CONSTRAINT",
"DO NOTHING", "DO UPDATE SET", "DEFAULT VALUES", "OVERRIDING SYSTEM VALUE",
"OVERRIDING USER VALUE", "RETURNING *",
"SELECT DISTINCT", "SELECT DISTINCT ON", "DISTINCT ON", "GROUP BY", "GROUP BY ALL",
"GROUP BY DISTINCT", "GROUPING SETS", "ORDER BY", "NULLS FIRST", "NULLS LAST",
"UNION ALL", "UNION DISTINCT", "INTERSECT ALL", "EXCEPT ALL", "LIMIT ALL",
"FETCH FIRST", "FETCH NEXT", "WITH TIES", "FOR UPDATE", "FOR NO KEY UPDATE",
"FOR SHARE", "FOR KEY SHARE", "SKIP LOCKED", "TABLESAMPLE SYSTEM",
"TABLESAMPLE BERNOULLI", "WITH ORDINALITY", "ROWS FROM",
"INNER JOIN", "LEFT JOIN", "LEFT OUTER JOIN", "RIGHT JOIN", "RIGHT OUTER JOIN",
"FULL JOIN", "FULL OUTER JOIN", "CROSS JOIN", "NATURAL JOIN",
"WITH RECURSIVE", "AS MATERIALIZED", "AS NOT MATERIALIZED",
"SEARCH BREADTH FIRST BY", "SEARCH DEPTH FIRST BY",
"CREATE TABLE IF NOT EXISTS", "CREATE TEMP TABLE", "CREATE UNLOGGED TABLE",
"NOT NULL", "PRIMARY KEY", "FOREIGN KEY", "UNIQUE NULLS DISTINCT",
"UNIQUE NULLS NOT DISTINCT", "GENERATED ALWAYS AS", "GENERATED ALWAYS AS IDENTITY",
"GENERATED BY DEFAULT AS IDENTITY", "MATCH FULL", "MATCH PARTIAL", "MATCH SIMPLE",
"ON DELETE CASCADE", "ON DELETE RESTRICT", "ON DELETE SET NULL", "ON DELETE NO ACTION",
"ON UPDATE CASCADE", "ON UPDATE RESTRICT", "ON UPDATE SET NULL",
"DEFERRABLE INITIALLY DEFERRED", "INITIALLY IMMEDIATE", "EXCLUDE USING",
"PARTITION BY RANGE", "PARTITION BY LIST", "PARTITION BY HASH", "PARTITION OF",
"FOR VALUES IN", "FOR VALUES FROM", "FOR VALUES WITH",
"ON COMMIT PRESERVE ROWS", "ON COMMIT DELETE ROWS", "ON COMMIT DROP",
"OVER", "PARTITION BY", "FILTER", "WITHIN GROUP", "ROWS BETWEEN", "RANGE BETWEEN",
"GROUPS BETWEEN", "UNBOUNDED PRECEDING", "UNBOUNDED FOLLOWING", "CURRENT ROW",
"EXCLUDE CURRENT ROW", "EXCLUDE GROUP", "EXCLUDE TIES", "EXCLUDE NO OTHERS",
"MERGE INTO", "WHEN MATCHED THEN", "WHEN MATCHED THEN UPDATE SET",
"WHEN MATCHED THEN DELETE", "WHEN NOT MATCHED THEN INSERT",
"WHEN NOT MATCHED BY TARGET THEN", "WHEN NOT MATCHED BY SOURCE THEN",
"CREATE INDEX CONCURRENTLY", "CREATE MATERIALIZED VIEW", "REFRESH MATERIALIZED VIEW",
"CREATE TYPE", "CREATE EXTENSION", "IF NOT EXISTS", "IF EXISTS", "CASCADE", "RESTRICT",
"IS NULL", "IS NOT NULL", "IS TRUE", "IS NOT TRUE", "IS FALSE", "IS NOT FALSE",
"IS UNKNOWN", "IS NOT UNKNOWN", "IS DISTINCT FROM", "IS NOT DISTINCT FROM",
"BETWEEN SYMMETRIC", "NOT BETWEEN", "NOT BETWEEN SYMMETRIC", "NOT LIKE", "NOT ILIKE",
"SIMILAR TO", "NOT SIMILAR TO", "AT TIME ZONE", "AT LOCAL"
]

static let functions: Set<String> = aggregateFunctions
.union(windowFunctions)
.union(stringFunctions)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,25 @@ public struct SQLEngineVocabulary: Sendable, Hashable {
public let dataTypes: Set<String>
public let tableOptions: [String]
public let operators: [Operator]
// Empty for an engine whose plugin still lists its own.
public let keywords: Set<String>

public init(
functions: Set<String>,
bareFunctions: Set<String> = [],
functionNamesAreCaseInsensitive: Bool = true,
dataTypes: Set<String>,
tableOptions: [String] = [],
operators: [Operator] = []
operators: [Operator] = [],
keywords: Set<String> = []
) {
self.functions = functions
self.bareFunctions = bareFunctions
self.functionNamesAreCaseInsensitive = functionNamesAreCaseInsensitive
self.dataTypes = dataTypes
self.tableOptions = tableOptions
self.operators = operators
self.keywords = keywords
}

public static func curated(forDatabaseTypeId typeId: String) -> SQLEngineVocabulary? {
Expand Down
Loading
Loading