migrate

Documentation

Overview

Copyright 2013 bee authors

Licensed under the Apache License, Version 2.0 (the "License"): you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• func MigrateRefresh(currpath, driver, connStr string)
• func MigrateReset(currpath, driver, connStr string)
• func MigrateRollback(currpath, driver, connStr string)
• func MigrateUpdate(currpath, driver, connStr string)
• func RunMigration(cmd *commands.Command, args []string) int

Constants

const (
	// MigrationMainTPL migration main template
	MigrationMainTPL = `` /* 608-byte string literal not displayed */

	// MYSQLMigrationDDL MySQL migration SQL
	MYSQLMigrationDDL = `` /* 621-byte string literal not displayed */

	// POSTGRESMigrationDDL Postgres migration SQL
	POSTGRESMigrationDDL = `` /* 286-byte string literal not displayed */

)

Variables

var CmdMigrate = &commands.Command{
	UsageLine: "migrate [Command]",
	Short:     "Runs database migrations",
	Long: `The command 'migrate' allows you to run database migrations to keep it up-to-date.

  ▶ {{"To run all the migrations:"|bold}}

    $ bee migrate [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]

  ▶ {{"To rollback the last migration:"|bold}}

    $ bee migrate rollback [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]

  ▶ {{"To do a reset, which will rollback all the migrations:"|bold}}

    $ bee migrate reset [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]

  ▶ {{"To update your schema:"|bold}}

    $ bee migrate refresh [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
`,
	PreRun: func(cmd *commands.Command, args []string) { version.ShowShortVersionBanner() },
	Run:    RunMigration,
}

Functions

func MigrateRefresh

func MigrateRefresh(currpath, driver, connStr string)

migrationRefresh rolls back all migrations and start over again

func MigrateReset

func MigrateReset(currpath, driver, connStr string)

MigrateReset rolls back all migrations

func MigrateRollback

func MigrateRollback(currpath, driver, connStr string)

MigrateRollback rolls back the latest migration

func MigrateUpdate

func MigrateUpdate(currpath, driver, connStr string)

MigrateUpdate does the schema update

func RunMigration

func RunMigration(cmd *commands.Command, args []string) int

runMigration is the entry point for starting a migration