SQLRowDecoder

struct SQLRowDecoder

Overview

This type essentially acts as a bridge between Codable structure types and the per-column decoding methods provided by SQLRow. It is, somewhat confusingly, designed primarily for use via SQLQueryFetcher’s all(decoding:) and first(decoding:) methods, or somewhat more directly via decode(model:prefix:keyDecodingStrategy:userInfo:) and decode(model:with:), but it can also be manually invoked. For example:

struct MySimpleUserModel: Codable {
    var id: Int
    var username: String
    var passwordHash: [UInt8]
    var email: String?
    var createdAt: Date
}

let query = sqlDatabase.select()
    .columns("id", "username", "password_hash", "email", "created_at")
    .from("my_simple_users")

// Direct usage:
let rows = try await query.all()
let decoder = SQLRowDecoder(keyDecodingStrategy: .convertFromSnakeCase)
let userModels = try rows.map { row in
    try decoder.decode(MySimpleUserModel.self, from: row)
}

// Invoked via SQLRow:
let userModels = try rows.map { row in
    try row.decode(MySimpleUserModel.self, keyDecodingStrategy: .convertFromSnakeCase)
}

// Invoked via SQLQueryFetcher:
let userModels = try await query.all(
    decoding: MySimpleUserModel.self,
    keyDecodingStrategy: .convertFromSnakeCase
)