Skip to content

SQLKit

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

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

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Basic Usage
Fundamentals
SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLSerializer
- Initializers
- init(database: any SQLDatabase)
- Instance Properties
- var binds: [any Encodable & Sendable]
- let database: any SQLDatabase
- var dialect: any SQLDialect
- var sql: String
- Instance Methods
- func statement((inout SQLStatement) -> ())
- func write(String)
- func write(bind: any Encodable & Sendable)
SQLStatement
- Instance Properties
- var dialect: any SQLDialect
- var logger: Logger
- var parts: [any SQLExpression]
- Instance Methods
- func append(_:)
- func append(_:_:)
- func append(_:_:_:)
- func serialize(to: inout SQLSerializer)
Data Access
SQLDatabase
SQLRow
SQLRowDecoder
SQLQueryEncoder
Drivers
SQLDialect
SQLDatabaseReportedVersion
SQLAlterTableSyntax
SQLTriggerSyntax
SQLUnionFeatures
- Initializers
- init(rawValue: Int)
- Instance Properties
- var rawValue: Int
- Type Properties
- static var except: SQLUnionFeatures
- static var exceptAll: SQLUnionFeatures
- static var explicitDistinct: SQLUnionFeatures
- static var intersect: SQLUnionFeatures
- static var intersectAll: SQLUnionFeatures
- static var parenthesizedSubqueries: SQLUnionFeatures
- static var union: SQLUnionFeatures
- static var unionAll: SQLUnionFeatures
SQLEnumSyntax
- Enumeration Cases
- case inline
- case typeName
- case unsupported
SQLUpsertSyntax
- Enumeration Cases
- case mysqlLike
- case standard
- case unsupported
Builder Protocols
SQLAliasedColumnListBuilder
- Instance Methods
- func column(_:as:)
- func column(table: String, column: String) -> Self
SQLColumnUpdateBuilder
SQLJoinBuilder
SQLPartialResultBuilder
SQLPredicateBuilder
SQLQueryBuilder
SQLQueryFetcher
SQLReturningBuilder
- Instance Properties
- var returning: SQLReturning?
- Instance Methods
- func returning(_:)
SQLSecondaryPredicateBuilder
SQLSubqueryClauseBuilder
- Instance Properties
- var select: SQLSelect
- Instance Methods
- func distinct() -> Self
- func distinct(on: [any SQLExpression]) -> Self
- func distinct(on:_:)
- func `for`(SQLLockingClause) -> Self
- func from(_:)
- func from(_:as:)
- func groupBy(_:)
- func lockingClause(any SQLExpression) -> Self
SQLUnqualifiedColumnListBuilder
Query Builders
SQLAlterEnumBuilder
- Instance Properties
- var alterEnum: SQLAlterEnum
- var database: any SQLDatabase
- var query: any SQLExpression
- Instance Methods
- func add(value:)
SQLAlterTableBuilder
- Initializers
- init(SQLAlterTable, on: any SQLDatabase)
- Instance Properties
- var alterTable: SQLAlterTable
- var columns: [any SQLExpression]
- var database: any SQLDatabase
- var query: any SQLExpression
- Instance Methods
- func addColumn(any SQLExpression) -> Self
- func column(_:type:_:)
- func dropColumn(_:)
- func modifyColumn(any SQLExpression) -> Self
- func modifyColumn(_:type:_:)
- func rename(to:)
- func update(column:type:)
SQLConflictUpdateBuilder
SQLCreateEnumBuilder
- Instance Properties
- var createEnum: SQLCreateEnum
- var database: any SQLDatabase
- var query: any SQLExpression
- Instance Methods
- func value(_:)
SQLCreateIndexBuilder
- Initializers
- init(SQLCreateIndex, on: any SQLDatabase)
- Instance Properties
- var createIndex: SQLCreateIndex
- var database: any SQLDatabase
- var query: any SQLExpression
- Instance Methods
- func column(_:)
- func on(_:)
- func unique() -> Self
SQLCreateTableBuilder
SQLCreateTriggerBuilder
- Instance Properties
- var createTrigger: SQLCreateTrigger
- var database: any SQLDatabase
- var query: any SQLExpression
- Instance Methods
- func body(_:)
- func columns(_:)
- func condition(_:)
- func each(_:)
- func isConstraint() -> Self
- func order(precedence:otherTriggerName:)
- func procedure(_:)
- func referencedTable(_:)
- func timing(_:)
SQLDeleteBuilder
- Initializers
- init(SQLDelete, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var delete: SQLDelete
- var predicate: (any SQLExpression)?
- var query: any SQLExpression
- var returning: SQLReturning?
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
SQLDropEnumBuilder
- Instance Properties
- var database: any SQLDatabase
- var dropEnum: SQLDropEnum
- var query: any SQLExpression
- Instance Methods
- func behavior(SQLDropBehavior) -> Self
- func cascade() -> Self
- func ifExists() -> Self
- func restrict() -> Self
SQLDropIndexBuilder
- Initializers
- init(SQLDropIndex, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var dropIndex: SQLDropIndex
- var query: any SQLExpression
- Instance Methods
- func behavior(SQLDropBehavior) -> Self
- func cascade() -> Self
- func ifExists() -> Self
- func on(_:)
- func restrict() -> Self
SQLDropTableBuilder
- Initializers
- init(SQLDropTable, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var dropTable: SQLDropTable
- var query: any SQLExpression
- Instance Methods
- func behavior(SQLDropBehavior) -> Self
- func cascade() -> Self
- func ifExists() -> Self
- func restrict() -> Self
- func temporary() -> Self
SQLDropTriggerBuilder
- Initializers
- init(SQLDropTrigger, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var dropTrigger: SQLDropTrigger
- var query: any SQLExpression
- Instance Methods
- func behavior(SQLDropBehavior) -> Self
- func cascade() -> Self
- func ifExists() -> Self
- func restrict() -> Self
- func table(_:)
SQLInsertBuilder
SQLPredicateGroupBuilder
- Instance Properties
- var predicate: (any SQLExpression)?
SQLRawBuilder
- Initializers
- init(SQLQueryString, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var query: any SQLExpression
SQLReturningResultBuilder
- Instance Properties
- var database: any SQLDatabase
- var query: any SQLExpression
SQLSecondaryPredicateGroupBuilder
- Instance Properties
- var secondaryPredicate: (any SQLExpression)?
SQLSelectBuilder
SQLSubqueryBuilder
- Initializers
- init()
- Instance Properties
- var query: SQLSubquery
- var select: SQLSelect
SQLUnionBuilder
- Initializers
- init(on: any SQLDatabase, initialQuery: SQLSelect)
- Instance Properties
- var database: any SQLDatabase
- var query: any SQLExpression
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var union: SQLUnion
SQLUpdateBuilder
- Initializers
- init(SQLUpdate, on: any SQLDatabase)
- Instance Properties
- var database: any SQLDatabase
- var predicate: (any SQLExpression)?
- var query: any SQLExpression
- var returning: SQLReturning?
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var update: SQLUpdate
- var values: [any SQLExpression]
Syntactic Expressions
SQLBinaryExpression
- Initializers
- init(any SQLExpression, SQLBinaryOperator, any SQLExpression)
- init(left: any SQLExpression, op: any SQLExpression, right: any SQLExpression)
- Instance Properties
- let left: any SQLExpression
- let op: any SQLExpression
- let right: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLBinaryOperator
- Enumeration Cases
- case add
- case and
- case concatenate
- case divide
- case equal
- case greaterThan
- case greaterThanOrEqual
- case `in`
- case `is`
- case isNot
- case lessThan
- case lessThanOrEqual
- case like
- case modulo
- case multiply
- case notEqual
- case notIn
- case notLike
- case or
- case subtract
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLBind
- Initializers
- init(any Encodable & Sendable)
- Instance Properties
- let encodable: any Encodable & Sendable
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Methods
- static func group([any Encodable & Sendable]) -> any SQLExpression
SQLFunction
- Initializers
- init(_:args:)
- Instance Properties
- let args: [any SQLExpression]
- let name: String
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Methods
- static coalesce(_:)
SQLGroupExpression
- Initializers
- init(_:)
- Instance Properties
- let expressions: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLIdentifier
- Initializers
- init(String)
- init(stringLiteral: String)
- Instance Properties
- var string: String
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLList
- Initializers
- init([any SQLExpression], separator: any SQLExpression)
- Instance Properties
- var expressions: [any SQLExpression]
- var separator: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLLiteral
- Enumeration Cases
- case all
- case boolean(Bool)
- case `default`
- case null
- case numeric(String)
- case string(String)
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLRaw
- Initializers
- init(String)
- init(String, [any Encodable & Sendable])
- Instance Properties
- var binds: [any Encodable & Sendable]
- var sql: String
- Instance Methods
- func serialize(to: inout SQLSerializer)
Basic Expressions
SQLAlias
- Initializers
- init(_:as:)
- Instance Properties
- var alias: any SQLExpression
- var expression: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLBetween
- Initializers
- init(_:between:and:)
- init(column:between:and:)
- init(operand: T, lowerBound: U, upperBound: V)
- Instance Properties
- let lowerBound: U
- let operand: T
- let upperBound: V
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLColumn
- Initializers
- init(_:table:)
- Instance Properties
- var name: any SQLExpression
- var table: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLConstraint
- Initializers
- init(algorithm: any SQLExpression, name: (any SQLExpression)?)
- Instance Properties
- var algorithm: any SQLExpression
- var name: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDataType
- Enumeration Cases
- case bigint
- case blob
- case custom(any SQLExpression)
- case int
- case real
- case smallint
- case text
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Properties
- static var timestamp: SQLDataType
- Type Methods
- static `enum`(_:)
- static func type(String) -> SQLDataType
SQLDirection
- Enumeration Cases
- case ascending
- case descending
- case notNull
- case null
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDistinct
- Initializers
- init(_:)
- Instance Properties
- let args: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Properties
- static var all: SQLDistinct
SQLForeignKeyAction
- Enumeration Cases
- case cascade
- case noAction
- case restrict
- case setDefault
- case setNull
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLNestedSubpathExpression
- Initializers
- init(column:path:)
- Instance Properties
- var column: any SQLExpression
- var path: [String]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLQualifiedTable
- Initializers
- init(_:space:)
- Instance Properties
- var space: (any SQLExpression)?
- var table: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLQueryString
Clause Expressions
SQLAlterColumnDefinitionType
- Initializers
- init(column:dataType:)
- Instance Properties
- var column: any SQLExpression
- var dataType: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLColumnAssignment
- Initializers
- init(setting:to:)
- init(settingExcludedValueFor:)
- Instance Properties
- var columnName: any SQLExpression
- var value: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLColumnConstraintAlgorithm
- Enumeration Cases
- case check(any SQLExpression)
- case collate(name: any SQLExpression)
- case custom(any SQLExpression)
- case `default`(any SQLExpression)
- case foreignKey(references: any SQLExpression)
- case generated(any SQLExpression)
- case notNull
- case primaryKey(autoIncrement: Bool)
- case unique
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Properties
- static var primaryKey: SQLColumnConstraintAlgorithm
- Type Methods
- static func collate(name: String) -> SQLColumnConstraintAlgorithm
- static `default`(_:)
- static references(_:_:onDelete:onUpdate:)
SQLColumnDefinition
- Initializers
- init(String, dataType: SQLDataType, constraints: [SQLColumnConstraintAlgorithm])
- init(column: any SQLExpression, dataType: any SQLExpression, constraints: [any SQLExpression])
- Instance Properties
- var column: any SQLExpression
- var constraints: [any SQLExpression]
- var dataType: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLConflictAction
- Enumeration Cases
- case noAction
- case update(assignments: [any SQLExpression], predicate: (any SQLExpression)?)
SQLConflictResolutionStrategy
- Initializers
- init(target:action:)
- init(targets:action:)
- Instance Properties
- var action: SQLConflictAction
- var targetColumns: [any SQLExpression]
- Instance Methods
- func queryModifier(for:)
- func serialize(to: inout SQLSerializer)
SQLDropBehavior
- Enumeration Cases
- case cascade
- case restrict
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLEnumDataType
- Initializers
- init(cases:)
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLExcludedColumn
- Initializers
- init(_:)
- Instance Properties
- var name: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLForeignKey
- Initializers
- init(table: any SQLExpression, columns: [any SQLExpression], onDelete: (any SQLExpression)?, onUpdate: (any SQLExpression)?)
- Instance Properties
- let columns: [any SQLExpression]
- let onDelete: (any SQLExpression)?
- let onUpdate: (any SQLExpression)?
- let table: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLInsertModifier
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLJoin
- Initializers
- init(method: any SQLExpression, table: any SQLExpression, expression: any SQLExpression)
- Instance Properties
- var expression: any SQLExpression
- var method: any SQLExpression
- var table: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLJoinMethod
- Enumeration Cases
- case inner
- case left
- case outer
- case right
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLLockingClause
- Enumeration Cases
- case share
- case update
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLOrderBy
- Initializers
- init(expression: any SQLExpression, direction: any SQLExpression)
- Instance Properties
- var direction: any SQLExpression
- var expression: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLReturning
- Initializers
- init(_:)
- Instance Properties
- var columns: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLSubquery
- Initializers
- init(SQLSelect)
- Instance Properties
- var subquery: SQLSelect
- Instance Methods
- func serialize(to: inout SQLSerializer)
- Type Methods
- static func select((any SQLSubqueryClauseBuilder) throws -> any SQLSubqueryClauseBuilder) rethrows -> some SQLExpression
- static func union((any SQLSubqueryClauseBuilder) throws -> any SQLSubqueryClauseBuilder) rethrows -> SQLUnionSubqueryBuilder
SQLTableConstraintAlgorithm
- Enumeration Cases
- case check(any SQLExpression)
- case foreignKey(columns: [any SQLExpression], references: any SQLExpression)
- case primaryKey(columns: [any SQLExpression])
- case unique(columns: [any SQLExpression])
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLUnionJoiner
Query Expressions
SQLAlterEnum
- Instance Properties
- var name: any SQLExpression
- var value: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLAlterTable
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var addColumns: [any SQLExpression]
- var addTableConstraints: [any SQLExpression]
- var dropColumns: [any SQLExpression]
- var dropTableConstraints: [any SQLExpression]
- var modifyColumns: [any SQLExpression]
- var name: any SQLExpression
- var renameTo: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLCreateEnum
- Initializers
- init(name: any SQLExpression, values: [any SQLExpression])
- Instance Properties
- var name: any SQLExpression
- var values: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLCreateIndex
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var columns: [any SQLExpression]
- var modifier: (any SQLExpression)?
- var name: any SQLExpression
- var predicate: (any SQLExpression)?
- var table: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLCreateTable
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var asQuery: (any SQLExpression)?
- var columns: [any SQLExpression]
- var ifNotExists: Bool
- var table: any SQLExpression
- var tableConstraints: [any SQLExpression]
- var temporary: Bool
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLCreateTrigger
SQLDelete
- Initializers
- init(table: any SQLExpression)
- Instance Properties
- var predicate: (any SQLExpression)?
- var returning: SQLReturning?
- var table: any SQLExpression
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDropEnum
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var cascade: Bool
- var dropBehavior: SQLDropBehavior
- var ifExists: Bool
- var name: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDropIndex
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var behavior: (any SQLExpression)?
- var ifExists: Bool
- var name: any SQLExpression
- var owningObject: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDropTable
- Initializers
- init(table: any SQLExpression)
- Instance Properties
- var behavior: (any SQLExpression)?
- var ifExists: Bool
- var table: any SQLExpression
- var temporary: Bool
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLDropTrigger
- Initializers
- init(name: any SQLExpression)
- Instance Properties
- var cascade: Bool
- var dropBehavior: SQLDropBehavior
- var ifExists: Bool
- var name: any SQLExpression
- var table: (any SQLExpression)?
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLInsert
- Initializers
- init(table: any SQLExpression)
- Instance Properties
- var columns: [any SQLExpression]
- var conflictStrategy: SQLConflictResolutionStrategy?
- var genericConflictStrategy: (any SQLExpression)?
- var returning: SQLReturning?
- var table: any SQLExpression
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var valueQuery: (any SQLExpression)?
- var values: [[any SQLExpression]]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLSelect
- Initializers
- init()
- Instance Properties
- var columns: [any SQLExpression]
- var groupBy: [any SQLExpression]
- var having: (any SQLExpression)?
- var isDistinct: Bool
- var joins: [any SQLExpression]
- var limit: Int?
- var lockingClause: (any SQLExpression)?
- var offset: Int?
- var orderBy: [any SQLExpression]
- var predicate: (any SQLExpression)?
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var tables: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLUnion
- Initializers
- init(initialQuery: SQLSelect, unions: [(SQLUnionJoiner, SQLSelect)])
- Instance Properties
- var initialQuery: SQLSelect
- var limit: Int?
- var offset: Int?
- var orderBys: [any SQLExpression]
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var unions: [(SQLUnionJoiner, SQLSelect)]
- Instance Methods
- func add(SQLSelect, all: Bool)
- func add(SQLSelect, joiner: SQLUnionJoiner)
- func serialize(to: inout SQLSerializer)
SQLUpdate
- Initializers
- init(table: any SQLExpression)
- Instance Properties
- var predicate: (any SQLExpression)?
- var returning: SQLReturning?
- var table: any SQLExpression
- var tableExpressionGroup: SQLCommonTableExpressionGroup?
- var values: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
Miscellaneous
SomeCodingKey
- Initializers
- init(intValue: Int)
- init(stringValue: String)
- Instance Properties
- let intValue: Int?
- let stringValue: String
Deprecated
SQLCreateTableAsSubqueryBuilder
SQLError
- Instance Properties
- var sqlErrorType: SQLErrorType
SQLErrorType
SQLTriggerEach
SQLTriggerEvent
SQLTriggerOrder
SQLTriggerTiming
SQLTriggerWhen
Classes
SQLUnionSubqueryBuilder
- Initializers
- init(initialQuery: SQLSelect)
- Instance Properties
- var subquery: SQLUnionSubquery
- var union: SQLUnion
- Instance Methods
- func finish() -> some SQLExpression
Protocols
SQLCommonTableExpressionBuilder
SQLCommonUnionBuilder
Structures
SQLCommonTableExpression
- Initializers
- init(alias: some SQLExpression, query: some SQLExpression)
- Instance Properties
- var alias: any SQLExpression
- var columns: [any SQLExpression]
- var isRecursive: Bool
- var query: any SQLExpression
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLCommonTableExpressionGroup
- Initializers
- init(tableExpressions: [any SQLExpression])
- Instance Properties
- var tableExpressions: [any SQLExpression]
- Instance Methods
- func serialize(to: inout SQLSerializer)
SQLUnionSubquery
- Initializers
- init(SQLUnion)
- Instance Properties
- var subquery: SQLUnion
- Instance Methods
- func serialize(to: inout SQLSerializer)
Extended Modules
Swift
- Extended Protocols
- Sequence
  - Instance Methods
  - func joined(separator:)

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 Method

write(bind:)

Add a bound parameter value to the serializer.

mutating func write(bind encodable: any Encodable & Sendable)

Parameters

encodable: The value to bind.

On this page

Parameters

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

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub