Simple ActiveRecord implementation for working with your database in Swift.
- Easy setup
- Beautiful syntax
- Generically typed
Clone the Example project to start making your application. If you are also looking for a web server, check out Vapor. It was built to work well with Fluent.
You must have Swift 2.2 or later installed. You can learn more about Swift 2.2 at Swift.org
This is a work in progress, so don't rely on this for anything important. And pull requests are welcome!
Using Fluent is simple and expressive.
if let user = User.find(5) {
print("Found \(user.name)")
user.name = "New Name"
user.save()
}Underlying Fluent is a powerful Query builder.
let user = Query<User>().filter("id", notIn: [1, 2, 3]).filter("age", .GreaterThan, 21).firstStart by importing Fluent into your application.
import FluentPackage.swift
import PackageDescription
let package = Package(
name: "FluentApp",
dependencies: [
.Package(url: "https://github.com/qutheory/fluent.git", majorVersion: 0)
]
)Fluent currently supports SQLite. Support for MySQL, and MongoDB are in the works.
By default, the PrintDriver is enabled. This driver will simply print out the commands you make to Fluent. This is only useful for development of Fluent.
Start by ensuring SQLite3 is installed on your machine. If you are on a Mac, it will already be installed. For Linux, simply run sudo apt-get install libsqlite3-dev.
Once SQLite3 is installed, add the Fluent SQLiteDriver to your project.
Package.swift
.Package(url: "https://github.com/tannernelson/fluent-sqlite-driver.git", majorVersion: 0)Then import the driver and set it as your default database driver.
import SQLiteDriver
Database.driver = SQLiteDriver()You are now ready to use SQLite. The database file will be stored in Database/main.sqlite.
Make your application models conform to the Model protocol to allow them to work with Fluent.
public protocol Model {
///The entities database identifier. `nil` when not saved yet.
var id: String? { get }
///The database table in which entities are stored.
static var table: String { get }
/**
This method will be called when the entity is saved.
The keys of the dictionary are the column names
in the database.
*/
func serialize() -> [String: String]
init(serialized: [String: String])
}When your application models conform to the Model protocol, they gain access to the following helper functions.
extension Model {
public func save()
public func delete()
public static func find(id: Int) -> Self?
}Create an instance of the query builder by passing one of your application models that conforms to the Model protocol.
let query = Query<User>()You can filter by equivalence relations, as well is in/not in relations.
query.filter("age", .GreaterThan, 21)public enum Comparison {
case Equals, NotEquals, GreaterThanOrEquals, LessThanOrEquals, GreaterThan, LessThan
}query.filter("id", in: [1, 2, 3])public enum Comparison {
case In, NotIn
}Call .results for all of the results from the query, or .first for only the first result.
Call .delete to delete all rows affected by the query.
Call .save(model: T), passing in an instance of the class used to instantiate the Query to save it. This performs the same function as calling .save() on the model itself.
Fluent has been successfully tested on Ubuntu 14.04 LTS (DigitalOcean) and Ubuntu 15.10 (VirtualBox).
To deploy to DigitalOcean, simply
- Install Swift 2.2
wgetthe .tar.gz from Apple- Set the
export PATHin your~/.bashrc - (you may need to install
binutilsas well if you seear not found)
- Clone your fork of the
fluent-examplerepository to the server cdinto the repository- Run
swift build - Run
.build/debug/MyApp
- Run
My website http://tanner.xyz is currently running using Vapor and Fluent.