darwin

Database schema evolution library for Go

Programming language: Go

License: MIT License

Tags: Database    

README

Try browsing the code on Sourcegraph!

Darwin

Database schema evolution library for Go

Example

package main

import (
    "database/sql"
    "log"

    "github.com/GuiaBolso/darwin"
    _ "github.com/go-sql-driver/mysql"
)

var (
    migrations = []darwin.Migration{
        {
            Version:     1,
            Description: "Creating table posts",
            Script: `CREATE TABLE posts (
                        id INT      auto_increment, 
                        title       VARCHAR(255),
                        PRIMARY KEY (id)
                     ) ENGINE=InnoDB CHARACTER SET=utf8;`,
        },
        {
            Version:     2,
            Description: "Adding column body",
            Script:      "ALTER TABLE posts ADD body TEXT AFTER title;",
        },
    }
)

func main() {
    database, err := sql.Open("mysql", "root:@/darwin")

    if err != nil {
        log.Fatal(err)
    }

    driver := darwin.NewGenericDriver(database, darwin.MySQLDialect{})

    d := darwin.New(driver, migrations, nil)
    err = d.Migrate()

    if err != nil {
        log.Println(err)
    }
}

Questions

Q. Why there is not a command line utility?

A. The purpose of this library is just be a library.

Q. How can I read migrations from file system?

A. You can read with the standard library and build the migration list.

Q. Can I put more than one statement in the same Script migration?

A. I do not recommend. Put one database change per migration, if some migration fail, you exactly what statement caused the error. Also only postgres correctly handle rollback in DDL transactions.

To be less annoying you can organize your migrations like? 1.0, 1.1, 1.2 and so on.

Q. Why does not exists downgrade migrations?

A. Please read https://flywaydb.org/documentation/faq#downgrade

Q. Does Darwin perform a roll back if a migration fails?

A. Please read https://flywaydb.org/documentation/faq#rollback

Q. What is the best strategy for dealing with hot fixes?

A. Plese read https://flywaydb.org/documentation/faq#hot-fixes

LICENSE

The MIT License (MIT)

Copyright (c) 2016 Claudemiro

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.