Oyvindkg/tinysqlite

A lightweight wrapper for SQLite written in Swift

[](https://travis-ci.org/Øyvind Grimnes/TinySQLite)

![alt text] (http://i.imgur.com/KvtukKk.png "Logo")

A lightweight SQLite wrapper written in Swift

###Features

• Lightweight
• Object oriented
• Automatic parameter binding
• Named parameter binding
• Thread safe
• Supports all native Swift types

Usage

Creating the database object

Provide the DatabaseQueue with a file URL. If the database file exists, the existing database file will be used. If not, a new database will be created automatically.

let location = URL(fileURLWithPath: "path/to/database.sqlite")

let databaseQueue = DatabaseQueue(location: location)

Creating queries

All valid SQLite queries are accepted by TinySQLite

To use automatic binding, replace the values in the statement by '?', and provide the values in an array

let query = "INSERT INTO YourTable (column, otherColumn) VALUES (?, ?)"

let parameters = [1, "A value"]

To use automatic named binding, replace the values in the statement by ':<name>', and provide the values in a dictionary

let query = "INSERT INTO YourTable (column, otherColumn) VALUES (:column, :otherColumn)"

let parameterMapping = [
    "column": 1, 
    "otherColumn": "A value"
]

Executing updates

Execute an update in the database

try databaseQueue.database { (database) in
    let statement = try database.statement(for: query)
    
    statement.executeUpdate()
    statement.executeUpdate(withParameters: parameters)
    statement.executeUpdate(withParameterMapping: parameterMapping)
    
    statement.finalize()
}

Executing queries

Execute a query to the database.

try databaseQueue.database { (database) in
    let statement = try database.statement(for:query)
    
    try statement.execute()
    
    for row in statement {
    
        /* Get an integer from the second column in the row */
        row.integerForColumn(at: 2)
        
        /* Get a date from the column called 'deadline' */
        row.dateForColumn("deadline") 
        
        /* Get a dictionary representing the row */
        row.dictionary 
    }
    
    statement.finalize()
}

Transactions

To improve performance, and prevent partial updates when executing multiple queries, you can use DatabaseQueue's transaction method. If an error is thrown in the block, all changes are rolled back.

try databaseQueue.transaction { (database) in
    try database.statement(for: query)
                .executeUpdate(withParameters: someParameters)
                .executeUpdate(withParameters: someOtherParameters)
                .executeUpdate(withParameters: evenMoreParameters)
                .finalize()
}

Installation

Cocoapods

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

pod "TinySQLite", "0.4.4"

Carthage

TinySQLite is available through Carthage. To install, simply add the following line to your Cartfile:

github "Oyvindkg/tinysqlite" "0.4.4"

Author

Øyvind Grimnes, oyvindkg@yahoo.com

License

TinySQLite is available under the MIT license. See the LICENSE file for more info.