README
¶
Мигратор для баз данных.
Компонент для провидений миграций, основан на пакете https://github.com/golang-migrate/migrate.
В контейнере объектов, доступна ссылка на объект github.com/golang-migrate/migrate/v4/Migrate.
Объект конфигурации.
type Config struct {
Path string
}
Описание полей:
| Поле | Описание | Значение по умолчанию |
|---|---|---|
| Path | Путь до директории с миграциями, этот параметр может быть передан одним из 3-х методов: - флаг командной строки --migrator.source - переменная окружения MIGRATOR_SOURCE - значение в конфиг файле migrator.source |
file://./migrations/${db.driver} |
Пакет так же использует объект конфигурации из пакета Клиент для баз данных для подключения к базе данных.
Важно. Мигратор использует контейнер объектов, для получения клиента для базы данных который реализует интерфейс
driver.Connector, если пакет Клиент для баз данных используется полноценно, то получение выбранного клиента пройдет автоматически, если используется клиент под определенную СУБД, необходимо в ручную, указать тип клиента в объект конфигурации на этапе конфигурирования приложения.Все поддерживаемые СУБД перечислены в пакете Клиент для баз данных.
Documentation
¶
Index ¶
Constants ¶
const ( PathFieldName = "migrator.source" DriverReplacement = "${db.driver}" PathDefault = "file://./migrations/" + DriverReplacement )
Variables ¶
var Component = &app.Component{ Dependencies: app.Components{ table.Component, }, Constructor: app.Constructor(func(container container.Container) error { return container.Provides( NewConfig, NewWithConfigurator, ) }), BindFlags: app.BindFlags(func(flagSet *pflag.FlagSet, container container.Container) error { return container.Invoke(func(config *Config) { flagSet.StringVar(&config.Path, PathFieldName, PathDefault, "path to migrations directory") }) }), Run: app.Run(func(container container.Container) error { return container.Invoke(func( migrator *migrate.Migrate, informer logger.Informer, ) error { err := migrator.Up() if err != nil && err != migrate.ErrNoChange { return err } if err == migrate.ErrNoChange { return nil } version, _, err := migrator.Version() informer.Infof("migrator: up to '%d' version", version) return nil }) }), }
Functions ¶
func NewWithConfigurator ¶
func NewWithConfigurator( config *Config, configurator configurator.Configurator, db client.DataBase, informer logger.Informer, tableReplacer table.Replacer, ) (*migrate.Migrate, error)
Types ¶
type Config ¶
type Config struct {
Path string
}
func Configuration ¶
func Configuration(config *Config, configurator configurator.Configurator) *Config
Source Files
Directories