davidguilherme / sql-source-control

Simple CLI for getting SQL into source control systems.

SQL Source Control

sql-source-control is an open source CLI for scripting out SQL objects into a flat file structure for use with source control systems such as Git, SVN or Mercurial. Under the hood, sql-source-control discovers database objects and scripts them out using native database code. From there, you can use any source control CLI or GUI to commit to your source control system.

Works with Microsoft SQL Server 2005 and higher.

Installation

npm install -g sql-source-control

Usage

sql-source-control connects to your database with settings from a config file. Commands are directory specific, so run all commands in the directory you want the scripts created in.

ssc --help

Init

This will ask you a bunch of questions, and then write a config file for you.

If the current directory contains a Web.config file with the connectionStrings property, the first node will be used for default values. Alternatively, a path to a Web.config file can be specified with the --webconfig flag.

ssc init

Options:

• -f or --force will overwrite an existing config file, if present.
• -s or --skip will use defaults and not prompt you for any options.
• -w or --webconfig to provide a relative path to a Web.config file.

Conns

List all available connections specified in the configuration file.

ssc conns

Pull

Generate SQL files for all tables, stored procedures, functions, etc. All scripts will be put in the output root directory and SQL scripts will be organized into subdirectories (based on config file).

ssc pull dev

Where dev is the optional name of the connection to use. If omitted, the first available connection is used.

Example output:

./_sql-database
    ./functions/scalar-valued
        dbo.complex-math.sql
        ...
    ./functions/table-valued
        dbo.awesome-table-func.sql
        ...
    ./schemas
        dbo.sql
        ...
    ./stored-procedures
        dbo.people-read.sql
        ...
    ./tables
        dbo.people.sql
        ...
    ./views
        dbo.super-cool-view.sql
        ...
    ./user-defined-types/table-valued-parameters
        dbo.insert-people-params.sql
        ...

Push (beta)

Execute all local scripts against the requested database.

ssc push prod

Where prod is the optional name of the connection to use. If omitted, the first available connection is used.

WARNING: All scripts are directly executed against the requested connetion. This can not be undone! Be sure to backup your database before running the push command.

Cat

Concatenate all SQL files into a single file. Outputs to ./_sql-database/cat.sql.

ssc cat

Config Options

Configuration options are stored in a ssc.json file.

{
    // SQL server connections ...
    "connections": [{
        "name": "dev",
        "server": "dev.example.com\\development",
        "database": "awesome-db",
        "port": 1433,
        "user": "example",
        "password": "qwerty"
    }],

    // ... OR, path to Web.config file with connectionStrings
    "connections": "../Web.config",

    // the following options are optional (default values shown) ...

    // glob of files to include / exclude (examples: ["dbo.*"] or ["*", "!dbo.*"])
    "files": [],

    "output": {

        // directory to place scripted files into (relative to config file)
        "root": "./_sql-database",

        // directory to script procs (relative to root)
        "procs": "./stored-procedures",

        // directory to script schemas (relative to root)
        "schemas": "./schemas",

        // directory to script scalar functions (relative to root)
        "scalar-valued": "./functions/scalar-valued",

        // directory to script table functions (relative to root)
        "table-valued": "./functions/table-valued",

        // directory to script tables (relative to root)
        "tables": "./tables",

        // directory to script triggers (relative to root)
        "triggers": "./triggers",

        // directory to script views (relative to root)
        "views": "./views"

        // directory to script table-valued parameters (relative to root)
        "table-valued-parameters": "./user-defined-types/table-valued-parameters"
    },

    "idempotency": {

        // options: "if-exists-drop", "if-not-exists", or false
        "procs": "if-exists-drop",
        "scalar-valued": "if-exists-drop",
        "table-valued": "if-exists-drop",
        "tables": "if-not-exists",
        "triggers": "if-exists-drop",
        "views": "if-exists-drop",
        "table-valued-parameters": "if-not-exists";

    }
}

Development

For easy development, clone the repo and run the following commands in the sql-source-control directory:

npm install
npm link
npm run build