Skip to content

Vapor API Docs

XCTFluent

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
ArrayTestDatabase
- Initializers
- init()
- Instance Methods
- func append(_:)
- func execute(query: DatabaseQuery, onOutput: (any DatabaseOutput) -> ()) throws
CallbackTestDatabase
- Initializers
- init(callback: (DatabaseQuery) -> [any DatabaseOutput])
- Instance Methods
- func execute(query: DatabaseQuery, onOutput: (any DatabaseOutput) -> ()) throws
DummyDatabaseDriver
- Initializers
- init(on: any EventLoopGroup)
- Instance Properties
- let eventLoopGroup: any EventLoopGroup
- var fieldDecoder: any Decoder
- Instance Methods
- func makeDatabase(with: DatabaseContext) -> any Database
- func shutdown()
Protocols
TestDatabase
- Instance Properties
- var configuration: any DatabaseConfiguration
- var db: any Database
- Instance Methods
- func database(context: DatabaseContext) -> any Database
- func execute(query: DatabaseQuery, onOutput: (any DatabaseOutput) -> ()) throws
Structures
DummyDatabase
DummyDatabaseConfiguration
- Instance Properties
- var middleware: [any AnyModelMiddleware]
- Instance Methods
- func makeDriver(for: Databases) -> any DatabaseDriver
DummyRow
- Initializers
- init()
- Instance Properties
- var description: String
- Instance Methods
- func contains(FieldKey) -> Bool
- func decode<T>(FieldKey, as: T.Type) throws -> T
- func decodeNil(FieldKey) throws -> Bool
- func nested(FieldKey) throws -> any DatabaseOutput
- func schema(String) -> any DatabaseOutput
TestOutput
- Initializers
- init()
- init(_:)
- Instance Properties
- var description: String
- Instance Methods
- func append(key: FieldKey, value: any Sendable)
- func contains(FieldKey) -> Bool
- func decode<T>(FieldKey, as: T.Type) throws -> T
- func decodeNil(FieldKey) throws -> Bool
- func nested(FieldKey) throws -> any DatabaseOutput
- func schema(String) -> any DatabaseOutput
Enumerations
TestDatabaseError
- Enumeration Cases
- case ranOutOfResults
TestRowDecodeError
- Enumeration Cases
- case wrongType

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

configuration

var configuration: any DatabaseConfiguration { get }

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