migration

type Actions interface {
	// Query executes a query that returns rows, typically a SELECT.
	// Query uses '?' as placeholder for arguments, no matter the database backend.
	Query(query string, args ...any) (*sql.Rows, error)

	// QueryRow executes a query that is expected to return at most one row.
	// QueryRow always returns a non-nil value. Errors are deferred until
	// Row's Scan method is called.
	// If the query selects no rows, the *Row's Scan will return ErrNoRows.
	// Otherwise, the *Row's Scan scans the first selected row and discards
	// the rest.
	// QueryRow uses '?' as placeholder for arguments, no matter the database backend.
	QueryRow(query string, args ...any) *sql.Row

	// Exec executes a prepared statement with the given arguments. The statement
	// should not return anything. If it does, use Query or QueryRow instead.
	// Exec uses '?' as placeholder for arguments, no matter the database backend.
	Exec(query string, args ...any) error

	// GetDialect returns the database's dialect.
	GetDialect() string

	// FormatValue takes a Go value and returns the corresponding SQL value in
	// the given SQL type. If the given value cannot be formatted in the given
	// type, an error is returned.
	FormatValue(val any) (string, error)

	// CreateTable creates a new table with the given definitions. A definition
	// can be either Column or a TableConstraint.
	CreateTable(name string, defs ...Definition) error

	// AddColumn adds a new column to the table with the given type and constraints.
	// It is up to the migration script to then fill that column if necessary.
	AddColumn(table, column string, dataType sqlType, constraints ...Constraint) error

	// AddRow inserts a new row into the given table.
	// Deprecated: simply use Exec with an 'INSERT INTO' command.
	AddRow(table string, values Values) error

	// RenameTable changes the name of the given table to a new one. This is a
	// destructive (non retro-compatible) operation.
	RenameTable(oldName, newName string) error

	// DropTable drops the given table. This is a destructive (non
	// retro-compatible) operation.
	DropTable(name string) error

	// RenameColumn changes the name of the given column. This is a destructive
	// (non retro-compatible) operation.
	RenameColumn(table, oldName, newName string) error

	// ChangeColumnType changes the type of the given column. This is a
	// destructive (non retro-compatible) operation.
	ChangeColumnType(table, col string, to sqlType) error

	// SwapColumns swaps all the values of col1 and col2 for the rows fulfilling
	// the given conditions. The columns' types MUST be compatible for this
	// operation to work.
	SwapColumns(table, col1, col2, cond string, condArgs ...any) error

	// DropColumn drops the given column. This is a destructive (non
	// retro-compatible) operation.
	DropColumn(table, name string) error

	// CreateIndex adds an index (unique or not) on the given columns of the given
	// table.
	CreateIndex(isUnique bool, table, indexName string, cols ...string) error

	// DropIndex drops the index (unique or not) on the given columns of the given
	// table if it exists.
	DropIndex(isUnique bool, table, indexName string) error
}

type Column struct {
	Name        string
	Type        sqlType
	Constraints []Constraint
}

type Constraint any

type DATE time.Time

type DATETIME time.Time

type Definition any

type Engine struct {
	// contains filtered or unexported fields
}

type Logger interface {
	Trace(msg string, args ...any)
	Debug(msg string, args ...any)
	Info(msg string, args ...any)
	Warning(msg string, args ...any)
	Error(msg string, args ...any)
	Critical(msg string, args ...any)
	Alert(msg string, args ...any)
}

type Migration []Script

type Script struct {
	// A short description of what the script does.
	Description string
	// Up applies the migration.
	Up func(db Actions) error
	// Down undoes migration.
	Down func(db Actions) error
}

type TS time.Time

type TSZ time.Time

type TableConstraint any

type Values map[string]any