Framework

FluentKit

FluentKit is an ORM framework for Swift. It allows you to write type safe, database agnostic models and queries. It takes advantage of Swift’s type system to provide a powerful, yet easy to use API.

Overview

An example query looks like:

let planets = try await Planet.query(on: database)
    .filter(\.$type == .gasGiant)
    .sort(\.$name)
    .with(\.$star)
    .all()

For more information, see the Fluent documentation.

Topics

Classes

class AliasedField
Provides support for @dynamicMemberLookup to continue descending through arbitrary levels of nested projected properties values.
class BooleanProperty
A Fluent model property which represents a boolean (true/false) value.
class ChildrenProperty
class CompositeChildrenProperty
Declares a many-to-one relation between the referenced (“child”) model and the referencing (“parent”) model, where the parent model specifies its ID with CompositeIDProperty.
class CompositeIDProperty
class CompositeOptionalChildProperty
Declares an optional one-to-one relation between the referenced (“child”) model and the referencing (“parent”) model, where the parent model specifies its ID with CompositeIDProperty.
class CompositeOptionalParentProperty
Declares an optional one-to-many relation between the referenced (“parent”) model and the referencing (“child”) model, where the parent model specifies its ID with CompositeIDProperty.
class CompositeParentProperty
Declares a one-to-many relation between the referenced (“parent”) model and the referencing (“child”) model, where the parent model specifies its ID with CompositeIDProperty.
class Databases
class EnumBuilder
class EnumProperty
class FieldProperty
class GroupProperty
class GroupPropertyPath
class IDProperty
class MigrationLog
Stores information about Migrations that have been run.
class Migrations
class OptionalBooleanProperty
A Fluent model property which represents an optional boolean (true/false) value.
class OptionalChildProperty
class OptionalEnumProperty
class OptionalFieldProperty
class OptionalParentProperty
class ParentProperty
class QueryBuilder
class QueryHistory
Holds the history of queries for a database.
class SchemaBuilder
class SiblingsProperty
class TimestampProperty

Protocols

protocol AnyAsyncModelResponder
protocol AnyCodableProperty
Marks a property as participating in the Fields protocol’s (defaulted) implementation of Decodable and Encodable. This allows the property to encode and decode to and from representations other than storage in a database, and to act as a container if it contains any additional properties which also wish to participate. Just about every property type is codable.
protocol AnyDatabaseProperty
Marks a property as having “database” capability - in other words, the property receives output from the results of read queries, provides input to write queries, and/or represents one or more model fields.
protocol AnyEagerLoader
protocol AnyModel
protocol AnyModelMiddleware
protocol AnyModelResponder
protocol AnyOptionalType
protocol AnyProperty
The type-erased form of Property (see below). AnyProperty is used to access a model’s set of Fluent properties in a fully generic fashion (with a little help from runtime reflection). It is generally not meaningful to conform to this protocol without also at least conforming to Property.
protocol AnyQueryAddressableProperty
The type-erased form of QueryAddressableProperty (see below). Both protocols serve to bridge the gap between AnyQueryableProperty - which describes a property whose singular Value directly corresponds to the value stored in the database for that property - and property types whose Value is a derivative of or expansion upon an underlying queryable property. See the discussion of QueryAddressableProperty itself for additional details.
protocol AnyQueryableProperty
The type-erased form of QueryableProperty (see below). AnyQueryableProperty is used most often as a type-generic check for whether or not a given property represents an actual database field.
protocol AsyncMigration
protocol AsyncModelMiddleware
protocol BooleanPropertyFormat
A conversion between Bool and an arbitrary alternative storage format, usually a string.
protocol Database
protocol DatabaseConfiguration
protocol DatabaseDriver
protocol DatabaseError
protocol DatabaseInput
A helper type for working with properties which conform to the AnyDatabaseProperty protocol.
protocol DatabaseOutput
protocol EagerLoadBuilder
protocol EagerLoadable
protocol EagerLoader
protocol Fields
A type conforming to Fields is able to use FluentKit’s various property wrappers to declare name, type, and semantic information for individual properties corresponding to fields in a generic database storage system.
protocol Migration
Fluent’s Migration can handle database migrations, which can include adding new table, changing existing tables or adding seed data. These actions are executed only once.
protocol Model
protocol ModelAlias
Describes a model whose schema has an alias.
protocol ModelMiddleware
protocol OptionalType
protocol Property
A property wrapper type conforms to this protocol to participate in Fluent’s system for interfacing between the various properties of a model and the representations of those properties in a database. All properties whose wrappers conform to this protocol appear in Fluent’s list of the data items which exist on a given model - whether those items contain actual data, such as a property representing a field in a database table, or are means to access other data, such a list of associated models on the far side of a many-to-many relation.
protocol QueryAddressableProperty
Marks a property as being “query addressable”, meaning that it is either itself queryable (QueryableProperty implies QueryAddressableProperty), or it represents some other single property that is queryable. This allows properties whose purpose is to wrap or otherwise stand in for other properties to be handled generically without the need to add special case exceptions for those property types.
protocol QueryableProperty
Marks a property as being “queryable”, meaning that it represents exactly one “real” database field (i.e. the database table will contain a “physical” field corresponding to the property, and it will be the only field that does so).
protocol RandomGeneratable
protocol Relation
A protocol which designates a conforming type as representing a database relation of any kind. Intended for use only by FluentKit property wrappers.
protocol Schema
protocol TimestampFormat
protocol TransactionControlDatabase
Protocol for describing a database that allows fine-grained control over transcactions when you need more control than provided by Database/transaction(_:)-1x3ds

