Skip to content

Fix for schema migration involving 'NOT NULL' columns. #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbrandonw merged 3 commits into from
Jan 14, 2026
Merged

Fix for schema migration involving 'NOT NULL' columns. #365

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5581705
Fix for schema migration involving 'NOT NULL' columns.
mbrandonw Jan 9, 2026
01daefb
wip
mbrandonw Jan 9, 2026
5803d52
Merge remote-tracking branch 'origin/main' into schema-change-test-fa…
mbrandonw Jan 14, 2026
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
4 changes: 2 additions & 2 deletions Sources/SQLiteData/CloudKit/SyncEngine.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2005,11 +2005,11 @@
if data == nil {
reportIssue("Asset data not found on disk")
}
return "\(quote: columnName) = \(data?.queryFragment ?? "NULL")"
return "\(quote: columnName) = \(data?.queryFragment ?? #""excluded".\#(quote: columnName)"#)"
} else {
return """
\(quote: columnName) = \
\(record.encryptedValues[columnName]?.queryFragment ?? "NULL")
\(record.encryptedValues[columnName]?.queryFragment ?? #""excluded".\#(quote: columnName)"#)
"""
}
}
Expand Down
42 changes: 42 additions & 0 deletions Tests/SQLiteDataTests/CloudKitTests/SchemaChangeTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,48 @@
}
}

/*
* Old schema creates record and synchronizes to iCloud.
* Schema is migrated to add a "NOT NULL" column.
* New sync engine is launched.
=> Sync starts without emitting an error.
*/
@available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
@Test func addColumn_OldRecordsSyncToNewSchema() async throws {
let remindersList = RemindersList(id: 1, title: "Personal")
try await userDatabase.userWrite { db in
try db.seed {
remindersList
}
}
try await syncEngine.processPendingRecordZoneChanges(scope: .private)

syncEngine.stop()

try await userDatabase.userWrite { db in
try #sql(
"""
ALTER TABLE "remindersLists"
ADD COLUMN "position" INTEGER NOT NULL ON CONFLICT REPLACE DEFAULT 0
"""
)
.execute(db)
}

// NB: Sync engine should start without emitting issue.
_ = try await SyncEngine(
container: syncEngine.container,
userDatabase: syncEngine.userDatabase,
tables: syncEngine.tables
.filter { $0.base != Reminder.self && $0.base != RemindersList.self }
+ [
SynchronizedTable(for: ReminderWithPosition.self),
SynchronizedTable(for: RemindersListWithPosition.self),
],
privateTables: syncEngine.privateTables
)
}

@available(iOS 17, macOS 14, tvOS 17, watchOS 10, *)
@Test func addAssetToRemindersList() async throws {
let personalList = RemindersList(id: 1, title: "Personal")
Expand Down