parser

package

v1.0.0 Latest Latest Go to latest Published: May 15, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/therox/gomigr

Links

Open Source Insights

Documentation ¶

Overview ¶

Пакет parser реализует разбор файлов миграций в формате DSL gomigr.

Файл миграции имеет имя <version>_<snake_case_description>.sql и тело с обязательными маркерами `-- +migrate Up` и `-- +migrate Down`. До маркера Up допускаются 0..N комментариев вида `-- depends-on: V[, V2, ...]`.

Index ¶

type Migration
- func LoadDir(dir string) ([]*Migration, error)
- func ParseFile(path string) (*Migration, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Migration ¶

type Migration struct {
	Version   string
	Name      string
	DependsOn []string
	UpSQL     string
	DownSQL   string
	Checksum  string
}

Migration — распарсенная миграция со всем содержимым, нужным рантайму. Поля UpSQL и DownSQL передаются драйверу как есть, без ручного сплита на отдельные запросы (см. требования к парсеру в плане).

func LoadDir ¶

func LoadDir(dir string) ([]*Migration, error)

LoadDir читает директорию и парсит все *.sql файлы в ней. Поддиректории и не-SQL файлы игнорируются. Порядок возвращаемых миграций определяется ОС — упорядочивание выполняется на уровне графа.

func ParseFile ¶

func ParseFile(path string) (*Migration, error)

ParseFile читает и парсит один файл миграции по абсолютному или относительному пути. Возвращает заполненную *Migration или ошибку.

Source Files ¶

View all Source files

parser.go

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