SQLiteKit 0.0.16

SQLiteKit 0.0.16

×

Maintained by alexiscn.

SQLiteKit 0.0.16

  • By
  • xushuifeng

SQLiteKit

a Swift version of SQLite library inspired by SQLite-net using Codable and Mirror technology.

Features

  • Manual or ORM
  • Auto table migration

In-Progress

  • Auto increase primary key value is not set when insert into table
  • Transcation
  • Create Index on table
  • Custom Attributes on table
  • ...

Requirements

  • iOS 10.0+
  • Xcode 9.0+
  • Swift 4.0+

Installation

SQLiteKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'SQLiteKit'

Documentation

Example

class User: SQLiteTable {
    var userID: Int
    var name: String
    var age: Int
    var avatarData: Data?
     
    required init() {
        self.name = ""
        self.age = 0
        self.avatarData = nil
    }
     
    // MARK: - SQLiteTable
     
    static func sqliteAttributes: [SQLiteAttribute] {
         return []
    }
}

func SQLitKitDemo() {
    // 1. Create your database file
    let dbPath = NSHomeDirectory().appending("db.sqlite")
    let db = SQLiteConnection(databasePath: dbPath)
    db.create(User.self)
    let user = User(name: "alexiscn", age: 20, avatarData: nil)
    db.insert(user)
}

Supported-Type

SQLiteTable support following native Swift Types.

Swift Type SQLite Type
Int INTEGER
Float REAL
Double REAL
String TEXT
Date REAL
nil NULL
Data BLOB
Optional<T> T

T should be one of Int, Float, Double, String, Date or Data。

Query

You can use API defined in SQLiteConnection to query.

public func query<T>(_ query: String, parameters: [Any] = []) -> [T]
public func find<T>(_ pk: Any) -> T?

Or you can create a queryable object of your table.

let queryTable: SQLiteTableQuery<T> = db.table()

SQLiteTableQuery have following APIs:

public var count: Int { get }
public func toList() -> [T]
public func filter<T: SQLiteTable>(using predicate: NSPredicate) -> [T]
public func orderBy() -> SQLiteTableQuery<T>

Insert

Insert into table is pretty easy.

public func insert(_ obj: SQLiteTable?) -> Int
public func insertOrReplace(_ obj: SQLiteTable?) -> Int
public func insertAll(_ objects: [SQLiteTable], inTranscation: Bool = false) -> Int

Update

public func update(_ obj: SQLiteTable) -> Int

Delete

public func delete(_ obj: SQLiteTable) -> Int
public func deleteAll<T: SQLiteTable>(_ type: T.Type) -> Int
public func delete(using predicate: NSPredicate, on table: SQLiteCodable.Type) -> Int

Author

alexiscn

License

SQLiteKit is released under the MIT license. See LICENSE for details.