sqlite_schema_forge library

Classes

Column

Column definition Prefer to use the factory helpers Column.id, Column.text, etc.

DatabaseExecutor

Abstract executor interface so SqliteSchemaForge works with sqflite, sqlite3, or drift.

Index

Index over one or more columns of a table.

MigrationPlan

Ordered steps that migrate a database from fromVersion to toVersion.

MigrationResult

Outcome of a migration: whether anything migrated and which SQL ran.

PlanStep

One step in a MigrationPlan.

RawSql

Represents unquoted raw SQL expressions (e.g. CURRENT_TIMESTAMP, NULL, (col_a + col_b))

Schema

A versioned schema: the desired tables, virtualTables, and triggers.

SqliteSchemaForge

Declarative schema migrator: diff a target Schema against a live database, then apply the resulting MigrationPlan.

Table

A table definition: a name, its columns, and any indexes.

Trigger

A SQLite trigger: a named body run in response to an event on a table.

VirtualTable

A virtual table backed by a module such as fts5 or rtree.

Enums

ChangeType

Kind of work a single PlanStep performs.

DataType

SQLite storage class of a Column.

TriggerEvent

Event a Trigger fires on.

TriggerTiming

When a Trigger fires relative to its event.