Skip to content

Vapor API Docs

MySQLNIO

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
MySQLConnection
MySQLPacketEncoder
- Initializers
- init(sequence: MySQLPacketSequence, logger: Logger)
- Instance Properties
- let sequence: MySQLPacketSequence
- Instance Methods
- func encode(data: MySQLPacket, out: inout ByteBuffer) throws
- Type Aliases
- MySQLPacketEncoder.OutboundIn
MySQLPacketSequence
- Initializers
- init()
- Instance Properties
- var current: UInt8?
- Instance Methods
- func next() -> UInt8
- func reset()
Protocols
MySQLCommand
MySQLDataConvertible
- Initializers
- init?(mysqlData: MySQLData)
- Instance Properties
- var mysqlData: MySQLData?
MySQLDatabase
MySQLPacketDecodable
- Type Methods
- static func decode(from: inout MySQLPacket, capabilities: MySQLProtocol.CapabilityFlags) throws -> Self
MySQLPacketEncodable
- Instance Methods
- func encode(to: inout MySQLPacket, capabilities: MySQLProtocol.CapabilityFlags) throws
Structures
MySQLCommandState
- Initializers
- init(response: [MySQLPacket], done: Bool, resetSequence: Bool, error: (any Error)?)
MySQLData
MySQLPacket
MySQLPacketDecoder
- Initializers
- init(sequence: MySQLPacketSequence, logger: Logger)
- Instance Properties
- let sequence: MySQLPacketSequence
- Instance Methods
- func decode(context: ChannelHandlerContext, buffer: inout ByteBuffer) throws -> DecodingState
- func decodeLast(context: ChannelHandlerContext, buffer: inout ByteBuffer, seenEOF: Bool) throws -> DecodingState
- Type Aliases
- MySQLPacketDecoder.InboundOut
MySQLProtocol
MySQLQueryMetadata
- Instance Properties
- let affectedRows: UInt64
- let lastInsertID: UInt64?
MySQLRow
- Initializers
- init(format: MySQLData.Format, columnDefinitions: [MySQLProtocol.ColumnDefinition41], values: [ByteBuffer?])
- Instance Properties
- let columnDefinitions: [MySQLProtocol.ColumnDefinition41]
- var description: String
- let format: MySQLData.Format
- let values: [ByteBuffer?]
- Instance Methods
- func column(String, table: String?) -> MySQLData?
MySQLTime
Enumerations
MySQLError
Extended Modules
Foundation
NIOCore
- Extended Structures
- ByteBuffer
  - Instance Methods
  - func readNullTerminatedBytes() -> [UInt8]?
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

catalog

catalog (lenenc_str) – catalog (always “def”)

var catalog: 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