Released December 16, 2017 • diff
Fixed
Released December 3, 2017 • diff
New
-
#280: It is now possible to add an untyped column to an existing table.
try db.alter(table: "players") { t in t.add(column: "score") }
-
#281: The
Database.dropFTS4SynchronizationTriggers
&Database.dropFTS5SynchronizationTriggers
method help cleaning up synchronized full-text table (documentation)
Breaking Change
- #282: This version comes with a breaking change that affects users who manually embed the GRDBCipher and GRDBCustom frameworks in their projects. This change does not affect users of the GRDB framework, or users of GRDBCipher through CocoaPods. Now, instead of embedding the GRDB.xcodeproj project, you have to embed the GRDBCipher.xcodeproj or GRDBCustom.xcodeproj. Please have a look at the updated Encryption and Custom SQLite Builds documentation chapters.
Released November 8, 2017 • diff
Fixed
-
GRDB 2.2.0 has introduced a fix in the way transaction observers are notified of empty deferred transactions (
BEGIN; COMMIT;
). That fix was incomplete, and inconsistent.Now all transactions are notified, without any exception, including:
try db.execute("BEGIN; COMMIT;") try db.execute("SAVEPOINT foo; RELEASE SAVEPOINT foo;")
Released November 5, 2017 • diff
New
- Upgrade custom SQLite builds to v3.21.0 (thanks to @swiftlyfalling).
Released October 31, 2017 • diff
New
Database.viewExists(_:)
returns whether a view exists in the database.Database.triggerExists(_:)
returns whether a trigger exists in the database.
Fixed
-
DROP VIEW
statements would not drop views (#267) -
GRDB used to incorrectly send incomplete transaction notifications to transaction observers in the case of empty deferred transactions. This is no longer the case. Since empty deferred transactions have SQLite consider that no transaction started at all, they are no longer notified to transaction observers:
-- Nothing happens, and thus no notification is sent BEGIN TRANSACTION COMMIT
Those empty deferred transactions still count for the afterNextTransactionCommit database method, and the
.nextTransaction
observation extent.
Released October 24, 2017 • diff
-
GRDBCipher can now build from command line (groue/sqlcipher/pull/1 by Darren Clark)
-
Upgrade custom SQLite builds to v3.20.1 (thanks to @swiftlyfalling).
-
The new method
Request.asSQLRequest
allows to inspect the sql and arguments of any request:let request = Player.all() let sql = try request.asSQLRequest(db).sql print(sql) // Prints "SELECT * FROM players"
-
StatementArguments adopts Equatable
DROP TABLE
statements would not drop temporary tables.
- New FAQ: How do I create a database in my application?
- New FAQ: How do I print a request as SQL?
- The Codable Record chapter has been enhanced with more information and sample code.
extension Request {
+ func asSQLRequest(_ db: Database, cached: Bool = false) throws -> SQLRequest
}
struct SQLRequest {
+ let sql: String
+ let arguments: StatementArguments?
+ let adapter: RowAdapter?
}
Released October 9, 2017 • diff
Fixed: Record types that conform to Encodable now encode their null columns.
Released October 5, 2017 • diff
Fixed: DROP TABLE
statements would not drop tables when run through a prepared statement.
Released September 17, 2017 • diff
Fixed: restored support for Swift Package Manager
Released September 16, 2017 • diff
GRDB 2.0 brings support for Swift 4. Notable changes are:
-
Use subscript notation when extracting row values (documentation):
let name: String = row[0] // 0 is the leftmost column let name: String = row["name"] // Leftmost matching column - lookup is case-insensitive let name: String = row[Column("name")] // Using query interface's Column
-
Support for the
Codable
protocol (documentation)Record types that adopt the standard
Codable
protocol are granted with automatic adoption of GRDB record protocols. This means that you no longer have to write boilerplate code 🎉:struct Player : RowConvertible, Persistable, Codable { static let databaseTableName = "players" let name: String let score: Int } // Automatically derived: // // extension Player { // init(row: Row) { // name = row["name"] // score = row["score"] // } // // func encode(to container: inout PersistenceContainer) { // container["name"] = name // container["score"] = score // } // } try dbQueue.inDatabase { db in let arthur = Player(name: "Arthur", score: 100) try arthur.insert(db) let players = try Player.fetchAll(db) // [Players] }
-
Records can now specify the columns they feed from (documentation).
In previous versions of GRDB,
SELECT *
was the norm. GRDB 2.0 introducesdatabaseSelection
, which allows any type to define its preferred set of columns:struct Player : RowConvertible, TableMapping { let id: Int64 let name: String enum Columns { static let id = Column("id") static let name = Column("name") } init(row: Row) { id = row[Columns.id] name = row[Columns.name] } static let databaseTableName = "players" static let databaseSelection: [SQLSelectable] = [Columns.id, Columns.name] } // SELECT id, name FROM players let players = Player.fetchAll(db)
-
Record protocols have more precise semantics: RowConvertible reads database rows, TableMapping builds SQL requests, and Persistable writes (documentation).
This means that with GRDB 2.0, being able to write
Player.fetchAll(db)
does not imply thatPlayer.deleteAll(db)
is available: you have a better control on the abilities of your record types.
- GRDB is now able to store and load zero-length blobs.
New features have been added in order to plug a few holes and support the RxGRDB and GRDBObjc companion projects:
-
Persistable records can export themselves as dictionaries:
let player = try Player.fetchOne(db, key: 1) let dict = player.databaseDictionary // [String: DatabaseValue] print(dict) // Prints {"id": 1, "name": "Arthur", "score": 1000}
-
Query interface requests learned how to limit the number of deleted rows:
// Delete the last ten players: // DELETE FROM players ORDER BY score LIMIT 10 let request = Player.order(scoreColumn).limit(10) try request.deleteAll(db)
-
Prepared statements know the index of their columns:
let statement = try db.makeSelectStatement("SELECT a, b FROM t") statement.index(ofColumn: "b") // 1
-
Row cursors (of type RowCursor) expose their underlying statement:
let rows = try Row.fetchCursor(db, "SELECT ...") let statement = rows.statement
-
One can build a Set from a cursor:
let strings = try Set(String.fetchCursor(...))
-
The new
AnyDatabaseReader
andAnyDatabaseWriter
type erasers help dealing with theDatabaseReader
andDatabaseWriter
protocols.
-
Requirements have changed: Xcode 9+ / Swift 4
-
WatchOS extension targets no longer need
libsqlite3.tbd
to be added to the Linked Frameworks and Libraries section of their General tab. -
The
Row.value
method has been replaced with subscript notation:-row.value(atIndex: 0) -row.value(named: "id") -row.value(Column("id")) +row[0] +row["id"] +row[Column("id")]
-
Date and NSDate now interpret numerical database values as timestamps that fuel
Date(timeIntervalSince1970:)
. Previous version of GRDB would interpret numbers as julian days (a date representation supported by SQLite). Support for julian days remains, with theDate(julianDay:)
initializer. -
All
TableMapping
methods that would modify the database have moved toMutablePersistable
, now the only record protocol that is able to write. -
The
TableMapping.selectsRowID
property has been replaced withTableMapping.databaseSelection
.To upgrade, replace:
struct Player: TableMapping { - static let selectsRowID = true + static let databaseSelection: [SQLSelectable] = [AllColumns(), Column.rowID] }
-
The
DatabaseCursor
type has been removed, and replaced with several concrete types that all adopt theCursor
protocol. Those new types allow dedicated optimizations depending on the type of the fetched elements.If your application has code that depends on
DatabaseCursor
, make it target the new concrete types, or make it generic on theCursor
protocol, just like you'd write generic methods on the SwiftSequence
protocol. -
RowConvertible.fetchCursor(_:keys:)
returns a non-optional cursor. -
Database.primaryKey(_:)
returns a non-optional PrimaryKeyInfo. When a table has no explicit primary key, the result is the hidden rowid column. -
The deprecated
TableMapping.primaryKeyRowComparator
method has been removed.
- WatchOS installation procedure has been updated with new instructions.
- The introduction to multithreading with database pools has been enhanced.
- The Rows as Dictionaries chapter has been enhanced with instructions for converting a row into a dictionary.
- The description of cursors better explains how to choose between a cursor and an array.
- The Date and DateComponents chapter has been updated for the new support for unix timestamps.
- The Fatal Errors chapter has an enhanced description of value conversion errors and how to handle them.
- The Usage of raw SQLite pointers chapter has been updated for the new
SQLite3
standard module that comes with Swift4. - A new Record Protocols Overview chapter has been added.
- A new Codable Records chapter has been added.
- A new Columns Selected by a Request chapter describes the new
TableMapping.databaseSelection
property. - The Exposing the RowID Column chapter has been updated for the new
TableMapping.databaseSelection
property.
class Row {
- func value(atIndex index: Int) -> DatabaseValueConvertible?
- func value<Value: DatabaseValueConvertible>(atIndex index: Int) -> Value?
- func value<Value: DatabaseValueConvertible>(atIndex index: Int) -> Value
- func value(named columnName: String) -> DatabaseValueConvertible?
- func value<Value: DatabaseValueConvertible>(named columnName: String) -> Value?
- func value<Value: DatabaseValueConvertible>(named columnName: String) -> Value
- func value(_ column: Column) -> DatabaseValueConvertible?
- func value<Value: DatabaseValueConvertible>(_ column: Column) -> Value?
- func value<Value: DatabaseValueConvertible>(_ column: Column) -> Value
+ subscript(_ index: Int) -> DatabaseValueConvertible?
+ subscript<Value: DatabaseValueConvertible>(_ index: Int) -> Value?
+ subscript<Value: DatabaseValueConvertible>(_ index: Int) -> Value
+ subscript(_ columnName: String) -> DatabaseValueConvertible?
+ subscript<Value: DatabaseValueConvertible>(_ columnName: String) -> Value?
+ subscript<Value: DatabaseValueConvertible>(_ columnName: String) -> Value
+ subscript(_ column: Column) -> DatabaseValueConvertible?
+ subscript<Value: DatabaseValueConvertible>(_ column: Column) -> Value?
+ subscript<Value: DatabaseValueConvertible>(_ column: Column) -> Value
}
class SelectStatement {
+ func index(ofColumn columnName: String) -> Int?
}
+extension MutablePersistable {
+ var databaseDictionary: [String: DatabaseValue]
+}
-extension TableMapping {
+extension MutablePersistable {
@discardableResult static func deleteAll(_ db: Database) throws -> Int
@discardableResult static func deleteAll<Sequence: Swift.Sequence>(_ db: Database, keys: Sequence) throws -> Int where Sequence.Element: DatabaseValueConvertible
@discardableResult static func deleteOne<PrimaryKeyType: DatabaseValueConvertible>(_ db: Database, key: PrimaryKeyType?) throws -> Bool
@discardableResult static func deleteAll(_ db: Database, keys: [[String: DatabaseValueConvertible?]]) throws -> Int
@discardableResult static func deleteOne(_ db: Database, key: [String: DatabaseValueConvertible?]) throws -> Bool
}
-extension QueryInterfaceRequest {
+extension QueryInterfaceRequest where RowDecoder: MutablePersistable {
@discardableResult func deleteAll(_ db: Database) throws -> Int
}
protocol TableMapping {
- static var selectsRowID: Bool { get }
+ static var databaseSelection: [SQLSelectable] { get }
}
class Record {
- open class var selectsRowID: Bool
+ open class var databaseSelection: [SQLSelectable]
}
+struct AllColumns {
+ init()
+}
class Database {
- func primaryKey(_ tableName: String) throws -> PrimaryKeyInfo?
+ func primaryKey(_ tableName: String) throws -> PrimaryKeyInfo
}
struct PrimaryKeyInfo {
+ var isRowID: Bool { get }
}
+extension Set {
+ init<C: Cursor>(_ cursor: C) throws where C.Element == Element
+}
-final class DatabaseCursor { }
+final class ColumnCursor<Value: DatabaseValueConvertible & StatementColumnConvertible> : Cursor {
+ typealias Element = Value
+}
+final class DatabaseValueCursor<Value: DatabaseValueConvertible> : Cursor {
+ typealias Element = Value
+}
+final class NullableColumnCursor<Value: DatabaseValueConvertible & StatementColumnConvertible> : Cursor {
+ typealias Element = Value?
+}
+final class NullableDatabaseValueCursor<Value: DatabaseValueConvertible> : Cursor {
+ typealias Element = Value?
+}
+final class RecordCursor<Record: RowConvertible> : Cursor {
+ typealias Element = Record
+}
+final class RowCursor : Cursor {
+ typealias Element = Row
+ let statement: SelectStatement
+}
extension DatabaseValueConvertible {
- static func fetchCursor(...) throws -> DatabaseCursor<Self>
+ static func fetchCursor(...) throws -> DatabaseValueCursor<Self>
}
extension DatabaseValueConvertible where Self: StatementColumnConvertible {
+ static func fetchCursor(...) throws -> ColumnCursor<Self>
}
extension Optional where Wrapped: DatabaseValueConvertible {
- static func fetchCursor(...) throws -> DatabaseCursor<Wrapped?>
+ static func fetchCursor(...) throws -> NullableDatabaseValueCursor<Wrapped>
}
extension Optional where Wrapped: DatabaseValueConvertible & StatementColumnConvertible {
+ static func fetchCursor(...) throws -> NullableColumnCursor<Wrapped>
}
extension Row {
- static func fetchCursor(...) throws -> DatabaseCursor<Row>
+ static func fetchCursor(...) throws -> RowCursor
}
extension RowConvertible where Self: TableMapping {
- static func fetchCursor(...) throws -> DatabaseCursor<Self>?
+ static func fetchCursor(...) throws -> RecordCursor<Self>
}
extension TypedRequest where RowDecoder: RowConvertible {
- func fetchCursor(_ db: Database) throws -> DatabaseCursor<RowDecoder>
+ func fetchCursor(_ db: Database) throws -> RecordCursor<RowDecoder>
}
extension TypedRequest where RowDecoder: DatabaseValueConvertible {
- func fetchCursor(_ db: Database) throws -> DatabaseCursor<RowDecoder>
+ func fetchCursor(_ db: Database) throws -> DatabaseValueCursor<RowDecoder>
}
extension TypedRequest where RowDecoder: DatabaseValueConvertible & StatementColumnConvertible {
+ func fetchCursor(_ db: Database) throws -> ColumnCursor<RowDecoder>
}
extension TypedRequest where RowDecoder: _OptionalProtocol, RowDecoder._Wrapped: DatabaseValueConvertible {
- func fetchCursor(_ db: Database) throws -> DatabaseCursor<RowDecoder._Wrapped?>
+ func fetchCursor(_ db: Database) throws -> NullableDatabaseValueCursor<RowDecoder._Wrapped>
}
extension TypedRequest where RowDecoder: _OptionalProtocol, RowDecoder._Wrapped: DatabaseValueConvertible & StatementColumnConvertible {
+ func fetchCursor(_ db: Database) throws -> NullableColumnCursor<RowDecoder._Wrapped>
}
extension TypedRequest where RowDecoder: Row {
- func fetchCursor(_ db: Database) throws -> DatabaseCursor<Row>
+ func fetchCursor(_ db: Database) throws -> RowCursor
}
extension TableMapping {
- @available(*, deprecated) static func primaryKeyRowComparator(_ db: Database) throws -> (Row, Row) -> Bool
}
+final class AnyDatabaseReader : DatabaseReader {
+ init(_ base: DatabaseReader)
+}
+final class AnyDatabaseWriter : DatabaseWriter {
+ init(_ base: DatabaseWriter)
+}
enum SQLCount {
- case star
+ case all
}
Released August 18, 2017 • diff
New
- Upgrade custom SQLite builds to v3.20.0 (thanks to @swiftlyfalling).
- Complete support for all signed and unsigned integer types: from Int8 toUInt64, all integers can be stored and loaded from the database.
API diff
+extension Int8: DatabaseValueConvertible, StatementColumnConvertible { }
+extension Int16: DatabaseValueConvertible, StatementColumnConvertible { }
+extension UInt8: DatabaseValueConvertible, StatementColumnConvertible { }
+extension UInt16: DatabaseValueConvertible, StatementColumnConvertible { }
+extension UInt32: DatabaseValueConvertible, StatementColumnConvertible { }
+extension UInt64: DatabaseValueConvertible, StatementColumnConvertible { }
+extension UInt: DatabaseValueConvertible, StatementColumnConvertible { }
Released July 20, 2017 • diff
Fixed
- The
Configuration.trace
function no longer leaks memory.
Released July 19, 2017 • diff
Fixed
-
Upgrade custom SQLite builds to v3.19.3 (thanks to @swiftlyfalling).
-
The Query Interface now generates
IS NULL
SQL snippets for comparisons withDatabaseValue.null
:// SELECT * FROM players WHERE email IS NULL Player.filter(Column("email") == DatabaseValue.null)
It used to generate
= NULL
which would not behave as expected.
Released July 13, 2017 • diff
New
-
Record types that do not provide values for all table columns in their
encode(to:)
method are now supported. -
The table creation API has been enhanced:
-
SQLite supports untyped columns:
try dbQueue.inDatabase { db in // CREATE TABLE t(a, b) try db.create(table: "t") { t in t.column("a") t.column("b") } }
Untyped columns behave like decimal, boolean, date columns, and generally all columns with NUMERIC type affinity.
This feature addresses #169.
-
The
indexed()
methods lets you create a non-unique index on a table column:try dbQueue.inDatabase { db in // CREATE TABLE rounds(score INTEGER) // CREATE INDEX rounds_on_score ON rounds(score) try db.create(table: "rounds") { t in t.column("score", .integer).indexed() } }
-
It is now possible to define references to tables without any explicit primary key. The generated SQL then uses the
rowid
hidden primary key column:try dbQueue.inDatabase { db in // CREATE TABLE nodes( // name TEXT, // parentId INTEGER REFERENCES nodes(rowid) // ) try db.create(table: "nodes") { t in t.column("name", .text) t.column("parentId", .integer).references("nodes") } }
-
-
DatabaseQueue
,DatabasePool
and their common protocolDatabaseReader
can now perform "unsafe reentrant reads" (documentation):try dbPool.read { db in // This is allowed try dbPool.unsafeReentrantRead { db in ... } }
Fixed
-
DatabasePool.read
, andDatabasePool.unsafeRead
now raise a fatal error when used in a reentrant way:try dbPool.read { db in // fatal error: "Database methods are not reentrant." try dbPool.read { db in ... } }
While this change may appear as a breaking change, it is really a fix: reentrant reads deadlock as soon as the maximum number of readers has been reached.
API diff
final class ColumnDefinition {
+ @discardableResult func indexed() -> Self
}
final class TableDefinition {
- func column(_ name: String, _ type: Database.ColumnType) -> ColumnDefinition
+ func column(_ name: String, _ type: Database.ColumnType? = nil) -> ColumnDefinition
}
protocol DatabaseReader {
+ func unsafeReentrantRead<T>(_ block: (Database) throws -> T) throws -> T
}
Released July 1, 2017 • diff
New
-
DatabaseAggregate
is the protocol for custom aggregate functions (fixes #236, documentation):struct MySum : DatabaseAggregate { var sum: Int = 0 mutating func step(_ dbValues: [DatabaseValue]) { if let int = Int.fromDatabaseValue(dbValues[0]) { sum += int } } func finalize() -> DatabaseValueConvertible? { return sum } } let dbQueue = DatabaseQueue() let fn = DatabaseFunction("mysum", argumentCount: 1, aggregate: MySum.self) dbQueue.add(function: fn) try dbQueue.inDatabase { db in try db.execute("CREATE TABLE test(i)") try db.execute("INSERT INTO test(i) VALUES (1)") try db.execute("INSERT INTO test(i) VALUES (2)") try Int.fetchOne(db, "SELECT mysum(i) FROM test")! // 3 }
Fixed
QueryInterfaceRequest.order(_:)
clears the eventual reversed flag, and better reflects the documentation of this method: "Any previous ordering is replaced."
Deprecated
TableMapping.primaryKeyRowComparator
is deprecated, without any replacement.
API diff
final class DatabaseFunction {
+ init<Aggregate: DatabaseAggregate>(_ name: String, argumentCount: Int32? = nil, pure: Bool = false, aggregate: Aggregate.Type)
}
+protocol DatabaseAggregate {
+ init()
+ mutating func step(_ dbValues: [DatabaseValue]) throws
+ func finalize() throws -> DatabaseValueConvertible?
+}
extension TableMapping {
+ @available(*, deprecated)
static func primaryKeyRowComparator(_ db: Database) throws -> (Row, Row) -> Bool
}
Released June 20, 2017
GRDB 1.0 comes with enhancements, and API stability.
It comes with breaking changes, but the good news is that they are the last (until GRDB 2.0) 😅!
-
Requirements have changed: Xcode 8.3+ / Swift 3.1
As a matter of fact, GRDB 1.0 still supports Xcode 8.1 and Swift 3.0. But future versions are free to use Swift 3.1 features, and will require Xcode 8.3+.
The targetted operating systems are unchanged: iOS 8.0+ / OSX 10.9+ / watchOS 2.0+
-
Record types have their
persistentDictionary
property replaced with theencode(to:)
method:struct Player : Persistable { let name: String let score: Int // Old // var persistentDictionary: [String: DatabaseValueConvertible?] { // return [ // "name": name, // "score": score, // ] // } // New func encode(to container: inout PersistenceContainer) { container["name"] = name container["score"] = score } }
This is good for applications that declare lists of columns:
struct Player : RowConvertible, Persistable { let name: String let score: Int static let databaseTableName = "players" // Declare Player columns enum Columns { static let name = Column("name") static let score = Column("score") } // Use columns in `init(row:)` init(row: Row) { name = row.value(Columns.name) score = row.value(Columns.score) } // Use columns in the new `encode(to:)` method: func encode(to container: inout PersistenceContainer) { container[Columns.name] = name container[Columns.score] = score } }
-
Database Observation has been enhanced:
Database.afterNextTransactionCommit(_:)
is the simplest way to handle successful transactions, and synchronize the database with other resources such as files, or system sensors (documentation).// Make sure the database is inside a transaction db.inSavepoint { // Perform some database job try ... // Register extra job that is only executed after database changes // have been committed and written to disk. db.afterNextTransactionCommit { ... } }
On the low-level side, applications can now specify the extent of database observation (documentation).
-
DatabaseMigrator is easier to test, with its
DatabaseMigrator.migrate(_:upTo:)
method which partially migrates your databases (documentation). -
On the side of database schema introspection, the new
Database.foreignKeys(on:)
method lists the foreign keys defined on a table.
Full list of changes
class Database {
- func add(transactionObserver: TransactionObserver)
+ func add(transactionObserver: TransactionObserver, extent: TransactionObservationExtent = .observerLifetime)
+ func afterNextTransactionCommit(_ closure: @escaping (Database) -> ())
+ func foreignKeys(on tableName: String) throws -> [ForeignKeyInfo]
}
-struct DatabaseCoder: DatabaseValueConvertible
struct DatabaseMigrator {
+ func migrate(_ writer: DatabaseWriter, upTo targetIdentifier: String) throws
}
protocol DatabaseWriter : DatabaseReader {
- func add(transactionObserver: TransactionObserver)
+ func add(transactionObserver: TransactionObserver, extent: TransactionObservationExtent = .observerLifetime)
}
protocol MutablePersistable : TableMapping {
- var persistentDictionary: [String: DatabaseValueConvertible?] { get }
+ func encode(to container: inout PersistenceContainer)
}
extension QueryInterfaceRequest {
- func contains(_ value: SQLExpressible) -> SQLExpression
- func exists() -> SQLExpression
}
extension Request {
- func adapted(_ adapter: @escaping (Database) throws -> RowAdapter) -> AnyRequest
+ func adapted(_ adapter: @escaping (Database) throws -> RowAdapter) -> AdaptedRequest<Self>
}
protocol TypedRequest : Request {
- associatedtype Fetched
+ associatedtype RowDecoder
}
extension TypedRequest {
- func adapted(_ adapter: @escaping (Database) throws -> RowAdapter) -> AnyTypedRequest<Fetched>
+ func adapted(_ adapter: @escaping (Database) throws -> RowAdapter) -> AdaptedTypedRequest<Self>
}
Released May 28, 2017
New
- Upgrade custom SQLite builds to v3.19.2 (thanks to @swiftlyfalling).
- Upgrade SQLCipher to v3.4.1 (announcement, changelog)
- A large test suite that runs on Travis-CI, thanks to @swiftlyfalling in PR #213
Fixed
- Remove deprecation warning about
sqlite3_trace
() for custom SQLite builds (addresses #100)
Released May 22, 2017
Fixed
- Failed value conversions now consistently crash with a fatal error.
New
DatabaseValue.losslessConvert()
performs a lossless conversion to a value type.
Breaking Changes
DatabaseEventKind.impacts(_ selectionInfo:SelectStatement.SelectionInfo)
now returns an non-optional boolean.DatabaseWriter.availableDatabaseConnection
has been replaced byDatabaseWriter.unsafeReentrantWrite()
.Request.bound(to:)
has been renamedRequest.asRequest(of:)
.
Released May 17, 2017
New
-
Use CocoaPods to install GRDB with SQLCipher:
pod 'GRDBCipher'
Breaking Changes
RowConvertible.awakeFromFetch()
has been removed.
Released May 5, 2017
New
-
SQLRequest
learned how to reuse cached prepared statements:SQLRequest("SELECT ...", cached: true)
-
Database.logError
lets you register a global error logging function:Database.logError = { resultCode, message in NSLog("%@", "SQLite error \(resultCode): \(message)") }
Released April 12, 2017
No change, but a better support for Swift Package Manager at the git repository level.
Released April 11, 2017
New
- Swift Package Manager, thanks to Andrey Fidrya in PR #202.
Released April 6, 2017
Fixed
- FetchedRecordsController used to be able to miss changes performed on requests that use the
COUNT
SQL function. This is fixed.
New
DatabaseWriter.availableDatabaseConnection
allows reentrant uses of GRDB, and improves support for reactive programming.
Breaking Changes
DatabaseEventKind.impacts(_ selectionInfo:SelectStatement.SelectionInfo)
now returns an optional boolean which, when nil, tells that GRDB doesn't know if a statement has any impact on the selection of a request. In practice, this happens as soon as a request uses theCOUNT
SQL function.
Released April 3, 2017
New
- Support for Xcode 8.3 and Swift 3.1 (Xcode 8.1 and Swift 3 are still supported).
- Upgrade custom SQLite builds to v3.18.0 (thanks to @swiftlyfalling).
- Support for reactive extensions:
SelectStatement.SelectionInfo
is an opaque value that knows which database tables and columns are read by a select statement.DatabaseEventKind.impacts(_ selectionInfo:SelectStatement.SelectionInfo)
tells whether a database change has any impact on the results of a select statement. See Database Changes ObservationTableMapping.primaryKeyRowComparator(_ db: Database)
returns a function that compares two database rows and return true if and only if they have the same non-null primary key.
Breaking Changes
- SQLite C API is now available right from the GRBD module: you don't need any longer to import
SQLiteiPhoneOS
module et al (see documentation for Raw SQLite Pointers). - The manual installation procedure for WatchOS extensions has changed.
- Carthage is no longer supported. At the present time it is unable to support the various frameworks built by GRDB (system SQLite, SQLCipher, custom SQLite builds, etc.)
Released March 26, 2017
Fixed
DatabaseError
conversion toNSError
preserves extended result codes.DatabaseQueue.read
andDatabaseQueue.readFromCurrentState
throw an error upon database modifications.- Added missing availability checks for SQLite features that are not available on all versions of iOS, macOS, watchOS.
- Removed useless availability checks for SQLite features that are available with SQLCipher and custom SQLite builds.
- Prevent wrong linking of SQLCipher
Breaking Changes
DatabaseQueue.writeInTransaction
, alias forDatabaseQueue.inTransaction
, has been removed.DatabaseValue.value()
has been removed, in favor ofDatabaseValue.storage
.
Released March 2, 2017
New: Error Handling (fixes #171)
-
GRDB activates SQLite's extended result codes for more detailed error reporting.
-
The new
ResultCode
type defines constants for all SQLite result codes and extended result codes. -
The SQLite error code of
DatabaseError
can be queried withresultCode
, orextendedResultCode
, depending on the level of details you need (documentation):do { ... } catch let error as DatabaseError where error.extendedResultCode == .SQLITE_CONSTRAINT_FOREIGNKEY { // handle foreign key constraint error } catch let error as DatabaseError where error.resultCode == .SQLITE_CONSTRAINT { // handle any other constraint error }
New: Request
-
The Request protocol for custom requests learned how to count:
let request: Request = ... let count = try request.fetchCount(db) // Int
Default implementation performs a naive counting based on the request SQL:
SELECT COUNT(*) FROM (...)
. Adopting types can refine the counting SQL by providing their ownfetchCount
implementation.Thanks David Hart for this suggestion.
Breaking Changes
DatabaseError.code
has been removed, replaced withDatabaseError.resultCode
andDatabaseError.extendedResultCode
(documentation).DatabaseMigrator.registerMigrationWithDisabledForeignKeyChecks
has been renamedDatabaseMigrator.registerMigrationWithDeferredForeignKeyCheck
(documentation)
Released January 20, 2017
New
DatabaseEventKind.tableName
makes it easier to track any change that may happen to a database table (documentation)FetchedRecordsController.allowBackgroundChangesTracking(in:)
: call this FetchedRecordsController method when changes performed while the application is in the background should be processed before the application enters the suspended state.
Breaking Changes
Configuration.fileAttributes
has been removed (see Data Protection)
Released January 10, 2017
New
Row
adopts the Hashable protocol- FetchedRecordsController now outputs request changes on all platforms, for both table and collection views. Merged #160 by @kdubb.
- Upgrade custom SQLite builds to v3.16.2 (thanks to @swiftlyfalling).
Breaking Changes
-
It is now a programmer error to invoke
FetchedRecordsController.fetchedRecords
beforeperformFetch()
:final class FetchedRecordsController<Record: RowConvertible> { - var fetchedRecords: [Record]? + var fetchedRecords: [Record] }
-
The fetched record type of a FetchedRecordsController is now infered from the request that feeds the controller:
final class FetchedRecordsController<Record: RowConvertible> { - convenience init(...:request: Request) throws + convenience init<Request>(...:request: Request) throws where Request: TypedRequest, Request.Fetched == Record }
-
FetchedRecordsController now automatically compares records by primary key when the record type adopts the TableMapping protocol, such as all Record subclasses. This feature used to require an explicit
compareRecordsByPrimaryKey
initialization parameter:extension FetchedRecordsController where Record: TableMapping { - convenience init(...:compareRecordsByPrimaryKey: Bool) throws }
-
Change tracking APIs have been modified:
final class FetchedRecordsController<Record: RowConvertible> { - func trackChanges(recordsWillChange:tableViewEvent:recordsDidChange:) + func trackChanges(willChange:onChange:didChange:) }
Released December 22, 2016
Fixed
Database.cachedSelectStatement()
no longer returns a statement that can not be reused because it has already failed.
Released December 21, 2016
Fixed
- An awful bug where SQLite would not drop any table (#157)
- Transaction Observers are no longer blinded by the truncate optimization (fixes #156)
Released December 20, 2016
Fixed
- Transaction Observers are no longer blinded by the truncate optimization (fixes #156)
New
-
FetchedRecordsController no longer crashes whenever an error prevents it from looking for changes after a transaction has potentially modified the tracked request. Instead, it notifies its optional error handler:
controller.trackErrors { (controller, error) in print("Missed a transaction because \(error)") }
Released December 16, 2016
New
-
StatementArguments can be concatenated with the
append(contentsOf:)
method and the+
,&+
,+=
operators (documentation) -
Rows expressed as dictionary literals now preserve column ordering, and allow duplicated column names:
let row: Row = ["foo": 1, "foo": Date(), "baz": nil] print(row) // Prints <Row foo:1 foo:"2016-12-16 13:19:49.230" baz:NULL>
Released December 15, 2016
Fixed
- DatabasePool
read
andreadFromCurrentState
methods now properly throw errors whenever they can't acquire an isolated access to the database.
New
- Raw transaction and savepoint SQL statements are properly reflected in transaction observers,
Database.isInsideTransaction
, etc.
Released December 11, 2016
New
-
Request.adapted
modifies a request with a row adapter.// Person has `email` column, but User expects `identifier` column: Person.all() .adapted { _ in ColumnMapping(["identifier": "email"]) } .bound(to: User.self)
Breaking Changes
RowAdapter
protocol has been refactored. This only affects your code if you implement your own row adapter.
Released December 9, 2016
New
SQLRequest
,AnyRequest
,TypedRequest
andAnyTypedRequest
are new protocols and concrete types that let you build custom fetch requests.RangeRowAdapter
is a new kind of row adapter which exposes a range of columns.
Breaking Changes
FetchRequest
protocol has been renamedRequest
.
Released December 7, 2016
New
Database.columnCount(in:)
returns the number of columns in a database table. This helps building row adapters for joined requests.
Released December 7, 2016
Fixed
- Removed
Record.hasPersistentChangedValues
dependency onawakeFromFetch()
. This makes it easier to wrap records in other RowConvertible types, sinceawakeFromFetch()
can be overlooked without bad consequences on changes tracking.
Released December 4, 2016
New
- Upgrade custom SQLite builds to v3.15.2 (thanks to @swiftlyfalling).
Released December 2, 2016
Fixed
Database.execute(_:)
now iterates all rows of statements (and executes any side effect performed by the evaluation of each row).
Released December 1, 2016
Fixed
- Fixed a bug in
DatabasePool.readFromCurrentState
where its block argument could see database changes that it should not have seen (documentation).
Breaking Changes
DatabaseWriter.readFromWrite
has been renamedDatabaseWriter.readFromCurrentState
DatabaseReader.nonIsolatedRead
has been renamedDatabaseReader.unsafeRead
Released November 30, 2016
Breaking Changes
Generally speaking, fetching methods can now throw errors. The fetch
method have been removed, along with DatabaseSequence
and DatabaseIterator
, replaced by the fetchCursor
method and DatabaseCursor
(documentation):
// No longer supported
let persons = Person.fetch(db) // DatabaseSequence<Person>
for person in persons { // Person
...
}
// New
let persons = try Person.fetchCursor(db) // DatabaseCursor<Person>
while person = try persons.next() { // Person
...
}
Many APIs were changed:
final class Database {
- func tableExists(_ tableName: String) -> Bool
- func indexes(on tableName: String) -> [IndexInfo]
+ func tableExists(_ tableName: String) throws -> Bool
+ func indexes(on tableName: String) throws -> [IndexInfo]
}
final class DatabasePool {
- func read<T>(_ block: (Database) throws -> T) rethrows -> T
- func nonIsolatedRead<T>(_ block: (Database) throws -> T) rethrows -> T
- func readFromWrite(_ block: @escaping (Database) -> Void)
+ func read<T>(_ block: (Database) throws -> T) throws -> T
+ func nonIsolatedRead<T>(_ block: (Database) throws -> T) throws -> T
+ func readFromWrite(_ block: @escaping (Database) -> Void) throws
}
protocol DatabaseReader {
- func read<T>(_ block: (Database) throws -> T) rethrows -> T
- func nonIsolatedRead<T>(_ block: (Database) throws -> T) rethrows -> T
+ func read<T>(_ block: (Database) throws -> T) throws -> T
+ func nonIsolatedRead<T>(_ block: (Database) throws -> T) throws -> T
}
protocol DatabaseWriter {
- func readFromWrite(_ block: @escaping (Database) -> Void)
+ func readFromWrite(_ block: @escaping (Database) -> Void) throws
}
final class Row {
- static func fetch(...) -> DatabaseSequence<Row>
- static func fetchAll(...) -> [Row]
- static func fetchOne(...) -> Row?
+ static func fetchCursor(...) -> DatabaseCursor<Row>
+ static func fetchAll(...) throws -> [Row] {
+ static func fetchOne(...) throws -> Row?
}
extension DatabaseValueConvertible {
- static func fetch(...) -> DatabaseSequence<Self>
- static func fetchAll(...) -> [Self]
- static func fetchOne(...) -> Self?
+ static func fetchCursor(...) -> DatabaseCursor<Self>
+ static func fetchAll(...) throws -> [Self]
+ static func fetchOne(...) throws -> Self?
}
extension Optional where Wrapped: DatabaseValueConvertible {
- static func fetch(...) -> DatabaseSequence<Wrapped?>
- static func fetchAll(...) -> [Wrapped?]
+ static func fetchCursor(...) throws -> DatabaseCursor<Wrapped?>
+ static func fetchAll(...) throws -> [Wrapped?]
}
final class FetchedRecordsController<Record: RowConvertible> {
- init(...)
- func performFetch(...)
- func setRequest(...)
+ init(...) throws
+ func performFetch(...) throws
+ func setRequest(...) throws
}
protocol MutablePersistable : TableMapping {
- func exists(_ db: Database) -> Bool
+ func exists(_ db: Database) throws -> Bool
}
extension MutablePersistable {
- func performExists(_ db: Database) -> Bool
+ func performExists(_ db: Database) throws -> Bool
}
extension QueryInterfaceRequest {
- func fetchCount(...) -> Int
+ func fetchCount(...) throws -> Int
}
extension QueryInterfaceRequest where T: RowConvertible {
- func fetch(...) -> DatabaseSequence<T>
- func fetchAll(...) -> [T]
- func fetchOne(...) -> T?
+ func fetchCursor(...) throws -> DatabaseCursor<T>
+ func fetchAll(...) throws -> [T]
+ func fetchOne(...) throws -> T?
}
extension RowConvertible {
- static func fetch(...) -> DatabaseSequence<Self>
- static func fetchAll(...) -> [Self]
- static func fetchOne(...) -> Self?
+ static func fetchCursor(...) throws -> DatabaseCursor<Self> {
+ static func fetchAll(...) throws -> [Self] {
+ static func fetchOne(...) throws -> Self?
}
extension TableMapping {
- static func fetchCount(_ db: Database) -> Int
+ static func fetchCount(_ db: Database) throws -> Int
}
-struct DatabaseSequence<Element>: Sequence
-final class DatabaseIterator<Element>: IteratorProtocol
+extension Array {
+ init<C : Cursor>(_ cursor: C) throws where C.Element == Element
+}
+class AnyCursor<Element> : Cursor {
+ init<C : Cursor>(_ base: C) where C.Element == Element
+ init(_ body: @escaping () throws -> Element?)
+}
+protocol Cursor : class {
+ associatedtype Element
+ func next() throws -> Element?
+}
+extension Cursor {
+ func contains(where predicate: (Element) throws -> Bool) throws -> Bool
+ func enumerated() -> EnumeratedCursor<Self>
+ func filter(_ isIncluded: @escaping (Element) throws -> Bool) -> FilterCursor<Self>
+ func first(where predicate: (Element) throws -> Bool) throws -> Element?
+ func flatMap<ElementOfResult>(_ transform: @escaping (Element) throws -> ElementOfResult?) -> MapCursor<FilterCursor<MapCursor<Self, ElementOfResult?>>, ElementOfResult>
+ func flatMap<SegmentOfResult : Sequence>(_ transform: @escaping (Element) throws -> SegmentOfResult) -> FlattenCursor<MapCursor<Self, IteratorCursor<SegmentOfResult.Iterator>>>
+ func flatMap<SegmentOfResult : Cursor>(_ transform: @escaping (Element) throws -> SegmentOfResult) -> FlattenCursor<MapCursor<Self, SegmentOfResult>>
+ func forEach(_ body: (Element) throws -> Void) throws
+ func map<T>(_ transform: @escaping (Element) throws -> T) -> MapCursor<Self, T>
+ func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (Result, Element) throws -> Result) throws -> Result
+}
+extension Cursor where Element: Equatable {
+ func contains(_ element: Element) throws -> Bool
+}
+extension Cursor where Element: Cursor {
+ func joined() -> FlattenCursor<Self>
+}
+extension Cursor where Element: Sequence {
+ func joined() -> FlattenCursor<MapCursor<Self, IteratorCursor<Self.Element.Iterator>>>
+}
+final class DatabaseCursor<Element> : Cursor
+final class EnumeratedCursor<Base : Cursor> : Cursor
+final class FilterCursor<Base : Cursor> : Cursor
+final class FlattenCursor<Base: Cursor> : Cursor where Base.Element: Cursor
+final class MapCursor<Base : Cursor, Element> : Cursor
+final class IteratorCursor<Base : IteratorProtocol> : Cursor {
+ init(_ base: Base)
+ init<S : Sequence>(_ s: S) where S.Iterator == Base
+}
+extension Sequence {
+ func flatMap<SegmentOfResult : Cursor>(_ transform: @escaping (Iterator.Element) throws -> SegmentOfResult) -> FlattenCursor<MapCursor<IteratorCursor<Self.Iterator>, SegmentOfResult>>
+}
Released November 18, 2016
Fixed
- Fixed a couple Xcode 8.1 warnings
Released November 5, 2016
New
- Upgrade custom SQLite builds to v3.15.1 (thanks to @swiftlyfalling).
Fixed
-
FetchedRecordsController no longer exposes record comparison options to platforms that don't need them. The
isSameRecord
andcompareRecordsByPrimaryKey
parameters are now iOS only:// iOS only let controller = FetchedRecordsController<MyRecord>( dbQueue, request: ..., compareRecordsByPrimaryKey: true) // All platforms let controller = FetchedRecordsController<MyRecord>( dbQueue, request: ...)
Released October 26, 2016
Fixed
-
Query Interface:
CountableRange.contains()
no longer generates BETWEEN operator.For example,
1..<10.contains(Column("x"))
now generatesx >= 1 AND x < 10
instead ofx BETWEEN 1 AND 9
. This should better reflect the user intent whenever an Int range tests Double values.
Released October 19, 2016
Fixed
- When
Database.create(virtualTable:using:)
throws, it is now guaranteed that the virtual table table is not created. - FetchedRecordsController learned about
TableMapping.selectsRowID
, and is now able to animate table views populated with records without explicit primary key. - Restored SQLCipher installation procedure
Released October 17, 2016
Fixed
- FetchedRecordsController could miss database changes after its fetch request was modified. Now it properly updates the set of tracked columns and tables.
New
TableMapping.none()
: a fetch request which fetches nothing.
Released October 16, 2016
New
-
Full-text matching methods accept nil search patterns:
let pattern = FTS3SearchPattern(matchingAllTokensIn: "") // nil let documents = Document.matching(pattern).fetchAll(db) // Empty array
-
Synchronization of an FTS4 or FTS5 full-text table with an external content table (documentation):
// A regular table try db.create(table: "books") { t in t.column("author", .text) t.column("title", .text) t.column("content", .text) ... } // A full-text table synchronized with the regular table try db.create(virtualTable: "books_ft", using: FTS4()) { t in // or FTS5() t.synchronize(withTable: "books") t.column("author") t.column("title") t.column("content") }
-
Upgrade custom SQLite builds to v3.15.0 (thanks to @swiftlyfalling).
Breaking Change
-
The
VirtualTableModule
protocol has been modified:protocol VirtualTableModule { - func moduleArguments(_ definition: TableDefinition) -> [String] + func moduleArguments(for definition: TableDefinition, in db: Database) throws -> [String] + func database(_ db: Database, didCreate tableName: String, using definition: TableDefinition) throws }
Released October 12, 2016
New
- Support for custom full-text FTS5 tokenizers (documentation)
Breaking Changes
FTS3Tokenizer
has been renamedFTS3TokenizerDescriptor
FTS5Tokenizer
has been renamedFTS5TokenizerDescriptor
Released October 8, 2016
New
-
Full-Text Search. GRDB learned about FTS3, FTS4 and FTS5 full-text engines of SQLite (documentation).
-
Improved support for the hidden "rowid" column:
-
TableMapping.selectsRowID
: this optional static property allows records to fetch their hidden rowID column (documentation):// SELECT *, rowid FROM books Book.fetchAll(db)
-
fetchOne(_:key:)
,fetch(_:keys:)
,fetchAll(_:keys:)
,deleteOne(_:key:)
,deleteAll(_:keys:)
now use the hiddenrowid
column when the table has no explicit primary key.// DELETE FROM books WHERE rowid = 1 try Book.deleteOne(db, key: 1)
-
-
Upgrade custom SQLite builds to v3.14.2.
Breaking Changes
Row.value(column:)
has lost its parameter name:row.value(Column("id"))
.QueryInterfaceRequest
has lost its public initializer.
Released September 28, 2016
New
-
Enhanced extensibility. The low-level types that fuel the query interface requests and expressions have been refactored, have lost their underscore prefix, and are stabilizing. A new GRDB Extension Guide covers common extension use cases.
-
TableMapping
protocol learned how to delete all records right from the adopting type:try Person.deleteAll(db)
-
Support for the
LIKE
operator (fixes #133):// SELECT * FROM persons WHERE email LIKE '%@example.com' Person.filter(Column("email").like("%@example.com")).fetchAll(db)
Breaking Changes
- The SQLForeignKeyAction, SQLColumnType, SQLConflictResolution, and SQLCollation types have been renamed Database.ForeignKeyAction, Database.ColumnType, Database.ConflictResolution, and Database.CollationName.
Released September 16, 2016
New
- The Persistable protocol learned about conflict resolution, and can run
INSERT OR REPLACE
queries (documentation, fixes #118).
Released September 16, 2016
New
- Upgrade custom SQLite builds to v3.14.1.
Fixed
- Restore support for SQLite pre-update hooks
DatabaseValue.fromDatabaseValue()
returns.Null
for NULL input, instead of nil (fixes #119)
Breaking Change
-
Row.databaseValue(atIndex:)
andRow.databaseValue(named:)
have been removed. Usevalue(atIndex:)
andvalue(named:)
instead:-let dbValue = row.databaseValue(atIndex: 0) +let dbValue: DatabaseValue = row[0]
Released September 14, 2016
Fixed
Released September 11, 2016
New
- Swift 3
Breaking Changes
-
The Swift 3 Grand Renaming has impacted GRDB a lot.
General
- All enum cases now start with a lowercase letter.
Database Connections
-typealias BusyCallback = (numberOfTries: Int) -> Bool -enum BusyMode -enum CheckpointMode -enum TransactionKind -enum TransactionCompletion struct Configuration { - var fileAttributes: [String: AnyObject]? + var fileAttributes: [FileAttributeKey: Any] } class Database { + typealias BusyCallback = (_ numberOfTries: Int) -> Bool + enum BusyMode { + case immediateError + case timeout(TimeInterval) + case callback(BusyCallback) + } + enum CheckpointMode: Int32 { + case passive + case full + case restart + case truncate + } + enum TransactionKind { + case deferred + case immediate + case exclusive + } + enum TransactionCompletion { + case commit + case rollback + } } class DatabasePool { #if os(iOS) - func setupMemoryManagement(application application: UIApplication) + func setupMemoryManagement(in application: UIApplication) #endif #if SQLITE_HAS_CODEC - func changePassphrase(passphrase: String) throws + func change(passphrase: String) throws #endif } class DatabaseQueue { #if os(iOS) - func setupMemoryManagement(application application: UIApplication) + func setupMemoryManagement(in application: UIApplication) #endif #if SQLITE_HAS_CODEC - func changePassphrase(passphrase: String) throws + func change(passphrase: String) throws #endif }
Rows
final class Row { - init?(_ dictionary: NSDictionary) - func toNSDictionary() -> NSDictionary + init?(_ dictionary: [AnyHashable: Any]) }
Values
struct DatabaseValue { - init?(object: AnyObject) - func toAnyObject() -> AnyObject + init?(value: Any) } protocol DatabaseValueConvertible { - static func fromDatabaseValue(dbValue: DatabaseValue) -> DatabaseValue? + static func fromDatabaseValue(_ dbValue: DatabaseValue) -> DatabaseValue? } +extension Data : DatabaseValueConvertible +extension Date : DatabaseValueConvertible +extension URL : DatabaseValueConvertible +extension UUID : DatabaseValueConvertible
SQL Functions
class Database { - func addFunction(function: DatabaseFunction) - func removeFunction(function: DatabaseFunction) + func add(function: DatabaseFunction) + func remove(function: DatabaseFunction) } class DatabasePool { - func addFunction(function: DatabaseFunction) - func removeFunction(function: DatabaseFunction) + func add(function: DatabaseFunction) + func remove(function: DatabaseFunction) } class DatabaseQueue { - func addFunction(function: DatabaseFunction) - func removeFunction(function: DatabaseFunction) + func add(function: DatabaseFunction) + func remove(function: DatabaseFunction) } protocol DatabaseReader { - func addFunction(function: DatabaseFunction) - func removeFunction(function: DatabaseFunction) + func add(function: DatabaseFunction) + func remove(function: DatabaseFunction) } extension DatabaseFunction { -static let capitalizedString: DatabaseFunction -static let lowercaseString: DatabaseFunction -static let uppercaseString: DatabaseFunction -static let localizedCapitalizedString: DatabaseFunction -static let localizedLowercaseString: DatabaseFunction -static let localizedUppercaseString: DatabaseFunction +static let capitalize: DatabaseFunction +static let lowercase: DatabaseFunction +static let uppercase: DatabaseFunction +static let localizedCapitalize: DatabaseFunction +static let localizedLowercase: DatabaseFunction +static let localizedUppercase: DatabaseFunction }
SQL Collations
class Database { - func addCollation(collation: DatabaseCollation) - func removeCollation(collation: DatabaseCollation) + func add(collation: DatabaseCollation) + func remove(collation: DatabaseCollation) } class DatabasePool { - func addCollation(collation: DatabaseCollation) - func removeCollation(collation: DatabaseCollation) + func add(collation: DatabaseCollation) + func remove(collation: DatabaseCollation) } class DatabaseQueue { - func addCollation(collation: DatabaseCollation) - func removeCollation(collation: DatabaseCollation) + func add(collation: DatabaseCollation) + func remove(collation: DatabaseCollation) } protocol DatabaseReader { - func addCollation(collation: DatabaseCollation) - func removeCollation(collation: DatabaseCollation) + func add(collation: DatabaseCollation) + func remove(collation: DatabaseCollation) }
Prepared Statements
class Database { - func selectStatement(sql: String) throws -> SelectStatement - func updateStatement(sql: String) throws -> SelectStatement + func makeSelectStatement(_ sql: String) throws -> SelectStatement + func makeUpdateStatement(_ sql: String) throws -> SelectStatement } class Statement { - func validateArguments(arguments: StatementArguments) throws + func validate(arguments: StatementArguments) throws } struct StatementArguments { - init?(_ array: NSArray) - init?(_ dictionary: NSDictionary) + init?(_ array: [Any]) + init?(_ dictionary: [AnyHashable: Any]) }
Transaction Observers
Database events filtering is now performed by transaction observers themselves, in the new
observes(eventsOfKind:)
method of theTransactionObserver
protocol.class Database { - func addTransactionObserver(transactionObserver: TransactionObserverType, forDatabaseEvents filter: ((DatabaseEventKind) -> Bool)? = nil) - func removeTransactionObserver(transactionObserver: TransactionObserverType) + func add(transactionObserver: TransactionObserver) + func remove(transactionObserver: TransactionObserver) } protocol DatabaseWriter : DatabaseReader { - func addTransactionObserver(transactionObserver: TransactionObserverType, forDatabaseEvents filter: ((DatabaseEventKind) -> Bool)? = nil) - func removeTransactionObserver(transactionObserver: TransactionObserverType) + func add(transactionObserver: TransactionObserver) + func remove(transactionObserver: TransactionObserver) } -protocol TransactionObserverType : class { +protocol TransactionObserver : class { - func databaseDidChangeWithEvent(event: DatabaseEvent) - func databaseDidCommit(db: Database) - func databaseDidRollback(db: Database) + func observes(eventsOfKind eventKind: DatabaseEventKind) -> Bool + func databaseDidChange(with event: DatabaseEvent) + func databaseDidCommit(_ db: Database) + func databaseDidRollback(_ db: Database) #if SQLITE_ENABLE_PREUPDATE_HOOK - func databaseWillChangeWithEvent(event: DatabasePreUpdateEvent) + func databaseWillChange(with event: DatabasePreUpdateEvent) #endif }
Records
protocol RowConvertible { - init(_ row: Row) + init(row: Row) } protocol MutablePersistable { - mutating func didInsertWithRowID(rowID: Int64, forColumn column: String?) - mutating func insert(db: Database) throws - func update(db: Database, columns: Set<String>) throws - mutating func save(db: Database) throws - func delete(db: Database) throws -> Bool - func exists(db: Database) -> Bool + mutating func didInsert(with rowID: Int64, for column: String?) + mutating func insert(_ db: Database) throws + func update(_ db: Database, columns: Set<String>) throws + mutating func save(_ db: Database) throws + @discardableResult func delete(_ db: Database) throws -> Bool + func exists(_ db: Database) -> Bool } protocol Persistable : MutablePersistable { - func didInsertWithRowID(rowID: Int64, forColumn column: String?) - func insert(db: Database) throws - func save(db: Database) throws + func didInsert(with rowID: Int64, for column: String?) + func insert(_ db: Database) throws + func save(_ db: Database) throws } protocol TableMapping { - static func databaseTableName() -> String + static var databaseTableName: String { get } } -public class Record : RowConvertible, TableMapping, Persistable { +open class Record : RowConvertible, TableMapping, Persistable { - required init(_ row: Row) - class func databaseTableName() -> String - func awakeFromFetch(row row: Row) - func didInsertWithRowID(rowID: Int64, forColumn column: String?) - func update(db: Database, columns: Set<String>) throws - func insert(db: Database) throws - func save(db: Database) throws - func delete(db: Database) throws -> Bool + required init(row: Row) + class var databaseTableName: String + func awakeFromFetch(row: Row) + func didInsert(with rowID: Int64, for column: String?) + func update(_ db: Database, columns: Set<String>) throws + func insert(_ db: Database) throws + func save(_ db: Database) throws + @discardableResult func delete(_ db: Database) throws -> Bool }
Query Interface
protocol FetchRequest { - func prepare(db: Database) throws -> (SelectStatement, RowAdapter?) + func prepare(_ db: Database) throws -> (SelectStatement, RowAdapter?) } -struct SQLColumn {} +struct Column {} struct QueryInterfaceRequest<T> { - var distinct: QueryInterfaceRequest<T> { get } - var exists: _SQLExpression { get } - func reverse() -> QueryInterfaceRequest<T> + func distinct() -> QueryInterfaceRequest<T> + func exists() -> _SQLExpression + func reversed() -> QueryInterfaceRequest<T> } extension _SpecificSQLExpressible { - var capitalizedString: _SQLExpression { get } - var lowercaseString: _SQLExpression { get } - var uppercaseString: _SQLExpression { get } - var localizedCapitalizedString: _SQLExpression { get } - var localizedLowercaseString: _SQLExpression { get } - var localizedUppercaseString: _SQLExpression { get } + var capitalized: _SQLExpression { get } + var lowercased: _SQLExpression { get } + var uppercased: _SQLExpression { get } + var localizedCapitalized: _SQLExpression { get } + var localizedLowercased: _SQLExpression { get } + var localizedUppercased: _SQLExpression { get } }
Released September 28, 2016
New
- Added missing
@noescape
qualifiers. Merged #130 by @swiftlyfalling.
Released September 16, 2016
New
- Upgrade custom SQLite builds to v3.14.1.
Fixed
DatabaseValue.fromDatabaseValue()
returns.Null
for NULL input, instead of nil (fixes #119)
Breaking Change
-
Row.databaseValue(atIndex:)
andRow.databaseValue(named:)
have been removed. Usevalue(atIndex:)
andvalue(named:)
instead:-let dbValue = row.databaseValue(atIndex: 0) +let dbValue: DatabaseValue = row[0]
Released September 10, 2016
New
- Swift 2.3
Released September 9, 2016
Fixed
- WatchOS framework
Released September 8, 2016
Fixed
- WatchOS framework is now available through CocoaPods.
Released September 7, 2016
Fixed
Database.tableExists()
learned about temporary tables
New
-
WatchOS support
-
QueryInterfaceRequest.deleteAll()
deletes database rows:try Wine.filter(corked == true).deleteAll(db)
Released August 17, 2016
Fixed
- DatabasePool can now open an existing database which is not yet in the WAL mode, and then immediately read from it. It used to crash unless at least one write operation was performed before any read (fixes #102).
Released August 16, 2016
Fixed
-
Table creation DSL accepts auto references with implicit primary key:
try db.create(table: "nodes") { t in t.column("id", .Integer).primaryKey() t.column("parentId", .Integer).references("nodes") }
New
-
Use SQLColumn of the query interface when extracting values from rows:
let nameColumn = SQLColumn("name") let name: String = row.value(nameColumn)
Released August 10, 2016
Fixed
- Persistable used to generate sub optimal UPDATE requests.
Released August 10, 2016
Fixed
-
ColumnDefinition
check
andreferences
methods can now define several constraints:try db.create(table: "users") { t in t.column("name", .Text).notNull() .check { length($0) > 0 } .check { !["root", "admin"].contains($0) } }
-
Persistable
update
,exists
anddelete
methods now work with objects that have a nil primary key. They used to crash. -
The
update(_:columns:)
method, which performs partial updates, no longer ignores unknown columns.
Released August 8, 2016
Breaking Change
-
Column creation method
defaults(_:)
has been renameddefaults(to:)
.try db.create(table: "pointOfInterests") { t in t.column("favorite", .Boolean).notNull().defaults(to: false) ... }
Released August 6, 2016
New
-
Upgrade sqlcipher to v3.4.0 (announcement, changelog)
-
DSL for table creation and updates (closes #83, documentation):
try db.create(table: "pointOfInterests") { t in t.column("id", .Integer).primaryKey() t.column("title", .Text) t.column("favorite", .Boolean).notNull() t.column("longitude", .Double).notNull() t.column("latitude", .Double).notNull() }
-
Support for the
length
SQLite built-in function:try db.create(table: "persons") { t in t.column("name", .Text).check { length($0) > 0 } }
-
Row adopts DictionaryLiteralConvertible:
let row: Row = ["name": "foo", "date": NSDate()]
Breaking Changes
-
Built-in SQLite collations used to be named by string: "NOCASE", etc. Now use the SQLCollation enum:
.Nocase
, etc. -
PrimaryKey has been renamed PrimaryKeyInfo:
let pk = db.primaryKey("persons") pk.columns // ["id"]
Released July 28, 2016
New
-
Database.indexes(on:)
returns the indexes defined on a database table. -
Database.table(_:hasUniqueKey:)
returns true if a sequence of columns uniquely identifies a row, that is to say if the columns are the primary key, or if there is a unique index on them. -
MutablePersistable types, including Record subclasses, support partial updates:
try person.update(db) // Full update try person.update(db, columns: ["name"]) // Only updates the name column
Breaking Changes
-
MutablePersistable
update
andperformUpdate
methods have changed their signatures. You only have to care about this change if you customize the protocolupdate
method.protocol MutablePersistable : TableMapping { -func update(db: Database) throws +func update(db: Database, columns: Set<String>) throws } extension MutablePersistable { func update(db: Database) throws +func update(db: Database, columns: Set<String>) throws +func update<S: SequenceType where S.Generator.Element == SQLColumn>(db: Database, columns: S) throws +func update<S: SequenceType where S.Generator.Element == String>(db: Database, columns: S) throws -func performUpdate(db: Database) throws +func performUpdate(db: Database, columns: Set<String>) throws }
Released July 19, 2016
Breaking Change
-
The query interface
order
method now replaces any previously applied ordering (related issue: #85):// SELECT * FROM "persons" ORDER BY "name" Person.order(scoreColumn).order(nameColumn)
Released July 18, 2016
Fixed
- Fixed crashes that could happen when using virtual tables (fixes #82)
Released July 8, 2016
Fixed
- Fixed a crash that would happen when performing a full text search in a DatabasePool (fixes #80)
Released July 8, 2016
Breaking change
-
Row adapters have been refactored (documentation).
// Row "variants" have been renamed row "scopes": struct Row { - func variant(named name: String) -> Row? + func scoped(on name: String) -> Row? } // Scope definition: VariantRowAdapter has been renamed ScopeAdapter: -struct VariantRowAdapter : RowAdapter { - init(variants: [String: RowAdapter]) -} +struct ScopeAdapter : RowAdapter { + init(_ scopes: [String: RowAdapter]) +} // Adding scopes to an existing adapter: extension RowAdapter { - func adapterWithVariants(variants: [String: RowAdapter]) -> RowAdapter + func addingScopes(scopes: [String: RowAdapter]) -> RowAdapter } // Implementing custom adapters protocol ConcreteRowAdapter { - var variants: [String: ConcreteRowAdapter] { get } + var scopes: [String: ConcreteRowAdapter] { get } }
Released July 6, 2016
New
-
TableMapping protocol lets you delete rows identified by their primary keys, or any columns involved in a unique index (closes #56, documentation):
try Person.deleteOne(db, key: 1) try Person.deleteOne(db, key: ["email": "arthur@example.com"]) try Citizenship.deleteOne(db, key: ["personID": 1, "countryCode": "FR"]) try Country.deleteAll(db, keys: ["FR", "US"])
Breaking change
-
The
fetch(_:keys:)
,fetchAll(_:keys:)
andfetchOne(_:key:)
methods used to accept any dictionary of column/value pairs to identify rows. Now these methods raise a fatal error if the columns are not guaranteed, at the database level, to uniquely identify rows: columns must be the primary key, or involved in a unique index:// CREATE TABLE persons ( // id INTEGER PRIMARY KEY, -- can fetch and delete by id // email TEXT UNIQUE, -- can fetch and delete by email // name TEXT -- nope // ) Person.fetchOne(db, key: ["id": 1]) // Person? Person.fetchOne(db, key: ["email": "arthur@example.com"]) // Person? Person.fetchOne(db, key: ["name": "Arthur"]) // fatal error: table persons has no unique index on column name.
This change harmonizes the behavior of those fetching methods with the new
deleteOne(_:key:)
anddeleteAll(_:keys:)
.
Released June 20, 2016
Improved
- FetchedRecordsController doesn't check for changes when a database transaction modifies columns that are not present in the request it tracks.
New
-
The query interface lets you provide arguments to your sql snippets (documentation):
let wines = Wine.filter(sql: "origin = ?", arguments: ["Burgundy"]).fetchAll(db)
-
Transaction observers can efficiently filter the database changes they are interested in (documentation).
-
Support for NSUUID (documentation)
Released June 9, 2016
Improved
- NSDecimalNumber used to store as a double in the database, for all values. Now decimal numbers that contain integers fitting Int64 attempt to store integers in the database.
Breaking Changes
- Row adapters have been refactored (documentation).
Released June 5, 2016
Fixed
- Fix a crash that would sometimes happen when a FetchedRecordsController's callbacks avoid retain cycles by capturing unowned references.
- Improved handling of numeric overflows. Fixes #68.
New
- GRDB can now use a custom SQLite build (documentation). Merged #62 by @swiftlyfalling.
- With a custom SQLite build, transaction observers can observe individual column values in the rows modified by a transaction (documentation). Merged #63 by @swiftlyfalling.
- FetchedRecordsController can now fetch other values alongside the fetched records. This grants you the ability to fetch values that are consistent with the notified changes. (documentation)
Breaking Changes
- iOS7 is no longer supported.
Released May 30, 2016
Fixed
Database.cachedUpdateStatement(sql)
no longer returns a statement that can not be reused because it has already failed.
Released May 28, 2016
New
Database.inSavepoint()
allows fine-grained committing and rollbacking of database statements (documentation). Closes #61.
Released May 28, 2016
Fixed
- Database changes that are on hold because of a savepoint are only notified to transaction observers after the savepoint has been released. In previous versions of GRDB, savepoints had the opportunity to rollback a subset of database events, and mislead transaction observers about the actual content of a transaction. Related issue: #61.
New
DatabaseEvent.copy()
lets you store a database event notified to a transaction observer (documentation).
Released May 28, 2016
New
This release provides tools for your custom persistence mechanisms that don't use the built-in Persistable protocol, and addresses issue #60.
Database.primaryKey(tableName)
lets you introspect a table's primary key (documentation).Database.cachedSelectStatement(sql)
andDatabase.cachedUpdateStatement(sql)
provide robust caching of prepared statements (documentation)
Released May 22, 2016
New
- Row adapters let you map column names for easier row consumption (documentation). Fixes #50.
Released May 21, 2016
Fixed
-
The Record class no longer adopts the CustomStringConvertible protocol. This frees the
description
identifier for your record properties. Fixes #58. -
Several database connections can now be used at the same time: you can move values from one database to another. Fixes #55.
Breaking Changes
-
The maximum number of reader connections in a database pool is now configured in a Configuration object.
final class DatabasePool { - init(path: String, configuration: Configuration = default, maximumReaderCount: Int = default) throws + init(path: String, configuration: Configuration = default) throws } struct Configuration { + var maximumReaderCount: Int = default }
Released May 19, 2016
Fixed
- GRDB throws an early error when a connection to a file can not be established because it has the wrong format, or is encrypted. Fixes #54.
Breaking Change
-
The
FetchRequest
struct has been renamedQueryInterfaceRequest
. A newFetchRequest
protocol has been introduced. All APIs that used to consume theFetchRequest
struct now consume theFetchRequest
protocol.This change should not have any consequence on your source code, and paves the way for easier configuration of any piece of "code that fetches".
-struct FetchRequest<T> { -} +protocol FetchRequest { + func selectStatement(db: Database) throws -> SelectStatement +} +struct QueryInterfaceRequest<T> : FetchRequest { + init(tableName: String) +}
Released May 18, 2016
Fixed
- Restored GRDBCipher framework.
Breaking Changes
-
DatabaseValue.failableValue()
has been removed. Instead, use DatabaseConvertible.fromDatabaseValue():-let date = dbValue.failableValue() as NSDate? +let date = NSDate.fromDatabaseValue(dbValue)
-
Row.databaseValue(named:)
now returns an optional DatabaseValue. It is nil when the column does not exist in the row.class Row { - func databaseValue(named columnName: String) -> DatabaseValue + func databaseValue(named columnName: String) -> DatabaseValue? }
-
Row subscripting by column name has been removed. Instead, use
Row.databaseValue(named:)
class Row { - subscript(columnName: String) -> DatabaseValue? }
Released May 17, 2016
Fixed
- Restored support for iOS before 8.2 and OS X before 10.10. Fixes #51.
Breaking Changes
-
Support for advanced migrations is not available until iOS 8.2 and OS X 10.10:
struct DatabaseMigrator { - mutating func registerMigration(identifier: String, withDisabledForeignKeyChecks disabledForeignKeyChecks: Bool = false, migrate: (Database) throws -> Void) + mutating func registerMigration(identifier: String, migrate: (Database) throws -> Void) + @available(iOS 8.2, OSX 10.10, *) + mutating func registerMigrationWithDisabledForeignKeyChecks(identifier: String, migrate: (Database) throws -> Void)
Released May 12, 2016
Breaking Changes
-
FetchedRecordsController has been refactored (documentation):
- delegate has been replaced by callbacks
- features that target UITableView are now iOS only.
final class FetchedRecordsController<Record: RowConvertible> { - weak var delegate: FetchedRecordsControllerDelegate? - func recordAtIndexPath(indexPath: NSIndexPath) -> Record - func indexPathForRecord(record: Record) -> NSIndexPath? - var sections: [FetchedRecordsSectionInfo<Record>] + #if os(iOS) + typealias WillChangeCallback = FetchedRecordsController<Record> -> () + typealias DidChangeCallback = FetchedRecordsController<Record> -> () + typealias TableViewEventCallback = (controller: FetchedRecordsController<Record>, record: Record, event: TableViewEvent) -> () + func trackChanges( + recordsWillChange willChangeCallback: WillChangeCallback? = nil, + tableViewEvent tableViewEventCallback: TableViewEventCallback? = nil, + recordsDidChange didChangeCallback: DidChangeCallback? = nil) + func recordAtIndexPath(indexPath: NSIndexPath) -> Record + func indexPathForRecord(record: Record) -> NSIndexPath? + var sections: [FetchedRecordsSectionInfo<Record>] + #else + typealias WillChangeCallback = FetchedRecordsController<Record> -> () + typealias DidChangeCallback = FetchedRecordsController<Record> -> () + func trackChanges( + recordsWillChange willChangeCallback: WillChangeCallback? = nil, + recordsDidChange didChangeCallback: DidChangeCallback? = nil) + #endif } -protocol FetchedRecordsControllerDelegate : class { }
Released May 10, 2016
New
FetchedRecordsController
is now exposed in OSX CocoaPods framework (documentation)
Fixed
- Transactions that fail precisely on the COMMIT statement are now rollbacked (they used to remain open).
Released May 7, 2016
Fixed
- A crash that did happen when DatabasePool would incorrectly share a database statement between several reader connections.
- A memory leak that did happen when a Database connection was deallocated while some database statements were still alive.
Released May 5, 2016
New
DatabaseReader.backup(to destination: DatabaseWriter)
backups a database to another (documentation).
Released April 25, 2016
Fixed
- Carthage support is restored. Fixes #41.
Released April 23, 2016
New
Database.isInsideTransaction
is true if database is currently inside a transaction.
Fixed
- FetchRequest.reverse() sorts by reversed RowID when no base ordering has been specified.
Released April 20, 2016
New
Database.lastInsertedRowID
: The rowID of the most recent successful INSERT.Database.changesCount
: The number of rows modified, inserted or deleted by the most recent successful INSERT, UPDATE or DELETE statement.Database.totalChangesCount
: The total number of rows modified, inserted or deleted by all successful INSERT, UPDATE or DELETE statements since the database connection was opened.
Breaking Changes
Database.execute()
andUpdateStatement.execute()
now return Void. To get the last inserted rowId, use theDatabase.lastInsertedRowID
property.
Released April 8, 2016
Breaking Changes
-
Direct access to the database through DatabaseQueue and DatabasePool is no longer supported, because it can hide subtle concurrency bugs in your application:
// No longer supported, because too dangerous: try dbQueue.execute("INSERT ...") let person = Person.fetchOne(dbQueue, key: 1) // Always use an explicit DatabaseQueue or DatabasePool method instead: try dbQueue.inDatabase { db in try db.execute("INSERT ...") let person = Person.fetchOne(db, key: 1) } // Extract values: let person = dbQueue.inDatabase { db in Person.fetchOne(db, key: 1) }
For more information, see database connections.
If you are interested in the reasons behind a change that may look like a regression, read https://medium.com/@gwendal.roue/four-different-ways-to-handle-sqlite-concurrency-db3bcc74d00e.
-
The following methods have changed their signatures:
protocol MutablePersistable { mutating func insert(db: Database) throws func update(db: Database) throws mutating func save(db: Database) throws func delete(db: Database) throws -> Bool func exists(db: Database) -> Bool } protocol Persistable { func insert(db: Database) throws func save(db: Database) throws } class Record { func insert(db: Database) throws func update(db: Database) throws func save(db: Database) throws func delete(db: Database) throws -> Bool func exists(db: Database) -> Bool }
Released April 5, 2016
Fixed
- The
save()
method accepts again DatabaseQueue and DatabasePool arguments.
Released April 5, 2016
Fixed
- Restored CocoaPods support for iOS 8+ and OS X 10.9+
Released April 5, 2016
New
- The new framework GRDBCipher embeds SQLCipher and can encrypt databases (documentation)
DatabaseQueue.path
andDatabasePool.path
give the path to the database.
Fixed
- Restored iOS 7 compatibility
Breaking Changes (reverted in 0.56.2)
- The
save()
method now only accepts a database connection, and won't accept a database queue or database pool as an argument. This change makes sure that this method that may execute several SQL statements is called in an isolated fashion.
Released March 31, 2016
New (iOS only)
DatabaseQueue.setupMemoryManagement(application:)
andDatabasePool.setupMemoryManagement(application:)
make sure GRDB manages memory as a good iOS citizen (documentation).
Released March 31, 2016
Fixed
- Messages of failed preconditions are no longer lost when GRDB is built in Release configuration. Fixes #37.
Released March 29, 2016
This release restores CocoaPods support for iOS 9.0+ and OSX 10.11+. We'll try to bring back CocoaPods support for iOS 8.0+ or OSX 10.9+ in a further release.
Released March 29, 2016
New
-
FetchedRecordsController
helps feeding a UITableView with the results returned from a database request (documentation). Many thanks to Pascal Edmond for this grandiose feature. -
The standard Swift string properties
capitalizedString
,lowercaseString
,uppercaseString
,localizedCapitalizedString
,localizedLowercaseString
,localizedUppercaseString
are available for your database requests (documentation). -
The standard Swift comparison functions
caseInsensitiveCompare
,localizedCaseInsensitiveCompare
,localizedCompare
,localizedStandardCompare
andunicodeCompare
are available for your database requests (documentation).
Fixed
- The query interface
uppercaseString
andlowercaseString
no longer invoke the non unicode aware UPPER and LOWER SQLite functions. They instead call the standard Swift String propertiesuppercaseString
andlowercaseString
.
Breaking Change
-
The following method has changed its signature:
protocol RowConvertible { mutating func awakeFromFetch(row row: Row) }
Released March 25, 2016
Fixed
-
Row.value()
andDatabaseValue.value()
now raise a fatal error when they can not convert a non-NULL value to the requested type (documentation), effectively preventing silent data loss.Use the new
DatabaseValue.failableValue()
method if you need the old behavior that returned nil for failed conversions.
New
Row.databaseValue(atIndex:)
andRow.databaseValue(named:)
expose the DatabaseValues of a row.DatabaseValue.failableValue()
returns nil when a non-NULL value can not be converted to the requested type.
Released March 24, 2016
Fixed
-
The query interface now generates robust SQL for explicit boolean comparisons.
// SELECT * FROM "pointOfInterests" WHERE "favorite" PointOfInterest.filter(favorite == true).fetchAll(db)
Previous versions used to generate fragile comparisons to 0 and 1 which did badly interpret true values such as 2.
Released March 21, 2016
New
- Swift 2.2, and Xcode 7.3
Row
adopts the standardEquatable
protocol.
Released March 14, 2016
Fixed
- A race condition that could prevent
Configuration.fileAttributes
from being applied to some database files.
Released March 13, 2016
Nothing new, but performance improvements
Released March 13, 2016
New
-
Support for file attributes
var config = Configuration() config.fileAttributes = [NSFileProtectionKey: NSFileProtectionComplete] let dbPool = DatabasePool(path: ".../db.sqlite", configuration: config)
GRDB will take care of applying them to the database file and all its derivatives (
-wal
and-shm
files created by the WAL mode, as well as temporary files).
Released March 12, 2016
Fixed
- A database connection won't close as long as there is a database sequence being iterated.
Released March 12, 2016
New
-
Database updates no longer need to be executed in a closure:
// Before: try dbQueue.inDatabase { db in try db.execute("CREATE TABLE ...") let person = Person(...) try person.insert(db) } // New: try dbQueue.execute("CREATE TABLE ...") let person = Person(...) try person.insert(dbQueue)
-
DatabaseQueue and DatabasePool both adopt the new DatabaseReader and DatabaseWriter protocols.
Breaking Changes
-
The following methods have changed their signatures:
protocol MutablePersistable { mutating func insert(db: DatabaseWriter) throws func update(db: DatabaseWriter) throws mutating func save(db: DatabaseWriter) throws func delete(db: DatabaseWriter) throws -> Bool func exists(db: DatabaseReader) -> Bool } protocol Persistable { func insert(db: DatabaseWriter) throws func save(db: DatabaseWriter) throws } class Record { func insert(db: DatabaseWriter) throws func update(db: DatabaseWriter) throws func save(db: DatabaseWriter) throws func delete(db: DatabaseWriter) throws -> Bool func exists(db: DatabaseReader) -> Bool }
Released March 11, 2016
New
-
Read-only database pools grant you with concurrent reads on a database, without activating the WAL mode.
-
All fetchable types can now be fetched directly from database queues and pools:
// Before: let persons = dbQueue.inDatabase { db in Person.fetchAll(db) } // New: let persons = Person.fetchAll(dbQueue)
Breaking Changes
- Transaction observers are no longer added to Database instances, but to DatabaseQueue and DatabasePool.
Released March 10, 2016
New
DatabaseQueue.releaseMemory()
andDatabasePool.releaseMemory()
claim non-essential memory (documentation)
Breaking Changes
- Custom functions and collations are no longer added to Database instances, but to DatabaseQueue and DatabasePool.
Released March 10, 2016
New
- Support for concurrent accesses to the database, using the SQLite WAL Mode. (documentation)
Released March 5, 2016
New
- Improved counting support in the query interface (documentation)
Breaking Changes
- Swift enums that behave like other database values now need to declare
DatabaseValueConvertible
adoption. TheDatabaseIntRepresentable
,DatabaseInt32Representable
,DatabaseInt64Representable
andDatabaseStringRepresentable
protocols have been removed (documentation)
Released February 11, 2016
Fixed
- Restored iOS 7 compatibility
Released February 9, 2016
Breaking Change
- Transaction observers are no longer retained (documentation).
Released February 9, 2016
Fixed
row.value(named:)
androw[_]
reliably returns the value for the leftmost case-insensitive matching column.- A memory leak
New
Support for more SQL expressions in the query interface:
IN (subquery)
EXISTS (subquery)
Released February 4, 2016
Fixed
- SQL queries ending with a semicolon followed by whitespace characters no longer throw errors.
Released February 1, 2016
Breaking Changes
- Static method
RowConvertible.fromRow(_:Row)
has been replaced by a regular conversion initializerRowConvertible.init(_:Row)
(documentation)
Released January 29, 2016
Fixed
- Improved consistency of the query interface.
Released January 28, 2016
New
-
The query interface lets you write pure Swift instead of SQL (documentation):
let wines = Wine.filter(origin == "Burgundy").order(price).fetchAll(db)
Breaking Changes
DatabasePersistable
andMutableDatabasePersistable
protocols have been renamedPersistable
andMutablePersistable
(documentation)DatabaseTableMapping
protocol has been renamedTableMapping
(documentation)
Released January 17, 2016
New
You can now register several database observers, thanks to @pakko972 (documentation):
Database.addTransactionObserver()
Database.removeTransactionObserver()
Breaking Changes
Configuration.transactionObserver
has been removed.
Released January 14, 2016
New
- Various performance improvements
Statement.unsafeSetArguments(_)
binds arguments in a prepared statement without checking if arguments fit.
Released January 13, 2016
New
- Various performance improvements
Fixed
- Fixed the change tracking of Record subclasses that mangle the case of column names.
Released January 11, 2016
Breaking Changes
- Removed partial update introduced in 0.38.0.
Released January 10, 2016
Fixed
- Preconditions on invalid statements arguments are restored.
Released January 10, 2016
New
- Various performance improvements
Released January 8, 2016
New
-
Record.update()
andDatabasePersistable.update()
can execute partial updates:try person.update(db) // Full update try person.update(db, columns: ["age"]) // Only updates the age column
Breaking Changes
-
Statement.arguments
is no longer optional. -
Your Record subclasses and DatabasePersistable types that provide custom implementation of
update
must use the signature below:func update(db: Database, columns: [String]? = nil) throws
Released January 7, 2016
Fixed
- Remove method
fromRow()
from NSData, NSDate, NSNull, NSNumber, NSString and NSURL, which should have been removed in v0.36.0.
Released January 7, 2016
Fixed
- A named argument such as
:name
can now be used several times in a statement. - Validation of statement arguments is much more solid (and tested).
New
-
Database.execute()
can now execute several statements separated by a semicolon. -
Statement.validateArguments(_)
throws an error if the arguments parameter doesn't match the prepared statement:let statement = try db.selectStatement("SELECT * FROM persons WHERE id = ?") // OK try statement.validateArguments([1]) // Error: wrong number of statement arguments: 2 try statement.validateArguments([1, 2])
Breaking Changes
Database.executeMultiStatement(sql)
has been removed. To execute several SQL statements separated by a semicolon, useDatabase.execute()
instead.
Released December 28, 2015
Fixed
DatabaseValueConvertible
no longer inherits fromRowConvertible
.Database.execute()
now accepts SQL queries that fetch rows (#15).
Breaking Changes
- Methods that return prepared statements can now throw errors (documentation).
Row(dictionary:)
has been renamedRow(_:)
.RowConvertible.awakeFromFetch()
now takes a database argument (documentation).
Released December 22, 2015
The Record class has been refactored so that it gets closer from the RowConvertible and DatabasePersistable protocols. It also makes it easier to write subclasses that have non-optional properties.
Methods names that did not match Swift 3 API Design Guidelines have been refactored.
New
Float
adopts DatabaseValueConvertible, and can be stored and fetched from the database without Double conversion (documentation).
Breaking Changes
Record (documentation):
Record.storedDatabaseDictionary
has been renamedpersistentDictionary
.Record.reload()
has been removed. You have to provide your own implementation, should you need reloading.Record.init(row: Row)
has been renamedRecord.init(_ row: Row)
(unlabelled row argument).Record.updateFromRow()
has been removed. Overrideinit(_ row: Row)
instead.Record.didInsertWithRowID(_:forColumn:)
should be overriden by Record subclasses that are interested in their row ids.Record.databaseEdited
has been renamedhasPersistentChangedValues
.Record.databaseChanges
has been renamedpersistentChangedValues
and now returns[String: DatabaseValue?]
, the dictionary of old values for changed columns.
Row:
Row.value(named:)
andRow.dataNoCopy(named:)
returns nil if no such column exists in the row. It used to crash with a fatal error (documentation).
DatabasePersistable:
DatabasePersistable.storedDatabaseDictionary
has been renamedpersistentDictionary
(documentation).
DatabaseValue:
DatabaseValue
has no public initializers. To create one, useDatabaseValue.Null
, or the fact that Int, String, etc. adopt the DatabaseValueConvertible protocol:1.databaseValue
,"foo".databaseValue
(documentation).
DatabaseMigrator:
DatabaseMigrator.registerMigrationWithoutForeignKeyChecks(_:_:)
has been renamedDatabaseMigrator.registerMigration(_:withDisabledForeignKeyChecks:migrate:)
(documentation).
Released December 14, 2015
New
DatabaseValueConvertible
now inherits fromRowConvertible
.
Breaking Changes
RowConvertible
no longer requires aninit(row:Row)
initializer, but astatic func fromRow(_:Row) -> Self
factory method.RowConvertible
dictionary initializers have been removed.
Released December 11, 2015
New
- The
DatabasePersistable
andMutableDatabasePersistable
protocols grant any adopting type the persistence methods that used to be reserved to subclasses ofRecord
(#12) Database.clearSchemaCache()
Breaking Changes
RecordError
has been renamedPersistenceError
Record.databaseTableName()
now returns a non-optional String.
Released December 3, 2015
Fixed
- Errors thrown by update statements expose the correct statement arguments.
Released December 2, 2015
Fixed
DatabaseCollation
did incorrectly process strings provided by sqlite.
Released November 23, 2015
New
DatabaseCollation
let you inject custom string comparison functions into SQLite.DatabaseValue
adopts Hashable.DatabaseValue.isNull
is true if a database value is NULL.DatabaseValue.storage
exposes the underlying SQLite storage (NULL, INTEGER, REAL, TEXT, BLOB).
Released November 19, 2015
New
DatabaseFunction
lets you define custom SQL functions.
Released November 17, 2015
Fixed
- Prepared statements won't execute unless their arguments are all set.
Released November 14, 2015
New
DatabaseValue.init?(object: AnyObject)
initializer.StatementArguments.Default
is the preferred sentinel for functions that have an optional arguments parameter.
Breaking Changes
Row.init?(dictionary: NSDictionary)
is now a failable initializer which returns nil if the NSDictionary contains invalid values.RowConvertible.init?(dictionary: NSDictionary)
is now a failable initializer which returns nil if the NSDictionary contains invalid values.StatementArguments.init?(_ array: NSArray)
is now a failable initializer which returns nil if the NSArray contains invalid values.StatementArguments.init?(_ dictionary: NSDictionary)
is now a failable initializer which returns nil if the NSDictionary contains invalid values.- All methods that used to have an
StatementArguments?
parameter with nil default value now have a non-optionalStatementArguments
parameter withStatementArguments.Default
as a default value. This makes sure failable StatementArguments initializers don't let invalid inputs sneak in your queries.
Released November 13, 2015
Breaking Change
- The methods of protocol
TransactionObserverType
are no longer optional.
Released November 4, 2015
New
DatabaseCoder
reads and stores objects that conform to NSCoding in the database.Database.inTransaction()
executes a block inside a database transaction.DatabaseMigrator.registerMigrationWithoutForeignKeyChecks()
let you make arbitrary changes to the database schema, as described at https://www.sqlite.org/lang_altertable.html#otheralter.
Breaking Changes
Record.delete
returns a Bool which tells whether a database row was deleted or not.
Released October 31, 2015
Fixed repository mess introduced by 0.26.0
Released October 31, 2015
Breaking Changes
- The
fetch(:primaryKeys:)
,fetchAll(:primaryKeys:)
andfetchOne(:primaryKey:)
methods have been renamedfetch(:keys:)
,fetchAll(:keys:)
andfetchOne(:key:)
.
Released October 29, 2015
Fixed
Record.reload(_)
is no longer a final method.- GRDB always crashes when you try to convert a database NULL to a non-optional value.
New
- CGFloat can be stored and read from the database.
Person.fetch(_:primaryKeys:)
returns a sequence of objects with matching primary keys.Person.fetchAll(_:primaryKeys:)
returns an array of objects with matching primary keys.Person.fetch(_:keys:)
returns a sequence of objects with matching keys.Person.fetchAll(_:keys:)
returns an array of objects with matching keys.
Released October 14, 2015
Fixed
- Restored iOS 7 compatibility
Released October 13, 2015
New
Row()
initializes an empty row.
Breaking Changes
- NSData is now the canonical type for blobs. The former intermediate
Blob
type has been removed. DatabaseValue.dataNoCopy()
has turned useless, and has been removed.
Released October 8, 2015
New
Database.sqliteConnection
: the raw SQLite connection, suitable for SQLite C API.Statement.sqliteStatement
: the raw SQLite statement, suitable for SQLite C API.
Released October 1, 2015
Fixed
RowConvertible.awakeFromFetch(_)
is declared asmutating
.
New
-
Improved value extraction errors.
-
Row.hasColumn(_)
-
RowConvertible
andRecord
get a dictionary initializer for free:class Person: Record { ... } let person = Person(dictionary: ["name": "Arthur", "birthDate": nil])
-
Improved Foundation support:
Row(dictionary: NSDictionary) Row.toDictionary() -> NSDictionary
-
Int32 and Int64 enums are supported via DatabaseInt32Representable and DatabaseInt64Representable.
Breaking Changes
TraceFunction
is now defined as(String) -> ()
Released September 29, 2015
New
- Support for NSURL
Breaking Changes
- The improved TransactionObserverType protocol lets adopting types modify the database after a successful commit or rollback, and abort a transaction with an error.
Released September 28, 2015
New
- The
Configuration.transactionObserver
lets you observe database changes.
Released September 26, 2015
Fixed
- It is now mandatory to provide values for all arguments of an SQL statement. GRDB used to assume NULL for missing ones.
New
Row.dataNoCopy(atIndex:)
andRow.dataNoCopy(named:)
.Blob.dataNoCopy
DatabaseValue.dataNoCopy
Breaking Changes
String.fetch...
now returns non-optional values. UseOptional<String>.fetch...
when values may be NULL.
Released September 24, 2015
New
- Performance improvements.
- You can extract non-optional values from Row and DatabaseValue.
- Types that adopt SQLiteStatementConvertible on top of the DatabaseValueConvertible protocol are granted with faster database access.
Breaking Changes
- Rows can be reused during a fetch query iteration. Use
row.copy()
to keep one. - Database sequences are now of type DatabaseSequence.
- Blob and NSData relationships are cleaner.
Released September 14, 2015
New
Configuration.busyMode
let you specify how concurrent connections should handle database locking.Configuration.transactionType
let you specify the default transaction type.
Breaking changes
- Default transaction type has changed from EXCLUSIVE to IMMEDIATE.
Released September 12, 2015
Fixed
- Usage assertions used to be disabled. They are activated again.
Breaking changes
DatabaseQueue.inDatabase
andDatabaseQueue.inTransaction
are no longer reentrant.
Released September 12, 2015
Fixed
DatabaseQueue.inTransaction()
no longer crashes when SQLite returns a SQLITE_BUSY error code.
Breaking changes
Database.updateStatement(_:)
is no longer a throwing method.DatabaseQueue.inTransaction()
is now declared asthrows
, notrethrows
.
Released September 10, 2015
New
DatabaseQueue.inDatabase
andDatabaseQueue.inTransaction
are now reentrant. You can't open a transaction inside another, though.Record.copy()
returns a copy of the receiver.Row[columnName]
andRow.value(named:)
are now case-insensitive.
Breaking changes
- Requires Xcode 7.0 (because of #2)
RowModel
has been renamedRecord
.Record.copyDatabaseValuesFrom
has been removed in favor ofRecord.copy()
.Record.awakeFromFetch()
now takes a row argument.
Released September 6, 2015
New
RowConvertible
andDatabaseTableMapping
protocols grant any type the fetching methods that used to be a privilege ofRowModel
.Row.columnNames
returns the names of columns in the row.Row.databaseValues
returns the database values in the row.Blob.init(bytes:length:)
is a new initializer.DatabaseValueConvertible
can now be adopted by non-final classes.NSData
,NSDate
,NSNull
,NSNumber
andNSString
adoptDatabaseValueConvertible
and can natively be stored and fetched from a database.
Breaking changes
DatabaseDate
has been removed (replaced by built-in NSDate support).DatabaseValueConvertible
:init?(dbValue:)
has been replaced bystatic func fromDatabaseValue(_:) -> Self?
Blob.init(_:)
has been replaced withBlob.init(data:)
andBlob.init(dataNoCopy:)
.RowModel.edited
has been renamedRowModel.databaseEdited
.RowModel.databaseTable
has been replaced withRowModel.databaseTableName()
which returns a String.RowModel.setDatabaseValue(_:forColumn:)
has been removed. Use and overrideRowModel.updateFromRow(_:)
instead.RowModel.didFetch()
has been renamedRowModel.awakeFromFetch()
Released September 4, 2015
Breaking changes
The fetching methods are now available on the fetched type themselves:
dbQueue.inDatabase { db in
Row.fetch(db, "SELECT ...", arguments: ...) // AnySequence<Row>
Row.fetchAll(db, "SELECT ...", arguments: ...) // [Row]
Row.fetchOne(db, "SELECT ...", arguments: ...) // Row?
String.fetch(db, "SELECT ...", arguments: ...) // AnySequence<String?>
String.fetchAll(db, "SELECT ...", arguments: ...) // [String?]
String.fetchOne(db, "SELECT ...", arguments: ...) // String?
Person.fetch(db, "SELECT ...", arguments: ...) // AnySequence<Person>
Person.fetchAll(db, "SELECT ...", arguments: ...) // [Person]
Person.fetchOne(db, "SELECT ...", arguments: ...) // Person?
}
Released September 4, 2015
New
DatabaseValue
adoptsDatabaseValueConvertible
: a fetched value can be used as an argument of another query, without having to convert the raw database value into a regular Swift type.Row.init(dictionary)
lets you create a row from scratch.RowModel.didFetch()
is an overridable method that is called after a RowModel has been fetched or reloaded.RowModel.updateFromRow(row)
is an overridable method that helps updating compound properties that do not fit in a single column, such as CLLocationCoordinate2D.
Released August 25, 2015
Fixed
- Reduced iOS Deployment Target to 8.0, and OSX Deployment Target to 10.9.
DatabaseQueue.inTransaction()
is now declared asrethrows
.
Breaking changes
- Requires Xcode 7 beta 6
QueryArguments
has been renamedStatementArguments
.
Released August 18, 2015
New
RowModel.exists(db)
returns whether a row model has a matching row in the database.Statement.arguments
property gains a public setter.Database.executeMultiStatement(sql)
can execute several SQL statements separated by a semi-colon (#6 by peter-ss)
Breaking changes
Released July 30, 2015
New
RowModel.delete(db)
returns whether a database row was deleted or not.
Breaking changes
RowModelError.InvalidPrimaryKey
has been replaced by a fatal error.
Released July 30, 2015
New
DatabaseDate
can read dates stored as Julian Day Numbers.Int32
can be stored and fetched.
Released July 22, 2015
New
DatabaseDate
handles storage of NSDate in the database.DatabaseDateComponents
handles storage of NSDateComponents in the database.
Fixed
RowModel.save(db)
callsRowModel.insert(db)
orRowModel.update(db)
so that eventual overridden versions ofinsert
orupdate
are invoked.QueryArguments(NSArray)
andQueryArguments(NSDictionary)
now accept NSData elements.
Breaking changes
- "Bindings" has been renamed "QueryArguments", and
bindings
parameters renamedarguments
. - Reusable statements no longer expose any setter for their
arguments
property, and no longer accept any arguments in their initializer. To apply arguments, give them to theexecute()
andfetch()
methods. RowModel.isEdited
andRowModel.setEdited()
have been replaced by theRowModel.edited
property.
Released July 12, 2015
Fixed
RowModel.save(db)
makes its best to store values in the database. In particular, when the row model has a non-nil primary key, it will insert when there is no row to update. It used to throw RowModelNotFound in this case.
Released July 11, 2015
New
-
Blob.init?(NSData?)
Creates a Blob from NSData. Returns nil if and only if data is nil or zero-length (SQLite can't store empty blobs).
-
RowModel.isEdited
A boolean that indicates whether the row model has changes that have not been saved.
This flag is purely informative: it does not alter the behavior the update() method, which executes an UPDATE statement in every cases.
But you can prevent UPDATE statements that are known to be pointless, as in the following example:
let json = ... // Fetches or create a new person given its ID: let person = Person.fetchOne(db, primaryKey: json["id"]) ?? Person() // Apply json payload: person.updateFromJSON(json) // Saves the person if it is edited (fetched then modified, or created): if person.isEdited { person.save(db) // inserts or updates }
-
RowModel.copyDatabaseValuesFrom(_:)
Updates a row model with values of another one.
-
DatabaseValue
adopts Equatable.
Breaking changes
RowModelError.UnspecifiedTable
andRowModelError.InvalidDatabaseDictionary
have been replaced with fatal errors because they are programming errors.
Released July 9, 2015
Breaking changes
- Requires Xcode 7 beta 3
New
RowModelError.InvalidDatabaseDictionary
: new error case that helps you designing a fine RowModel subclass.
Released July 9, 2015
Initial release