Skip to content

Vapor API Docs

FluentKit

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Classes
AliasedField
BooleanProperty
ChildrenProperty
CompositeChildrenProperty
CompositeIDProperty
CompositeOptionalChildProperty
CompositeOptionalParentProperty
CompositeParentProperty
Databases
EnumBuilder
- Instance Properties
- var `enum`: DatabaseEnum
- Instance Methods
- func `case`(String) -> Self
- func create()
- func delete()
- func deleteCase(String) -> Self
- func generateDatatype() async throws -> DatabaseSchema.DataType
- func read()
- func update()
EnumProperty
FieldProperty
GroupProperty
GroupPropertyPath
IDProperty
MigrationLog
- Initializers
- init()
- init(id: UUID?, name: String, batch: Int)
- Instance Properties
- var batch: Int
- var createdAt: Date?
- var id: UUID?
- var name: String
- var updatedAt: Date?
- Type Properties
- static var migration: any Migration
- static let schema: String
Migrations
- Initializers
- init()
- Instance Methods
- func add(_:to:)
OptionalBooleanProperty
OptionalChildProperty
OptionalEnumProperty
OptionalFieldProperty
OptionalParentProperty
ParentProperty
QueryBuilder
QueryHistory
- Initializers
- init()
- Instance Properties
- var queries: [DatabaseQuery]
SchemaBuilder
SiblingsProperty
TimestampProperty
Protocols
AnyAsyncModelResponder
AnyCodableProperty
AnyDatabaseProperty
- Instance Properties
- var keys: [FieldKey]
- Instance Methods
- func input(to: any DatabaseInput)
- func output(from: any DatabaseOutput) throws
AnyEagerLoader
- Instance Methods
- func anyRun(models: [any AnyModel], on: any Database) -> EventLoopFuture<Void>
AnyModel
- Instance Methods
- func joined<Joined>(Joined.Type) throws -> Joined
- Default Implementations
- CustomStringConvertible Implementations
  - Instance Properties
  - var description: String
AnyModelMiddleware
- Instance Methods
- func handle(ModelEvent, any AnyModel, on: any Database, chainingTo: any AnyModelResponder) -> EventLoopFuture<Void>
  - AnyModelMiddleware Implementations
    - func handle(ModelEvent, any AnyModel, on: any Database, chainingTo: any AnyModelResponder) -> EventLoopFuture<Void>
    - func handle(ModelEvent, any AnyModel, on: any Database, chainingTo: any AnyModelResponder) -> EventLoopFuture<Void>
AnyModelResponder
AnyOptionalType
AnyProperty
AnyQueryAddressableProperty
- Instance Properties
- var anyQueryableProperty: any AnyQueryableProperty
- var queryablePath: [FieldKey]
AnyQueryableProperty
AsyncMigration
AsyncModelMiddleware
BooleanPropertyFormat
- Associated Types
- Value
- Initializers
- init()
- Instance Methods
- func parse(Self.Value) -> Bool?
- func serialize(Bool) -> Self.Value
- Type Properties
- static var `default`: DefaultBooleanPropertyFormat
- static var integer: IntegerBooleanPropertyFormat<Int>
- static var onOff: OnOffBooleanPropertyFormat
- static var oneZero: OneZeroBooleanPropertyFormat
- static var trueFalse: TrueFalseBooleanPropertyFormat
- static var yesNo: YesNoBooleanPropertyFormat
- static var yn: YNBooleanPropertyFormat
Database
DatabaseConfiguration
- Instance Properties
- var middleware: [any AnyModelMiddleware]
- Instance Methods
- func makeDriver(for: Databases) -> any DatabaseDriver
DatabaseDriver
DatabaseError
- Instance Properties
- var isConnectionClosed: Bool
- var isConstraintFailure: Bool
- var isSyntaxError: Bool
DatabaseInput
DatabaseOutput
EagerLoadBuilder
EagerLoadable
EagerLoader
- Associated Types
- Model
- Instance Methods
- func run(models: [Self.Model], on: any Database) -> EventLoopFuture<Void>
Fields
Migration
Model
- Associated Types
- IDValue
- Instance Properties
- var id: Self.IDValue?
- Instance Methods
- func create(on:)
- func delete(force:on:)
- func handle(ModelEvent, on: any Database) async throws
- func requireID() throws -> Self.IDValue
- func restore(on:)
- func save(on:)
- func update(on:)
- Type Aliases
- Model.Children
- Model.CompositeChildren
- Model.CompositeID
- Model.CompositeOptionalChild
- Model.CompositeOptionalParent
- Model.CompositeParent
- Model.ID
- Model.OptionalChild
- Model.OptionalParent
- Model.Parent
- Model.Siblings
- Model.Timestamp
- Type Methods
- static find(_:on:)
- static func query(on: any Database) -> QueryBuilder<Self>
ModelAlias
ModelMiddleware
OptionalType
- Associated Types
- Wrapped
- Initializers
- init(Self.Wrapped)
Property
- Associated Types
- Model
- Value
- Instance Properties
- var value: Self.Value?
QueryAddressableProperty
- Associated Types
- QueryablePropertyType
- Instance Properties
- var queryableProperty: Self.QueryablePropertyType
QueryableProperty
- Type Methods
- static func queryValue(Self.Value) -> DatabaseQuery.Value
  - QueryableProperty Implementations
    - static func queryValue(Self.Value) -> DatabaseQuery.Value
