A type-safe, Swift-language layer over SQLite3.
SQLite.swift provides compile-time confidence in SQL statement syntax and intent.
- 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
letdb=tryConnection("path/to/db.sqlite3")letusers=Table("users")letid=Expression<Int64>("id")letname=Expression<String?>("name")letemail=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
// )
letinsert= users.insert(name <-"Alice", email <-"alice@mac.com")letrowid=try db.run(insert)
// INSERT INTO "users" ("name", "email") VALUES ('Alice', 'alice@mac.com')
foruserintry 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"
letalice= 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)
try db.scalar(users.count) // 0
// SELECT count(*) FROM "users"SQLite.swift also works as a lightweight, Swift-friendly wrapper over the C API.
letstmt=try db.prepare("INSERT INTO users (email) VALUES (?)")foremailin["betty@icloud.com","cathy@icloud.com"]{try stmt.run(email)}
db.totalChanges // 3
db.changes // 1
db.lastInsertRowid // 3
forrowintry 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")
}try db.scalar("SELECT count(*) FROM users") // 2Read 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 4.1 (and Xcode 9.3).
Carthage is a simple, decentralized dependency manager for Cocoa. To install SQLite.swift with Carthage:
Make sure Carthage is installed.
Update your Cartfile to include the following:
github"stephencelis/SQLite.swift" ~> 0.11.5
Run
carthage updateand add the appropriate framework.
CocoaPods is a dependency manager for Cocoa projects. To install SQLite.swift with CocoaPods:
Make sure CocoaPods 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
Update your Podfile to include the following:
use_frameworks!target'YourAppTargetName'dopod'SQLite.swift','~> 0.11.5'end
Run
pod install --repo-update.
The Swift Package Manager is a tool for managing the distribution of Swift code.
- Add the following to your
Package.swiftfile:
dependencies:[.package(url:"https://github.com/stephencelis/SQLite.swift.git", from:"0.11.5")]- Build your project:
$ swift buildTo install SQLite.swift as an Xcode sub-project:
Drag the SQLite.xcodeproj file into your own project. (Submodule, clone, or download the project first.)
In your target’s General tab, click the + button under Linked Frameworks and Libraries.
Select the appropriate SQLite.framework for your platform.
Add.
Some additional steps are required to install the application on an actual device:
In the General tab, click the + button under Embedded Binaries.
Select the appropriate SQLite.framework for your platform.
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.
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):