astipatch

README

Patch manager written in GO.

Languages

SQL

Patches are described as an array of transactions in yaml. Each transaction can contain multiple queries and/or rollbacks.

A transaction must only describe:

• either one statement causing an implicit commit
• or multiple statements not causing an implicit commit

-
  queries:
    - >      
      CREATE TABLE test (
        name VARCHAR(255) NOT NULL
      )
  rollbacks:
    - DROP TABLE test
-
  queries:
    - INSERT INTO test (name) VALUES ('test 1'), ('test2')
    - UPDATE test SET name = 'test 2' WHERE id = 2
  rollbacks:
    - DELETE FROM test WHERE id IN (1, 2)
-
  queries:
    - ALTER TABLE test ADD id int NOT NULL AUTO_INCREMENT PRIMARY KEY
  rollbacks:
    - ALTER TABLE test DROP COLUMN id

Documentation

Index

• Variables
• type Configuration
  • func FlagConfig() Configuration
• type PatchSQL
• type PatchSQLTransaction
• type Patcher
  • func NewPatcherSQL(conn *sqlx.DB, s Storer, l astikit.StdLogger) Patcher
• type Storer
  • func NewStorerSQL(conn *sqlx.DB) Storer

Variables

var (
	PatchesDirectoryPath = flag.String("astipatch-patches-directory-path", "", "the patches directory path")
)

Flags

Types

type Configuration

type Configuration struct {
	PatchesDirectoryPath string `toml:"patches_directory_path"`
}

Configuration represents the patcher configuration

func FlagConfig

func FlagConfig() Configuration

FlagConfig generates a Configuration based on flags

type PatchSQL

type PatchSQL []PatchSQLTransaction

type PatchSQLTransaction

type PatchSQLTransaction struct {
	Queries   []string `yaml:"queries"`
	Rollbacks []string `yaml:"rollbacks"`
}

type Patcher

type Patcher interface {
	Init() error
	Load(c Configuration) error
	Patch() error
	Rollback() error
}

Patcher represents an object capable of patching

func NewPatcherSQL

func NewPatcherSQL(conn *sqlx.DB, s Storer, l astikit.StdLogger) Patcher

NewPatcherSQL creates a new SQL patcher

type Storer

type Storer interface {
	DeleteLastBatch() error
	Delta([]string) ([]string, error)
	Init() error
	InsertBatch([]string) error
	LastBatch() ([]string, error)
}

Storer represents an object capable of storing patch's state

func NewStorerSQL

func NewStorerSQL(conn *sqlx.DB) Storer

NewStorerSQL creates a new SQL storer