Overview
========


Requirements
============

* JRuby (ideally through RVM)
* manual install of jruby-openssl gem: `rvm use jruby; gem install jruby-openssl gem`


Usage
=====

    kvm --help
    
    Tasks:
      kvm checkout <relative repo> [path]                                        ...
      kvm config                                                                 ...
      kvm create-user <db options> <username> <password>                         ...
      kvm def <db options with alias>                                            ...
      kvm drop-user <username>                                                   ...
      kvm fetch <project>-<version>[-dist]                                       ...
      kvm generate-datasets <project>-<version> [-d dataset1,dataset2] [-t oracle...
      kvm get <project>-<version>[-dist]                                         ...
      kvm help [TASK]                                                            ...
      kvm install-dataset <db options> <project>-<version> dataset [type]        ...
      kvm install-testtables <db options> <project>-<version> [type]             ...
      kvm list                                                                   ...
      kvm list-datasets                                                          ...
      kvm run-sql file <db options>                                              ...
      kvm undef <alias>                                                          ...
      kvm update <relative repo> [path]                                          ...

To generate dataset SQL:

    kvm generate-datasets rice-1.0.3.1

To install SQL:

    kvm install-dataset --url jdbc:oracle:thin:@localhost:1521:xe --username rice_test --password rice_test rice-1.0.3.1 bootstrap-server oracle

Database Arguments
==================

Several commands take database connection arguments.  A database connection consists of:

* jdbc url
* username
* password
* type (oracle or mysql)

There are two provisions for specifying these components, either directly, or via the `--db` options hash, and the two styles can be mixed.

Directly: `--url jdbc:oracle:thin:@127.0.0.1:1521:xe --username user --password password --type oracle`

Options hash: `--url jdbc:oracle:thin:@127.0.0.1:1521:xe --db username:user password:password type:oracle`

Two other options are also available:

* alias
* jar

If you have defined a db alias (via `define-db` command) then you can simply use the `--alias mydb` option to refer to the predefined db alias.  This will save repetition.

Some commands also require the JDBC driver jar to be specified.  This can be done via the `--jar /path/to/ojdbc14.jar` option.

Improvements
============

* better command documentation
* better effort at automatically locating jdbc driver jars, and saving with db aliases
* secure wallet functionality is sort of lame, it would be nice to take advantage of native keychain functionality if it exists