Introduction

​

What is GRDB?

​

Key Features

• Record Protocols: Define your models with FetchableRecord and PersistableRecord for automatic persistence
• Query Interface: Build type-safe queries with Swift’s expressive syntax
• Full-Text Search: Leverage SQLite’s FTS3, FTS4, and FTS5 engines for powerful text search
• Swift Concurrency: First-class support for async/await and structured concurrency
• Combine Support: Reactive database access with Combine publishers
• Type-Safe SQL: Use SQL interpolation to prevent injection vulnerabilities
• Associations: Define relationships between records with belongs-to, has-many, and has-one associations
• Database Encryption: Secure your data with SQLCipher integration

​

Why Choose GRDB?

​

Quick Example

import GRDB

// Open a connection
let dbQueue = try DatabaseQueue(path: "/path/to/database.sqlite")

// Define your model
struct Player: Codable, FetchableRecord, PersistableRecord {
    var id: Int64
    var name: String
    var score: Int
}

// Create the table
try dbQueue.write { db in
    try db.create(table: "player") { t in
        t.autoIncrementedPrimaryKey("id")
        t.column("name", .text).notNull()
        t.column("score", .integer).notNull()
    }
}

// Insert records
try dbQueue.write { db in
    var player = Player(id: 0, name: "Arthur", score: 100)
    try player.insert(db)
}

// Query with the Swift interface
let topPlayers = try dbQueue.read { db in
    try Player
        .order(Column("score").desc)
        .limit(10)
        .fetchAll(db)
}

​

Platform Support

• iOS 13.0+
• macOS 10.15+
• tvOS 13.0+
• watchOS 7.0+
• Linux (community supported)

​

Next Steps