snap

command module
v0.0.0-...-6684bfc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 9, 2018 License: MIT Imports: 5 Imported by: 0

README

#Snap Version control for database schemas.


⚠ This project has been abandoned!!!

Overview

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.

Installation

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

go get github.com/nomad-software/snap

Configuration

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 <snap@nomad.so>",
    "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.

Usage

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.

Command Description
commit Commit changes to a schema.
copy Copy a database from a specified revision.
diff Show differences between schema revisions.
dump Dump the entire schema at a specified revision.
help View the help.
init Initialise a database for use with snap.
list List all managed databases.
log Show a log of changes to a database schema.
show Show the changes made at a specified schema revision.
update Update a database schema to any previously commit change.
version Show version information.

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

Supported environments

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

Documentation

Overview

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.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL