diff

package

v0.2.0 Latest Latest Go to latest Published: Aug 27, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/mizuchilabs/sqlite-schema-diff

Links

Open Source Insights

Documentation ¶

Overview ¶

Package diff provides schema comparison and migration generation.

Index ¶

func Apply(ctx context.Context, db *sql.DB, schemaDir string, opts ApplyOptions) error
func GenerateSQL(changes []Change) string
func HasDestructive(changes []Change) bool
type ApplyOptions
type Change
type ChangeType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Apply ¶

func Apply(ctx context.Context, db *sql.DB, schemaDir string, opts ApplyOptions) error

Apply compares the database against a schema directory and applies the resulting changes. Backup and migration run on a single connection inside one transaction.

func GenerateSQL ¶

func GenerateSQL(changes []Change) string

GenerateSQL generates a complete migration script.

func HasDestructive ¶

func HasDestructive(changes []Change) bool

HasDestructive returns true if any changes are destructive.

Types ¶

type ApplyOptions ¶

type ApplyOptions struct {
	DryRun          bool
	SkipDestructive bool
	BackupPath      string // Path to create backup (empty = no backup)
}

ApplyOptions configures how changes are applied.

type Change ¶

type Change struct {
	Type        ChangeType
	Object      string   // Name of the object being changed
	Description string   // Human-readable description
	SQL         []string // SQL statements to apply
	Destructive bool     // Whether this change may lose data
}

Change represents a single schema change.

func Compare ¶

func Compare(ctx context.Context, db *sql.DB, schemaDir string) ([]Change, error)

Compare compares a database against a schema directory and returns changes. If SetBaseFS was called, reads from the embedded filesystem instead.

func CompareDatabases ¶

func CompareDatabases(ctx context.Context, from, to *sql.DB) ([]Change, error)

CompareDatabases compares two databases.

func Diff ¶

func Diff(from, to *schema.Database) []Change

Diff compares two schemas and returns the changes.

type ChangeType ¶

type ChangeType string

ChangeType represents the type of schema change.

const (
	CreateTable   ChangeType = "CREATE_TABLE"
	DropTable     ChangeType = "DROP_TABLE"
	RenameTable   ChangeType = "RENAME_TABLE"
	AddColumn     ChangeType = "ADD_COLUMN"
	RenameColumn  ChangeType = "RENAME_COLUMN"
	RecreateTable ChangeType = "RECREATE_TABLE"
	CreateIndex   ChangeType = "CREATE_INDEX"
	DropIndex     ChangeType = "DROP_INDEX"
	CreateView    ChangeType = "CREATE_VIEW"
	DropView      ChangeType = "DROP_VIEW"
	CreateTrigger ChangeType = "CREATE_TRIGGER"
	DropTrigger   ChangeType = "DROP_TRIGGER"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL