SQLite.swift README

The project's README from github.com/stephencelis/SQLite.swift. As one markdown file: README.md.

SQLite.swift

Build Status CocoaPods Version Swift5 compatible Platform Carthage compatible Join the chat at https://gitter.im/stephencelis/SQLite.swift

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

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

Features

Usage

import SQLite

// Wrap everything in a do...catch to handle errors
do {
    let db = try Connection("path/to/db.sqlite3")

    let users = Table("users")
    let id = SQLite.Expression<Int64>("id")
    let name = SQLite.Expression<String?>("name")
    let email = SQLite.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 <- "[email protected]")
    let rowid = try db.run(insert)
    // INSERT INTO "users" ("name", "email") VALUES ('Alice', '[email protected]')

    for user in try db.prepare(users) {
        print("id: \(user[id]), name: \(user[name]), email: \(user[email])")
        // id: 1, name: Optional("Alice"), email: [email protected]
    }
    // 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)

    try db.scalar(users.count) // 0
    // SELECT count(*) FROM "users"
} catch {
    print (error)
}

Note that Expression should be written as SQLite.Expression to avoid conflicts with the SwiftUI.Expression if you are using SwiftUI too.

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

// Wrap everything in a do...catch to handle errors
do {
    // ...

    let stmt = try db.prepare("INSERT INTO users (email) VALUES (?)")
    for email in ["[email protected]", "[email protected]"] {
        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("[email protected]")
        // id: Optional(3), email: Optional("[email protected]")
    }

    try db.scalar("SELECT count(*) FROM users") // 2
} catch {
    print (error)
}

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

SQLite.playground Screen Shot

Installation

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code.

  1. Add the following to your Package.swift file:
dependencies: [
    .package(url: "https://github.com/stephencelis/SQLite.swift.git", from: "0.16.0")
]
  1. Build your project:
$ swift build

See the Tests/SPM folder for a small demo project which uses SPM.

Carthage

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.16.0

  3. Run carthage update and add the appropriate framework.

CocoaPods

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

  1. Make sure CocoaPods is installed.

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

  2. Update your Podfile to include the following:

    use_frameworks!

target 'YourAppTargetName' do
    pod 'SQLite.swift', '~> 0.15.0'
end

  3. Run pod install --repo-update.

Manual

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.)

    Installation Screen Shot

  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:

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

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

  3. Add.

Communication

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

Original author

License

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

These projects enhance or use SQLite.swift:

Alternatives

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

SQLite.swift (stephencelis/SQLite.swift)

Searching Database…

10.2K ·GitHub
SQLite.swift
What is this?SQLite.swift is a type-safe, Swift-language layer over SQLite3 that lets you write and run SQL queries with compile-time checking instead of raw SQL strings.
Is this a full ORM or just a thin wrapper around the C API?It's a library, not a full ORM: it offers a chainable, lazy-executing query builder and typed data access, but it also works as a lightweight, Swift-friendly wrapper directly over SQLite's C API when you need it.
How do I add it to a project?Use the Swift Package Manager by adding it to your Package.swift and building, or install via Carthage/CocoaPods, or manually drag SQLite.xcodeproj into your Xcode project and link the framework.
Do I need Xcode or a specific Swift version?You need Xcode (or Swift Package Manager/Carthage/CocoaPods tooling) and Swift 5, since the project is marked Swift5 compatible.
Is Linux support complete?It runs on Linux, but the README explicitly notes there are some limitations compared to Apple platforms.
Does it only work on Apple platforms?It's primarily built for Apple platforms (iOS/macOS, installable via CocoaPods/Carthage/Xcode) but also works on Linux with some caveats.
Does it support full-text search?Yes, it has built-in Full-text search support as one of its documented features.
Can it work with encrypted databases?Yes, it supports SQLCipher via Swift Package Manager for encrypted SQLite databases.
Does it handle database schema migrations?Yes, it provides schema query/migration support, and there's a companion project, SQLiteMigrationManager.swift, built specifically for migrations.
What are the alternatives if this doesn't fit my needs?The README points to other Swift SQLite wrappers like GRDB, SQLiteDB, and FMDB as alternatives.
What are similar projects?wcdb, SwiftyJSON, fmdb, Alamofire, AFNetworking, IQKeyboardManager, turso, Spring
Which topics is it in?sqlite3, cocoapods, full-text-search, orm, xcode, apple, encryption, swift, sqlite, sdk, database, ios
Creator
stephencelis
Size
4.1 MB
Stars
10.2K
Updated
CommitSep 22Release0.16.0Mar 08
Age
12y
Commits · 90 Days