stdmageatlas

Documentation

Overview

Package stdmageatlas provides mage commands for working with Atlas-based projects.

Index

• func Diff(name string) error
• func Hash() error
• func Init(atlasInspectEnv, atlasLocalEnv, atlasMigrationsDir string, hook PatchFunc, ...)
• func Inspect() error
• func Iterate(name string) error
• type PatchFunc

Functions

func Diff

func Diff(name string) error

Diff generates a named migration for the local environment.

func Hash

func Hash() error

Hash runs the logic for re-hashing the Atlas sum file.

func Init

func Init(
	atlasInspectEnv,
	atlasLocalEnv,
	atlasMigrationsDir string,
	hook PatchFunc,
	_ ...[]string,
)

Init inits the mage targets. The weird signature is to make Mage ignore this when importing.

func Inspect

func Inspect() error

Inspect visualizes the schema.

func Iterate

func Iterate(name string) error

Iterate replaces the latest migration file with the same name, for quicker development.

Types

type PatchFunc

type PatchFunc = func(latestName, latestFilename string) error

PatchFunc allows users of the mage targets to patch any migration that is generated.