Documentation
¶
Overview ¶
Package migrate 提供带跨副本锁的有序 GORM 数据库迁移。
Index ¶
Constants ¶
View Source
const ( TableName = "_migrations" MinimumMySQLVersion = "5.7" MinimumMariaDBVersion = "10.5" MinimumPostgresVersion = "14" MinimumSQLiteVersion = "3.35" )
Variables ¶
View Source
var ( ErrDatabaseRequired = errx.New("migrate: database is required") ErrDatabaseNotSelected = errx.New("migrate: database is not selected") ErrInvalidMigrationID = errx.New("migrate: invalid migration ID") ErrDuplicatedID = errx.New("migrate: duplicated migration ID") ErrUpRequired = errx.New("migrate: migration Up is required") ErrUnknownMigration = errx.New("migrate: database contains an unknown migration") ErrUnsupportedDriver = errx.New("migrate: unsupported database driver") ErrInvalidLockTimeout = errx.New("migrate: lock timeout must not be negative") ErrLockTimeout = errx.New("migrate: lock timeout") ErrLockFailed = errx.New("migrate: lock operation failed") )
Functions ¶
This section is empty.
Types ¶
type Migrator ¶
type Migrator struct {
// contains filtered or unexported fields
}
Migrator 管理一组固定且已排序的迁移。
type Option ¶
type Option func(*config)
Option 调整迁移和锁行为。
func WithLockTimeout ¶
WithLockTimeout 设置等待迁移锁的最长时间。
func WithTransaction ¶
WithTransaction 配置 gormigrate 是否为迁移批次开启事务。 SQLite 始终由 BEGIN IMMEDIATE 包裹,以同时提供锁和事务边界。
func WithValidateUnknownMigrations ¶
WithValidateUnknownMigrations 配置是否拒绝数据库中未在当前代码声明的迁移。
Click to show internal directories.
Click to hide internal directories.