SQLight

SQLight is a simple Swift layer over SQLite3.

Working with SQLite3 in Swift is usually a headache due to the data types used in C.

SQLight handles all the headaches for you so that you can peacefully use it with Swift.

How is it different from other swift implementations?

hmmm...

Most of the famous GitHub projects on sqlite3-swift are too complex to begin for swift beginners.

And also it takes time to learn the workings of the framework which I think it is a @#$@ing waste of time.

..

....

......

and its fun to create when you are capable!

Usage

Steps to follow:

1. Open database connection.
2. Prepare a statement using SQL query.
3. Do operations on prepared statement.
4. Destroy the prepared statement.
5. Close the database connection.

Code:

do{varrowsChanged:Int
/**************************************/
// Open a connection to database
letdb=trySQLight(type:.file("test.db"))
/**************************************/
/**************************************/
// create a table
letcreateQuery="create table testing(num int, name varchar);"letcreatePS=tryPreparedStatement(SQLQuery: createQuery, SQLightDB: db)
// executes the query
rowsChanged =try createPS.modify()
// always destroy the query after its use
try createPS.destroy()
/**************************************/
/**************************************/
// insert values using already constructed string
letinsertQuery="insert into testing values(12,'anything');"letinsertPS=tryPreparedStatement(SQLQuery: insertQuery, SQLightDB: db)
// executes the query
rowsChanged =try insertPS.modify()
// always destroy the query after its use
try insertPS.destroy()
/**************************************/
/**************************************/
// Preparing statement is costly, so preparing every insert statement is not recommened and prone to sql injections
// For performance and security, parameter binding is recommened.
letbindQuery="insert into testing values(@num, @name);"letbindPS=tryPreparedStatement(SQLQuery: bindQuery, SQLightDB: db)
// Binding can be done in 3 ways
foriin0...5 // -> 1st
{try bindPS.bindValues([i,"jon"]) // takes [Any]. Binds values from left to right
rowsChanged =try bindPS.modify() // execute
bindPS.resetBindValues() // removes the binded values for next use
}foriin0...5 // -> 2nd
{try bindPS.bindValues([1:i,2:"john"]) // takes [Int:Any]. key -> parameter index, value -> value to bind
rowsChanged =try bindPS.modify() // execute
bindPS.resetBindValues() // removes the binded values for next use
}foriin0...5 // -> 3rd
{try bindPS.bindValues(["@num":i,"@name":"nothing"]) // takes [String:Any]. key -> parameter name, value -> value to bind
rowsChanged =try bindPS.modify() // execute
bindPS.resetBindValues() // removes the binded values for next use
}
// You can get the number of bind parameters
print("Number of bind parameters: ",bindPS.getParameterCount())
// You can get the name of the parameters by passing index
print("Parameter name of index 1: ",bindPS.getParameterName(parameterIndex:1)!)print("Parameter name of index 2: ",bindPS.getParameterName(parameterIndex:2)!)
// You can get the index of a parameter by passing its name
print("Parameter index of name \"@num:\"",bindPS.getParameterIndex(parameterName:"@num"))print("Parameter index of name \"@name:\"",bindPS.getParameterIndex(parameterName:"@name"))
// always destroy the query after its use
try bindPS.destroy()
/**************************************/
/**************************************/
letselectQuery="select *from testing;"letselectPS=tryPreparedStatement(SQLQuery: selectQuery, SQLightDB: db)
// If the data is small enough to store in RAM
letresult=try selectPS.fetchAllRows() // returns [[Any]]
foriin result
{forjin i
{print(j, terminator:"")}print("")}
// If the data is large, retrieve 1 row at a time
whiletrue{iflet row =try selectPS.fetchNextRow() // returns [Any]?
{print(row)}else{break}}
// Or use a callback. The closure is called for every row. But parameter bindings is not supported
try selectPS.execute(callbackForSelectQuery:{
void, columnCount, values, columns inforiin0..<Int(columnCount){guardlet value =values?[i]else{continue}guardlet column =columns?[i]else{continue}letstrCol=String(cString:column) // column name as string
letstrVal=String(cString:value) // value as string
print(strVal, terminator:"")}print("")return0})
// Get columns used in select query
iflet columnNames = selectPS.getColumnNames() // returns [String]?
{print("Column Names: ", columnNames)}
// always destroy the query after its use
try selectPS.destroy()
/**************************************/
/**************************************/
// If you want to execute multiple queries where parameter binding is not required.
// Multiple queries as String
letcustomQuery="create table test(num int);insert into test values(10);insert into test values(11);insert into test values(12);insert into test values(12);"letcustomPS=tryPreparedStatement(SQLQuery: customQuery, SQLightDB: db)
// The callback is only required if there is any select query
try customPS.execute(callbackForSelectQuery:nil)
// always destroy the query after its use
try customPS.destroy()
/**************************************/
/**************************************/
// close the database connection
try db.close()
/**************************************/
}catchlet error as DBError{print("Error message: ",error.message,"\nError code: ",error.errorCode)}

Note: Currently it doesn't support blob data type.

Installation

For macOS:

1. Including Source files.
2. Including Framework.

Including Source Files:

1. Copy SQLight.swift, PreparedStatement.swift, CustomTypes.swift to your project.
2. Create a Bridging Header and add line #include<sqlite3.h> in it.
3. Add libsqlite3.tbd framework to your project under Linked Frameworks and Libraries.

Including Framework:

1. Open the SQLight Xcode project and build the project for framework.
2. Add the framework to your project.

For iOS:

Including Source Files: (same as macOS)

1. Copy SQLight.swift, PreparedStatement.swift, CustomTypes.swift to your project.
2. Create a Bridging Header and add line #include<sqlite3.h> in it.
3. Add libsqlite3.tbd framework to your project under Linked Frameworks and Libraries.

Contributing

Feel free to fork the project and submit a pull request with your changes!

Not experienced or lazy to fork and submit a pull request ?

Open an issue for adding new features, enhancement, bugs etc.

License

MIT

Free Software, Hell Yeah!