Skip to content

Fluent PostgreSQL

Fluent PostgreSQL (vapor/fluent-postgresql) is a type-safe, fast, and easy-to-use ORM for PostgreSQL built on top of Fluent.

Seealso

The Fluent PostgreSQL package is built on top of Fluent and the pure Swift, NIO-based PostgreSQL core. You should refer to their guides for more information about subjects not covered here.

Getting Started

This section will show you how to add Fluent PostgreSQL to your project and create your first PostgreSQLModel.

Package

The first step to using Fluent PostgreSQL is adding it as a dependency to your project in your SPM package manifest file.

// swift-tools-version:4.0
import PackageDescription

let package = Package(
    name: "MyApp",
    dependencies: [
        /// Any other dependencies ...

        // 🖋🐘 Swift ORM (queries, models, relations, etc) built on PostgreSQL.
        .package(url: "https://github.com/vapor/fluent-postgresql.git", from: "1.0.0-rc"),
    ],
    targets: [
        .target(name: "App", dependencies: ["FluentPostgreSQL", ...]),
        .target(name: "Run", dependencies: ["App"]),
        .testTarget(name: "AppTests", dependencies: ["App"]),
    ]
)

Don't forget to add the module as a dependency in the targets array. Once you have added the dependency, regenerate your Xcode project with the following command:

vapor xcode

Model

Now let's create our first PostgreSQLModel. Models represent tables in your PostgreSQL database and they are the primary method of interacting with your data.

/// A simple user.
final class User: PostgreSQLModel {
    /// The unique identifier for this user.
    var id: Int?

    /// The user's full name.
    var name: String

    /// The user's current age in years.
    var age: Int

    /// Creates a new user.
    init(id: Int? = nil, name: String, age: Int) {
        self.id = id
        self.name = name
        self.age = age
    }
}

The example above shows a PostgreSQLModel for a simple model representing a user. You can make both structs and classes a model. You can even conform types that come from external modules. The only requirement is that these types conform to Codable, which must be declared on the base type for synthesized (automatic) conformance.

Standard practice with PostgreSQL databases is using an auto-generated INTEGER for creating and storing unique identifiers in the id column. It's also possible to use UUIDs or even Strings for your identifiers. There are convenience protocol for that.

protocol type key
PostgreSQLModel Int id
PostgreSQLUUIDModel UUID id
PostgreSQLStringModel String id

Seealso

Take a look at Fluent → Model for more information on creating models with custom ID types and keys.

Migration

All of your models (with some rare exceptions) should have a corresponding table—or schema—in your database. You can use a Fluent → Migration to automatically generate this schema in a testable, maintainable way. Fluent makes it easy to automatically generate a migration for your model

Tip

If you are creating models to represent an existing table or database, you can skip this step.

/// Allows `User` to be used as a migration.
extension User: Migration { }

That's all it takes. Fluent uses Codable to analyze your model and will attempt to create the best possible schema for it.

Take a look at Fluent → Migration if you are interested in customizing this migration.

Configure

The final step is to configure your database. At a minimum, this requires adding two things to your configure.swift file.

  • FluentPostgreSQLProvider
  • MigrationConfig

Let's take a look.

import FluentPostgreSQL

/// ...

/// Register providers first
try services.register(FluentPostgreSQLProvider())

/// Configure migrations
var migrations = MigrationConfig()
migrations.add(model: User.self, database: .psql)
services.register(migrations)

/// Other services....

Registering the provider will add all of the services required for Fluent PostgreSQL to work properly. It also includes a default database config struct that uses typical development environment credentials.

You can of course override this config struct if you have non-standard credentials.

/// Register custom PostgreSQL Config
let psqlConfig = PostgreSQLDatabaseConfig(hostname: "localhost", port: 5432, username: "vapor")
services.register(psqlConfig)

Once you have the MigrationConfig added, you should be able to run your application and see the following:

Migrating psql DB
Migrations complete
Server starting on http://localhost:8080

Query

Now that you have created a model and a corresponding schema in your database, let's make your first query.

router.get("users") { req in
    return User.query(on: req).all()
}

If you run your app, and query that route, you should see an empty array returned. Now you just need to add some users! Congratulations on getting your first Fluent PostgreSQL model and migration working.

Connection

With Fluent, you always have access to the underlying database driver. Using this underlying driver to perform a query is sometimes called a "raw query".

Let's take a look at a raw PostgreSQL query.

router.get("psql-version") { req -> Future<String> in
    return req.withPooledConnection(to: .psql) { conn in
        return try conn.query("select version() as v;").map(to: String.self) { rows in
            return try rows[0].firstValue(forColumn: "v")?.decode(String.self) ?? "n/a"
        }
    }
}

In the above example, withPooledConnection(to:) is used to create a connection to the database identified by .psql. This is the default database identifier. See Fluent → Database to learn more.

Once we have the PostgreSQLConnection, we can perform a query on it. You can learn more about the methods available in PostgreSQL → Core.