Documentation
¶
Index ¶
- Variables
- func Asset(name string) ([]byte, error)
- func AssetDigest(name string) ([sha256.Size]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func AssetString(name string) (string, error)
- func Digests() (map[string][sha256.Size]byte, error)
- func GetMigrationsUp(dbUrl string) (migrationIds []string)
- func GetNumMigrationsDown(dbUrl string) (nMigrations int)
- func Migrate(db *sql.DB, dir MigrateDir, count int) (int, error)
- func MustAsset(name string) []byte
- func MustAssetString(name string) string
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- func Status(db *sql.DB) (string, error)
- type MigrateDir
Constants ¶
This section is empty.
Variables ¶
var Migrations migrate.MigrationSource = &migrate.AssetMigrationSource{ Asset: Asset, AssetDir: AssetDir, Dir: "migrations", }
Migrations represents all of the schema migration for horizon
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDigest ¶
AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/
foo.txt
img/
a.png
b.png
then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetString ¶
AssetString returns the asset contents as a string (instead of a []byte).
func GetMigrationsUp ¶
GetMigrationsUp returns a list of names of any migrations needed in the "up" direction (more recent schema versions).
func GetNumMigrationsDown ¶
GetNumMigrationsDown returns the number of migrations to apply in the "down" direction to return to the older schema version expected by this version of Horizon. To keep the code simple, it does not provide a list of migration names.
func Migrate ¶
Migrate performs schema migration. Migrations can occur in one of three ways:
- up: migrations are performed from the currently installed version upwards. If count is 0, all unapplied migrations will be run.
- down: migrations are performed from the current version downard. If count is 0, all applied migrations will be run in a downard direction.
- redo: migrations are first ran downard `count` times, and then are rand upward back to the current version at the start of the process. If count is 0, a count of 1 will be assumed.
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func MustAssetString ¶
MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory.
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively.
Types ¶
type MigrateDir ¶
type MigrateDir string
MigrateDir represents a direction in which to perform schema migrations.
const ( // MigrateUp causes migrations to be run in the "up" direction. MigrateUp MigrateDir = "up" // MigrateDown causes migrations to be run in the "down" direction. MigrateDown MigrateDir = "down" // MigrateRedo causes migrations to be run down, then up MigrateRedo MigrateDir = "redo" )
Source Files