Structures

struct BooleanPropertyFormatFactory
This is a workaround for Swift 5.4’s inability to correctly infer the format type using the Self constraints on the various static properties.
struct ComplexJoinFilter
This wrapper type allows the compiler to better constrain the overload set for global operators, reducing compile times and avoiding “this expression is too complex…” errors.
struct ComplexJoinFilterGroup
This wrapper type allows the compiler to better constrain the overload set for global operators, reducing compile times and avoiding “this expression is too complex…” errors.
struct DatabaseConfigurationFactory
struct DatabaseContext
struct DatabaseEnum
struct DatabaseID
struct DatabaseQuery
struct DatabaseSchema
struct DefaultBooleanPropertyFormat
Represent a Bool natively, using the database’s underlying support (if any). This is the default.
struct DefaultTimestampFormat
struct ISO8601TimestampFormat
struct IntegerBooleanPropertyFormat
Represent a Bool as any integer type. Any value other than 0 or 1 is considered invalid.
struct JoinFilter
struct Migrator
struct ModelCompositeIDFilter
struct ModelFieldFilter
struct ModelValueFilter
struct NestedEagerLoadBuilder
struct OnOffBooleanPropertyFormat
Represent a Bool as the strings “OFF” and “ON”. Parsing is case-insensitive. Serialization always stores uppercase.
struct OneZeroBooleanPropertyFormat
Represent a Bool as the strings “0” and “1”. Any other value is considered invalid.
struct Page
A single section of a larger, traversable result set.
struct PageMetadata
Metadata for a given Page.
struct PageRequest
Represents information needed to generate a Page from the full result set.
struct TimestampFormatFactory
struct TrueFalseBooleanPropertyFormat
Represent a Bool as the strings “false” and “true”. Parsing is case-insensitive. Serialization always stores lowercase.
struct UnixTimestampFormat
struct YNBooleanPropertyFormat
Represent a Bool as the strings “N” and “Y”. Parsing is case-insensitive. Serialization always stores uppercase.
struct YesNoBooleanPropertyFormat
Represent a Bool as the strings “NO” and “YES”. Parsing is case-insensitive. Serialization always stores uppercase.

Operators

func !=(_:_:)
func !=~(_:_:)
func !~(_:_:)
func !~=(_:_:)
func &&(_:_:)
a ==/!= b && c ==/!= d
func ==(_:_:)
func =~(_:_:)
func <(_:_:)
func >(_:_:)
func >=(_:_:)
func <=(_:_:)
func ~=(_:_:)
func ~~(_:_:)

Enumerations

enum CompositeRelationParentKey
A helper type used by CompositeChildrenProperty and CompositeOptionalChildProperty to generically track the keypath of the property of the child model that defines the parent-child relationship.
enum FieldKey
enum FluentError
enum KeyPrefixingStrategy
A strategy describing how to apply a prefix to a FieldKey.
enum MiddlewareFailureHandler
enum ModelEvent
enum RelationParentKey
A helper type used by ChildrenProperty and OptionalChildProperty to generically track the keypath of the property of the child model that defines the parent-child relationship.
enum SiblingsPropertyError
An error describing a failure during an an operation on an SiblingsProperty.
enum TimestampTrigger