arstercz / snap Goto Github PK

#Snap Version control for database schemas.

Snap is a proof of concept tool to start exploring version control for database schemas. Usually when maintaining and updating database schemas over multiple environments things start to get confusing very quickly. Snap is a tool inspired by git allowing you to manage and interrogate snap managed databases.

⚠️ This tool is still very much in alpha stage. Please don't use it for business critical databases as data loss may occur.

Make sure you have Go installed and correctly configured then issue the following command:

go install github.com/nomad-software/snap

A configuration file must exist in your home directory to configure the database server connection. The config file should be called .snap and look like this:

{
    "identity": "Gary Willoughby <[email protected]>",
    "database": {
        "user": "foo",
        "password": "bar",
        "protocol": "tcp",
        "host": "localhost",
        "port": "3306"
    }
}

The database protocol, host and port fields are optional and default to the values shown above.

Snap is invoked on the command line by using the program name followed by a command and any required arguments. Some commands have optional arguments too.

snap command <arguments...> [optional]

The following is an overview of each command. To read the entire command documentation see snap's built-in help.

Full help is available from within the program, viewable after issuing the command:

snap help

Further command specific help is available by specifing the command too, like this:

snap help init

• Currently only MySql databases are supported.
• Because of reliance on the external diff tool, only Posix environments are currently supported.