Merge branch 'development'

Author: groue

CHANGELOG.md

@@ -97,12 +97,21 @@ GRDB adheres to [Semantic Versioning](https://semver.org/), with one exception:
 
 ---
 
+## 6.0.0-beta.3
+
+Released August 25, 2022 • [diff](https://github.com/groue/GRDB.swift/compare/v6.0.0-beta...v6.0.0-beta.2)
+
+- **Fix**: [#1268](https://github.com/groue/GRDB.swift/pull/1268) by [@groue](https://github.com/groue): Fix SQL generation of CHECK constraints
+- **Breaking**: The `Column` type is no longer `Equatable`
+- **Documentation Update**: [Migrating From GRDB 5 to GRDB 6](Documentation/GRDB6MigrationGuide.md) describes in detail how to update records that customize their persistence methods.
+- **Documentation Update**: The [Single-Row Tables](Documentation/SingleRowTables.md) guide was updated for the new persistence callbacks.
+
 ## 6.0.0-beta.2
 
 Released August 23, 2022 • [diff](https://github.com/groue/GRDB.swift/compare/v6.0.0-beta...v6.0.0-beta.2)
 
 - **New**: Extended UPSERT apis with the ability to define the conflict target, and the assignments performed in case of conflicts.
-- **Documentation**: A new [Upsert](README.md#upsert) chapter describes upserts in detail.
+- **Documentation Update**: A new [Upsert](README.md#upsert) chapter describes upserts in detail.
 
 ## 6.0.0-beta
 

Documentation/FullTextSearch.md

@@ -304,7 +304,7 @@ let pattern = FTS3Pattern(matchingAnyTokenIn: "")  // nil
 let pattern = FTS3Pattern(matchingAnyTokenIn: "*") // nil
 ```
 
-FTS3Pattern are regular [values](../README.md#values). You can use them as query [arguments](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.2/Structs/StatementArguments.html):
+FTS3Pattern are regular [values](../README.md#values). You can use them as query [arguments](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.3/Structs/StatementArguments.html):
 
 ```swift
 let documents = try Document.fetchAll(db,
@@ -587,7 +587,7 @@ let pattern = FTS5Pattern(matchingAnyTokenIn: "")  // nil
 let pattern = FTS5Pattern(matchingAnyTokenIn: "*") // nil
 ```
 
-FTS5Pattern are regular [values](../README.md#values). You can use them as query [arguments](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.2/Structs/StatementArguments.html):
+FTS5Pattern are regular [values](../README.md#values). You can use them as query [arguments](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.3/Structs/StatementArguments.html):
 
 ```swift
 let documents = try Document.fetchAll(db,

Documentation/GRDB6MigrationGuide.md

@@ -172,9 +172,32 @@ The record protocols have been refactored. We tried to keep the amount of modifi
 
 - **PersistableRecord types now customize persistence methods with "persistence callbacks"**.
 
-    It is no longer possible to override persistence methods such as `insert` or `update`. Customizing the persistence methods is now possible with callbacks such as `willSave`, `willInsert`, or `didDelete` (see [Persistence Callbacks](../README.md#persistence-callbacks) for the full list of callbacks).
+    It is no longer possible to override persistence methods such as `insert` or `update`. Customizing the persistence methods is now possible with callbacks such as `willSave`, `willInsert`, or `didDelete` (see [persistence callbacks] for the full list of callbacks).
 
-    For example, let's consider a record that performs some validation before insertion and updates. In GRDB 5, this would look like:
+    **You have to remove the methods below from your own code base**:
+    
+    ```swift
+    // GRDB 6: remove those methods from your code
+    func insert(_ db: Database) throws
+    func didInsert(with rowID: Int64, for column: String?)
+    func update(_ db: Database, columns: Set<String>) throws
+    func save(_ db: Database) throws
+    func delete(_ db: Database) throws -> Bool
+    func exists(_ db: Database) throws -> Bool
+    ```
+    
+    - `insert(_:)`: customization is now made with [persistence callbacks].
+    - `didInsert(with:for:)`: this method was renamed `didInsert(_:)` (see previous bullet point).
+    - `update(_:columns:)`: customization is now made with [persistence callbacks].
+    - `save(_:)`: customization is now made with [persistence callbacks].
+    - `delete(_:)`: customization is now made with [persistence callbacks].
+    - `exists(_:)`: this method is no longer customizable.
+    
+    To help you update your applications with persistence callbacks, let's look at two examples.
+    
+    First, check the updated [Single-Row Tables](SingleRowTables.md) guide, if your application defines a "singleton record".
+    
+    Next, let's consider a record that performs some validation before insertion and updates. In GRDB 5, this would look like:
 
     ```swift
     // GRDB 5
@@ -351,3 +374,5 @@ The record protocols have been refactored. We tried to keep the amount of modifi
          print("Succesful commit")
      }
     ```
+
+[persistence callbacks]: ../README.md#persistence-callbacks

Documentation/Migrations.md

@@ -77,7 +77,7 @@ try dbQueue.read { db in
 }
 ```
 
-See the [DatabaseMigrator reference](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.2/Structs/DatabaseMigrator.html) for more migrator methods.
+See the [DatabaseMigrator reference](http://groue.github.io/GRDB.swift/docs/6.0.0-beta.3/Structs/DatabaseMigrator.html) for more migrator methods.
 
 
 ## The `eraseDatabaseOnSchemaChange` Option

Documentation/SingleRowTables.md

@@ -116,16 +116,14 @@ We make our record able to access the database:
 extension AppConfiguration: FetchableRecord, PersistableRecord {
 ```
 
-We have seen in the [The Single-Row Table] chapter that by default, updates throw an error if the database table is empty. To avoid this error, we instruct GRDB to perform an insert in case of a failed update (see [Persistence Methods] for more information):
+We have seen in the [The Single-Row Table] chapter that by default, updates throw an error if the database table is empty. To avoid this error, we instruct GRDB to insert the missing default configuration before attempting to update (see [Persistence Callbacks] for more information about the `willSave` method):
 
 ```swift
     // Customize the default PersistableRecord behavior
-    func update(_ db: Database, columns: Set<String>) throws {
-        do {
-            try performUpdate(db, columns: columns)
-        } catch PersistenceError.recordNotFound {
-            // No row was updated: perform an insert
-            try performInsert(db)
+    func willUpdate(_ db: Database, columns: Set<String>) throws {
+        // Insert the default configuration if it does not exist yet.
+        if try !exists(db) {
+            try AppConfiguration.default.insert(db)
         }
     }
 ```
@@ -165,12 +163,13 @@ try dbQueue.write { db in
     try config.update(db)
     try config.save(db)
     try config.insert(db)
+    try config.upsert(db)
 }
 ```
 
-The three `update`, `save` and `insert` methods can be used interchangeably: all three make sure the configuration is stored in the database.
+The four `update`, `save`, `insert` and `upsert` methods can be used interchangeably. They all make sure the configuration is stored in the database.
 
-The `updateChanges` method only updates the values changed by its closure argument (and performs an insert if the database table is empty).
+The `updateChanges` method only updates the values changed by its closure argument (and performs an initial insert of default configuration if the database table is empty).
 
 See [Persistence Methods] for more information.
 
@@ -215,12 +214,10 @@ extension AppConfiguration {
 // Database Access
 extension AppConfiguration: FetchableRecord, PersistableRecord {
     // Customize the default PersistableRecord behavior
-    func update(_ db: Database, columns: Set<String>) throws {
-        do {
-            try performUpdate(db, columns: columns)
-        } catch PersistenceError.recordNotFound {
-            // No row was updated: perform an insert
-            try performInsert(db)
+    func willUpdate(_ db: Database, columns: Set<String>) throws {
+        // Insert the default configuration if it does not exist yet.
+        if try !exists(db) {
+            try AppConfiguration.default.insert(db)
         }
     }
 
@@ -239,4 +236,5 @@ extension AppConfiguration: FetchableRecord, PersistableRecord {
 [The Single-Row Record]: #the-single-row-record
 [Wrap-Up]: #wrap-up
 [DRY]: https://en.wikipedia.org/wiki/Don%27t_repeat_yourself
+[Persistence Callbacks]: ../README.md#persistence-callbacks
 [Persistence Methods]: ../README.md#persistence-methods

GRDB.swift.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = 'GRDB.swift'
-  s.version  = '6.0.0-beta.2'
+  s.version  = '6.0.0-beta.3'
 
   s.license  = { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'A toolkit for SQLite databases, with a focus on application development.'

GRDB.xcodeproj/project.pbxproj

@@ -100,6 +100,9 @@
 		5616AAF1207CD45E00AC3664 /* RequestProtocols.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616AAF0207CD45E00AC3664 /* RequestProtocols.swift */; };
 		5616AAF2207CD45E00AC3664 /* RequestProtocols.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616AAF0207CD45E00AC3664 /* RequestProtocols.swift */; };
 		5616AAF3207CD45E00AC3664 /* RequestProtocols.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616AAF0207CD45E00AC3664 /* RequestProtocols.swift */; };
+		5616B4FB28B5F5220052017E /* SingletonRecordTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616B4FA28B5F5220052017E /* SingletonRecordTest.swift */; };
+		5616B4FC28B5F5220052017E /* SingletonRecordTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616B4FA28B5F5220052017E /* SingletonRecordTest.swift */; };
+		5616B4FD28B5F5220052017E /* SingletonRecordTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5616B4FA28B5F5220052017E /* SingletonRecordTest.swift */; };
 		5617294E223533F40006E219 /* EncodableRecord.swift in Sources */ = {isa = PBXBuildFile; fileRef = 56172947223533F40006E219 /* EncodableRecord.swift */; };
 		5617294F223533F40006E219 /* EncodableRecord.swift in Sources */ = {isa = PBXBuildFile; fileRef = 56172947223533F40006E219 /* EncodableRecord.swift */; };
 		56172950223533F40006E219 /* EncodableRecord.swift in Sources */ = {isa = PBXBuildFile; fileRef = 56172947223533F40006E219 /* EncodableRecord.swift */; };
@@ -1366,6 +1369,7 @@
 		5615B287222B17BF00061C1C /* AssociationHasOneThroughDecodableRecordTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AssociationHasOneThroughDecodableRecordTests.swift; sourceTree = "<group>"; };
 		561667001D08A49900ADD404 /* FoundationNSDecimalNumberTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FoundationNSDecimalNumberTests.swift; sourceTree = "<group>"; };
 		5616AAF0207CD45E00AC3664 /* RequestProtocols.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RequestProtocols.swift; sourceTree = "<group>"; };
+		5616B4FA28B5F5220052017E /* SingletonRecordTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SingletonRecordTest.swift; sourceTree = "<group>"; };
 		56172947223533F40006E219 /* EncodableRecord.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = EncodableRecord.swift; sourceTree = "<group>"; };
 		561CFA7123735015000C8BAA /* TableRecordUpdateTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TableRecordUpdateTests.swift; sourceTree = "<group>"; };
 		561CFA912376E546000C8BAA /* AssociationHasManyThroughOrderingTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AssociationHasManyThroughOrderingTests.swift; sourceTree = "<group>"; };
@@ -2387,8 +2391,9 @@
 		56A238251B9C74A90082EB20 /* Record */ = {
 			isa = PBXGroup;
 			children = (
-				5674A7251F30A8EF0095F066 /* FetchableRecord */,
 				564E73DE203D50B9000C443C /* JoinSupportTests.swift */,
+				5616B4FA28B5F5220052017E /* SingletonRecordTest.swift */,
+				5674A7251F30A8EF0095F066 /* FetchableRecord */,
 				560B3FA41C19DFF800C58EC7 /* PersistableRecord */,
 				56176C9E1EACEDF9000F3F2B /* Record */,
 				56176C9C1EACEA8C000F3F2B /* TableRecord */,
@@ -3434,6 +3439,7 @@
 				5674A72D1F30A9090095F066 /* FetchableRecordDecodableTests.swift in Sources */,
 				56419C5F24A51999004967E1 /* Inverted.swift in Sources */,
 				560432A4228F1668009D3FE2 /* AssociationPrefetchingObservationTests.swift in Sources */,
+				5616B4FC28B5F5220052017E /* SingletonRecordTest.swift in Sources */,
 				566A84412041914000E50BFD /* MutablePersistableRecordChangesTests.swift in Sources */,
 				56176C701EACCCC9000F3F2B /* FTS5WrapperTokenizerTests.swift in Sources */,
 				56FEE7FF1F47253700D930EA /* TableRecordTests.swift in Sources */,
@@ -3669,6 +3675,7 @@
 				563B06CA2185D2E500B38F35 /* ValueObservationFetchTests.swift in Sources */,
 				56D496541D812F5B008276D7 /* SQLExpressionLiteralTests.swift in Sources */,
 				56D496961D81317B008276D7 /* PersistableRecordTests.swift in Sources */,
+				5616B4FB28B5F5220052017E /* SingletonRecordTest.swift in Sources */,
 				56419C5724A51998004967E1 /* Inverted.swift in Sources */,
 				560432A3228F1668009D3FE2 /* AssociationPrefetchingObservationTests.swift in Sources */,
 				5698AC9E1DA4B0430056AF8C /* FTS4TableBuilderTests.swift in Sources */,
@@ -4052,6 +4059,7 @@
 				AAA4DD73230F262000C74B15 /* FetchableRecordDecodableTests.swift in Sources */,
 				56419C6724A5199B004967E1 /* Inverted.swift in Sources */,
 				AAA4DD74230F262000C74B15 /* AssociationPrefetchingObservationTests.swift in Sources */,
+				5616B4FD28B5F5220052017E /* SingletonRecordTest.swift in Sources */,
 				AAA4DD75230F262000C74B15 /* MutablePersistableRecordChangesTests.swift in Sources */,
 				AAA4DD76230F262000C74B15 /* FTS5WrapperTokenizerTests.swift in Sources */,
 				AAA4DD77230F262000C74B15 /* TableRecordTests.swift in Sources */,

GRDB/QueryInterface/SQL/Column.swift

@@ -63,7 +63,7 @@ extension ColumnExpression where Self == Column {
 /// Instead, adopt the ColumnExpression protocol.
 ///
 /// See <https://github.com/groue/GRDB.swift#the-query-interface>
-public struct Column: ColumnExpression, Equatable {
+public struct Column: ColumnExpression {
     /// The hidden rowID column
     public static let rowID = Column("rowid")
 
@@ -79,12 +79,6 @@ public struct Column: ColumnExpression, Equatable {
     public init(_ codingKey: some CodingKey) {
         self.name = codingKey.stringValue
     }
-    
-    // Avoid a wrong resolution when BUILD_LIBRARY_FOR_DISTRIBUTION is set
-    @_disfavoredOverload
-    public static func == (lhs: Column, rhs: Column) -> Bool {
-        lhs.name == rhs.name
-    }
 }
 
 /// Support for column enums:

GRDB/Record/MutablePersistableRecord+Delete.swift

@@ -29,12 +29,15 @@ extension MutablePersistableRecord {
     public func delete(_ db: Database) throws -> Bool {
         try willDelete(db)
 
-        var deleted = false
+        var deleted: Bool?
         try aroundDelete(db) {
             deleted = try deleteWithoutCallbacks(db)
-            return deleted
+            return deleted!
         }
 
+        guard let deleted else {
+            try persistenceCallbackMisuse("aroundDelete")
+        }
         didDelete(deleted: deleted)
         return deleted
     }

GRDB/Record/MutablePersistableRecord+Insert.swift

@@ -32,13 +32,16 @@ extension MutablePersistableRecord {
     {
         try willSave(db)
 
-        var saved: PersistenceSuccess!
+        var saved: PersistenceSuccess?
         try aroundSave(db) {
             let inserted = try insertWithCallbacks(db, onConflict: conflictResolution)
             saved = PersistenceSuccess(inserted)
-            return saved
+            return saved!
         }
 
+        guard let saved else {
+            try persistenceCallbackMisuse("aroundSave")
+        }
         didSave(saved)
     }
 
@@ -215,18 +218,20 @@ extension MutablePersistableRecord {
 
         try willSave(db)
 
-        var inserted: InsertionSuccess!
-        var returned: T!
+        var success: (inserted: InsertionSuccess, returned: T)?
         try aroundSave(db) {
-            (inserted, returned) = try insertAndFetchWithCallbacks(
+            success = try insertAndFetchWithCallbacks(
                 db, onConflict: conflictResolution,
                 selection: selection,
                 fetch: fetch)
-            return PersistenceSuccess(inserted)
+            return PersistenceSuccess(success!.inserted)
         }
 
-        didSave(PersistenceSuccess(inserted))
-        return returned
+        guard let success else {
+            try persistenceCallbackMisuse("aroundSave")
+        }
+        didSave(PersistenceSuccess(success.inserted))
+        return success.returned
     }
 #else
     /// Executes an `INSERT ... RETURNING ...` statement, and returns the
@@ -374,18 +379,20 @@ extension MutablePersistableRecord {
 
         try willSave(db)
 
-        var inserted: InsertionSuccess!
-        var returned: T!
+        var success: (inserted: InsertionSuccess, returned: T)?
         try aroundSave(db) {
-            (inserted, returned) = try insertAndFetchWithCallbacks(
+            success = try insertAndFetchWithCallbacks(
                 db, onConflict: conflictResolution,
                 selection: selection,
                 fetch: fetch)
-            return PersistenceSuccess(inserted)
+            return PersistenceSuccess(success!.inserted)
         }
 
-        didSave(PersistenceSuccess(inserted))
-        return returned
+        guard let success else {
+            try persistenceCallbackMisuse("aroundSave")
+        }
+        didSave(PersistenceSuccess(success.inserted))
+        return success.returned
     }
 #endif
 }
@@ -419,18 +426,20 @@ extension MutablePersistableRecord {
     {
         try willInsert(db)
 
-        var inserted: InsertionSuccess!
-        var returned: T!
+        var success: (inserted: InsertionSuccess, returned: T)?
         try aroundInsert(db) {
-            (inserted, returned) = try insertAndFetchWithoutCallbacks(
+            success = try insertAndFetchWithoutCallbacks(
                 db, onConflict: conflictResolution,
                 selection: selection,
                 fetch: fetch)
-            return inserted
+            return success!.inserted
         }
 
-        didInsert(inserted)
-        return (inserted, returned)
+        guard let success else {
+            try persistenceCallbackMisuse("aroundInsert")
+        }
+        didInsert(success.inserted)
+        return success
     }
 
     /// Executes an `INSERT` statement, with `RETURNING` clause if `selection`