dvc

README

DVC

Rationale

1. JSON representation of a database schema
   • Generated based on local connection
   • Stored in source control (ergo versioned)
   • Can be used in CD process when deploying to remote server and wanting to apply changes to remote database
2. Database comparison and sql generation
3. Code Generation

CLI Commands & Usage

Import

Import a remote json schema into a local json representation

$ dvc import

Compare

Compare local json schema with remote database schema

$ dvc compare 

Gen

Generate code based upon a schema

Usage

1. Load Config
2. Load changesets json file
3. Load changesets sql files
4. Pull down the hash of the changesets file
5. Verify which changesets have been applied

Code

import (
    "github.com/macinnir/dvc"
)

func main() {
    d := dvc.DVC{}
    d.Run("path/to/changeset/files", "databaseHost:port", "username", "password")
}

Changelog files

Naming

{changesetNum}/{changeNum}_{action}_{target}__{etc}.sql

changesetNum

Directory containing multiple sql files grouped by team (e.g. sprint)

changeNum

Numeric ordinal of the change within the changeset. 001 as a prefix allows for 1000 change files within the changeset and uses the native filesystem to list the files in order (the same order in which they will be run).

Action

One of the following:

createTable

Create a new table

alterTable

Alter an existing table

dropTable

Drop an existing table

createView

Create a new view

alterView

Alter an existing view

dropView

Drop an existing view

insert

Insert data into an existing table

Target

The name of table or view on which the action will be taken.

etc (optional)

Other pertinent information for the action to be taken.

Examples:

    0001/
        001_alterTable_myTable__addColumn_foo.sql
        002_alterTable_myTable__addIndex_ucFoo.sql

Documentation

Based on DocOpt http://docopt.org/

Dependencies https://golang.github.io/dep/docs/migrating.html

https://glide.sh/