RandomGeneratable
- Type Methods
- static func generateRandom() -> Self
Relation
- Associated Types
- RelatedValue
- Instance Properties
- var name: String
- var value: Self.RelatedValue?
- Instance Methods
- func get(reload:on:)
- func load(on: any Database) -> EventLoopFuture<Void>
Schema
TimestampFormat
- Associated Types
- Value
- Instance Methods
- func parse(Self.Value) -> Date?
- func serialize(Date) -> Self.Value?
TransactionControlDatabase
Structures
BooleanPropertyFormatFactory
ComplexJoinFilter
ComplexJoinFilterGroup
DatabaseConfigurationFactory
- Initializers
- init(make: () -> any DatabaseConfiguration)
- Instance Properties
- let make: () -> any DatabaseConfiguration
DatabaseContext
DatabaseEnum
DatabaseID
- Initializers
- init(from: any Decoder) throws
- init(string: String)
- Instance Properties
- let string: String
DatabaseQuery
DatabaseSchema
DefaultBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(Bool) -> Bool?
- func serialize(Bool) -> Bool
DefaultTimestampFormat
- Instance Methods
- func parse(Date) -> Date?
- func serialize(Date) -> Date?
- Type Aliases
- DefaultTimestampFormat.Value
ISO8601TimestampFormat
- Instance Methods
- func parse(String) -> Date?
- func serialize(Date) -> String?
- Type Aliases
- ISO8601TimestampFormat.Value
IntegerBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(T) -> Bool?
- func serialize(Bool) -> T
JoinFilter
Migrator
ModelCompositeIDFilter
- Initializers
- init(DatabaseQuery.Filter.Method, Model.IDValue)
ModelFieldFilter
- Initializers
- init<LeftField, RightField>(KeyPath<Left, LeftField>, DatabaseQuery.Filter.Method, KeyPath<Right, RightField>)
ModelValueFilter
- Initializers
- init<Field>(KeyPath<Model, Field>, DatabaseQuery.Filter.Method, DatabaseQuery.Value)
NestedEagerLoadBuilder
- Instance Methods
- func add<Loader>(loader: Loader)
- Type Aliases
- NestedEagerLoadBuilder.Model
OnOffBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(String) -> Bool?
- func serialize(Bool) -> String
OneZeroBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(String) -> Bool?
- func serialize(Bool) -> String
Page
- Initializers
- init(items: [T], metadata: PageMetadata)
- Instance Properties
- let items: [T]
- let metadata: PageMetadata
- Instance Methods
- func map<U>((T) throws -> U) rethrows -> Page<U>
- Default Implementations
- Decodable Implementations
  - Initializers
  - init(from: any Decoder) throws
PageMetadata
- Initializers
- init(from: any Decoder) throws
- init(page: Int, per: Int, total: Int)
- Instance Properties
- let page: Int
- var pageCount: Int
- let per: Int
- let total: Int
PageRequest
- Initializers
- init(from: any Decoder) throws
- init(page: Int, per: Int)
- Instance Properties
- let page: Int
- let per: Int
TimestampFormatFactory
- Initializers
- init(() -> Format)
- Instance Properties
- let makeFormat: () -> Format
- Type Properties
- static var `default`: TimestampFormatFactory<DefaultTimestampFormat>
- static var iso8601: TimestampFormatFactory<ISO8601TimestampFormat>
- static var unix: TimestampFormatFactory<UnixTimestampFormat>
- Type Methods
- static func iso8601(withMilliseconds: Bool) -> TimestampFormatFactory<ISO8601TimestampFormat>
TrueFalseBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(String) -> Bool?
- func serialize(Bool) -> String
UnixTimestampFormat
- Instance Methods
- func parse(Double) -> Date?
- func serialize(Date) -> Double?
- Type Aliases
- UnixTimestampFormat.Value
YNBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(String) -> Bool?
- func serialize(Bool) -> String
YesNoBooleanPropertyFormat
- Initializers
- init()
- Instance Methods
- func parse(String) -> Bool?
- func serialize(Bool) -> String
Operators
func !=(_:_:)
func !=~(_:_:)
func !~(_:_:)
func !~=(_:_:)
func &&(_:_:)
func ==(_:_:)
func =~(_:_:)
func <(_:_:)
func >(_:_:)
func >=(_:_:)
func <=(_:_:)
func ~=(_:_:)
func ~~(_:_:)
Enumerations
CompositeRelationParentKey
FieldKey
FluentError
KeyPrefixingStrategy
- Enumeration Cases
- case camelCase
- case custom((FieldKey, FieldKey) -> FieldKey)
- case none
- case snakeCase
- Instance Properties
- var description: String
- Instance Methods
- func apply(prefix: FieldKey, to: FieldKey) -> FieldKey
MiddlewareFailureHandler
- Enumeration Cases
- case failOnFirst
- case insertSucceeded
ModelEvent
- Enumeration Cases
- case create
- case delete(Bool)
- case restore
- case softDelete
- case update
RelationParentKey
SiblingsPropertyError
- Enumeration Cases
- case operandModelIdRequired(property: String)
- case owningModelIdRequired(property: String)
- Instance Properties
- var debugDescription: String
- var description: String
- var errorDescription: String?
- var failureReason: String?
TimestampTrigger
- Enumeration Cases
- case create
- case delete
- case none
- case update
Extended Modules
Foundation
- Extended Structures
- UUID
  - Default Implementations
  - RandomGeneratable Implementations
    - Type Methods
    - static func generateRandom() -> UUID
SQLKit
- Extended Structures
- SomeCodingKey
  - Instance Properties
  - var description: String
Swift

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

Instance Property

schema

var schema: String

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

Twitter
Mastodon
Bsky
GitHub