A type-safe, Swift-language layer over SQLite3.

SQLite.swift provides compile-time confidence in SQL statement syntax and intent.

This fork of Stephen Celis' work is intended to interoperate with the port of Spatialite for iOS by Ryan Powell. Instead of linking with the built-in iOS sqlite3 library, it links with the customized build of sqlite3 included in that library.

• A pure-Swift interface
• A type-safe, optional-aware SQL expression builder
• A flexible, chainable, lazy-executing query layer
• Automatically-typed data access
• A lightweight, uncomplicated query and parameter binding interface
• Developer-friendly error handling and debugging
• Full-text search support
• Well-documented
• Extensively tested
• SQLCipher support via CocoaPods
• Active support at StackOverflow, and Gitter Chat Room (experimental)

import SQLite

let db = try Connection("path/to/db.sqlite3")

let users = Table("users")
let id = Expression<Int64>("id")
let name = Expression<String?>("name")
let email = Expression<String>("email")

try db.run(users.create { t in
    t.column(id, primaryKey: true)
    t.column(name)
    t.column(email, unique: true)
})
// CREATE TABLE "users" (
//     "id" INTEGER PRIMARY KEY NOT NULL,
//     "name" TEXT,
//     "email" TEXT NOT NULL UNIQUE
// )

let insert = users.insert(name <- "Alice", email <- "alice@mac.com")
let rowid = try db.run(insert)
// INSERT INTO "users" ("name", "email") VALUES ('Alice', 'alice@mac.com')

for user in try db.prepare(users) {
    print("id: \(user[id]), name: \(user[name]), email: \(user[email])")
    // id: 1, name: Optional("Alice"), email: alice@mac.com
}
// SELECT * FROM "users"

let alice = users.filter(id == rowid)

try db.run(alice.update(email <- email.replace("mac.com", with: "me.com")))
// UPDATE "users" SET "email" = replace("email", 'mac.com', 'me.com')
// WHERE ("id" = 1)

try db.run(alice.delete())
// DELETE FROM "users" WHERE ("id" = 1)

db.scalar(users.count) // 0
// SELECT count(*) FROM "users"

SQLite.swift also works as a lightweight, Swift-friendly wrapper over the C API.

let stmt = try db.prepare("INSERT INTO users (email) VALUES (?)")
for email in ["betty@icloud.com", "cathy@icloud.com"] {
    try stmt.run(email)
}

db.totalChanges    // 3
db.changes         // 1
db.lastInsertRowid // 3

for row in try db.prepare("SELECT id, email FROM users") {
    print("id: \(row[0]), email: \(row[1])")
    // id: Optional(2), email: Optional("betty@icloud.com")
    // id: Optional(3), email: Optional("cathy@icloud.com")
}

db.scalar("SELECT count(*) FROM users") // 2

Read the documentation or explore more, interactively, from the Xcode project’s playground.

For a more comprehensive example, see this article and the companion repository.

Note: SQLite.swift requires Swift 3 (and Xcode 8) or greater. If you absolutely need compatibility with Swift 2.3 you can use the swift-2.3 branch or older released versions. New development will happen exclusively on the master/Swift 3 branch.

The following instructions apply to targets that support embedded Swift frameworks. To use SQLite.swift in iOS 7 or an OS X command line tool, please read the Frameworkless Targets section of the documentation.

Carthage is a simple, decentralized dependency manager for Cocoa. To install SQLite.swift with Carthage:

1. Make sure Carthage is installed.

2. Update your Cartfile to include the following:

   github "stephencelis/SQLite.swift" ~> 0.11.1
   

3. Run carthage update and add the appropriate framework.

CocoaPods is a dependency manager for Cocoa projects. To install SQLite.swift with CocoaPods:

1. Verify that your copy of Xcode is installed in the default location (/Application/Xcode.app).

2. Make sure the latest CocoaPods beta is installed. (SQLite.swift requires version 1.0.0 or greater.)

   # Using the default Ruby install will require you to use sudo when
   # installing and updating gems.
   [sudo] gem install cocoapods

3. Update your Podfile to include the following:

   use_frameworks!
   
   target 'YourAppTargetName' do
       pod 'SQLite.swift', '~> 0.11.1'
   end

4. Run pod install --repo-update.

To install SQLite.swift as an Xcode sub-project:

1. Drag the SQLite.xcodeproj file into your own project. (Submodule, clone, or download the project first.)

   

2. In your target’s General tab, click the + button under Linked Frameworks and Libraries.

3. Select the appropriate SQLite.framework for your platform.

4. Add.

Some additional steps are required to install the application on an actual device:

5. In the General tab, click the + button under Embedded Binaries.

6. Select the appropriate SQLite.framework for your platform.

7. Add.

See the planning document for a roadmap and existing feature requests.

Read the contributing guidelines. The TL;DR (but please; R):

• Need help or have a general question? Ask on Stack Overflow (tag sqlite.swift).
• Found a bug or have a feature request? Open an issue.
• Want to contribute? Submit a pull request.

• Stephen Celis (@stephencelis)

SQLite.swift is available under the MIT license. See the LICENSE file for more information.

These projects enhance or use SQLite.swift:

• SQLiteMigrationManager.swift (inspired by FMDBMigrationManager)

Looking for something else? Try another Swift wrapper (or FMDB):

• Camembert
• GRDB
• SQLiteDB
• Squeal
• SwiftData
• SwiftSQLite