The protocol for SQLite virtual table modules.
protocol VirtualTableModuleThe protocol can define a DSL for the create(virtualTable:options:using:_:) Database method:
let module = ...
try db.create(virtualTable: "item", using: module) { t in
...
}GRDB ships with three concrete classes that implement this protocol: FTS3, FTS4 and FTS5.
import GRDBA toolkit for SQLite databases, with a focus on application development
func create<Module>(virtualTable tableName: String, options: VirtualTableOptions = [], using module: Module, _ body: ((Module.TableDefinition) throws -> Void)? = nil) throws where Module : VirtualTableModule Creates a virtual database table.
struct FTS3The virtual table module for the FTS3 full-text engine.
struct FTS4The virtual table module for the FTS4 full-text engine.
struct VirtualTableConfigurationassociatedtype TableDefinitionThe type of the argument in the create(virtualTable:options:using:_:) closure.
var moduleName: String { get }The name of the module.
func database(_ db: Database, didCreate tableName: String, using definition: TableDefinition) throws Execute any relevant database statement after the virtual table has been created.
func makeTableDefinition(configuration: VirtualTableConfiguration) -> TableDefinition Returns a table definition that is passed as the argument in the create(virtualTable:options:using:_:) closure.
func moduleArguments(for definition: TableDefinition, in db: Database) throws -> [String] Returns the module arguments for the CREATE VIRTUAL TABLE query.
func alter(table name: String, body: (TableAlteration) -> Void) throws Modifies a database table.
func create(table name: String, options: TableOptions = [], body: (TableDefinition) throws -> Void) throws Creates a database table.
func create(virtualTable name: String, options: VirtualTableOptions = [], using module: String) throws Creates a virtual database table.
func drop(table name: String) throws Deletes a database table.
func dropFTS4SynchronizationTriggers(forTable tableName: String) throws Deletes the synchronization triggers for a synchronized FTS4 table.
func dropFTS5SynchronizationTriggers(forTable tableName: String) throws Deletes the synchronization triggers for a synchronized FTS5 table.
func rename(table name: String, to newName: String) throws Renames a database table.
struct ColumnTypeAn SQL column type.
enum ConflictResolutionAn SQLite conflict resolution.
enum ForeignKeyActionA foreign key action.
final class TableAlterationA TableDefinition lets you modify the components of a database table.
final class TableDefinitionA TableDefinition lets you define the components of a database table.
struct TableOptionsTable creation options.
struct VirtualTableOptionsVirtual table creation options.