SQL Servant

A simple tool for running a configured SQL statements.

Getting Started

1. Clone from this repository.
2. Open your favorite IDE and import as Gradle project.

Prerequisites

Java 11

Installing

1. Ensure that you can connect to the internet. This is for downloading gradle and the dependencies.
2. Ensure that you are running Java 11.
   You can run the following command if you like to validate your java version:

java -version

1. Open a terminal and run the following command:

   gradlew

   The command above will download the correct version of gradle and the needed dependencies.

Running the tests

On a terminal, run the following command:

gradlew test

The output can be found in following directory:

build/reports/tests/test directory.

Packaging

On a terminal, run the following command:

gradlew packAll

The output can be found in the following directory:

build/pack directory. 

Deployment

1. Extract one of the generated package to your desired directory.
2. From this directory you can now try to execute the following command.

sqlsrvnt -v 

The command above will give you the current version.

Configuration

The configuration files to be used must be in the conf directory of where you extracted a package.
This directory contains ss-h2-sample.json as a sample configuration. The content of it is as follows:

{
  "defaults": {
    "jdbcDriver" : "org.h2.Driver",
    "connectionString": "jdbc:h2:./db/test1"
  },
  "dbPoolConfig" : {
    "minIdle": 5,
    "maxIdle": 10,
    "maxOpenPreparedStatements" : 100
  },
  "params" : [
    {
      "name": "name",
      "description": "Name suffix"
    }
  ],
  "queries": [
    {
      "queries": [
        "CREATE TABLE PERSON(id int primary key, name varchar(255))",
        "insert into person (id, name) values (1, 'test1 \"name')",
        "insert into person (id, name) values (2, 'test2 name')"
      ],
      "next" : {
        "mode" : "script",
        "queries" : ["sample-h2-script.txt"],
        "next" : {
          "mode" : "sqs",
          "description" : "Sample Single Query Script",
          "queries" : ["sample-h2-query-script.txt"]
        }
      }
    },
    {
      "queries" : ["select * from person where name like '%%%%name%%%'"],
      "mode" : "query"
    },
    {
      "queries": ["CREATE TABLE PERSON(id int primary key, name varchar(255))"],
      "next" : {
        "queries": [
          "insert into person (id, name) values (1, 'test1 name')",
          "insert into person (id, name) values (2, 'test2 name')"
        ],
        "next" : {
          "queries" : ["select * from person"],
          "mode" : "query"
        }
      },
      "connectionString": "jdbc:h2:./db/test2",
      "parallel" : true
    },
    {
      "listeners": {
        "filter" : "\"",
        "onStart" : "sample-h2-start.bat",
        "onHeader" : "sample-h2-data.bat",
        "onData" : "sample-h2-data.bat",
        "onComplete": "sample-h2-complete.bat"
      },
      "parallel": true,
      "queries": ["CREATE TABLE PERSON(id int primary key, name varchar(255))"],
      "next" : {
        "queries": [
          "insert into person (id, name) values (1, 'test1 name')",
          "insert into person (id, name) values (2, 'test2 name')"
        ],
        "next" : {
          "queries" : ["select * from person"],
          "mode" : "query"
        }
      },
      "connectionString": "jdbc:h2:./db/test3",
      "parallel" : true
    }
  ]
}

There are 4 sections in the configuration file.

defaults Section

ListenersConfig Type

Note: If the ListenersConfig was configured, the queries section that has it won't be executed in parallel.

queries Section

dbPoolConfig Section

params Section

Environment Variables

SQL_SERVANT_CONF_DIR Environment Variable

Set the SQL_SERVANT_CONF_DIR environment variable to have a different location for the following configuration folders:
- conf
- listeners
- scripts

Note: This environment variable can be overridden by the -cd command line argument.

SS2_JAVA_HOME Environment Variable

If the existing JAVA_HOME or the java executable in not the supported version. Set the SS2_JAVA_HOME to the correct java version.

Usage

To know the usage, execute the following on a terminal:

sqlsrvnt -h 

To run a particular configuration (e.g. ss-h2-sample.json), execute the following command (i.e. only the filename must be specified without the extension):

sqlsrvnt -c ss-h2-sample

To run a particular configuration (e.g. ss-h2-sample.json) without executing it, execute the following command:

sqlsrvnt -n -c ss-h2-sample

To run a particular configuration with parameters (e.g. ss-h2-sample.json), execute the following command:

sqlsrvnt -c ss-h2-sample -P name="test"

To run a particular configuration (e.g. ss-h2-sample.json) in parallel overriding the one in configuration, execute the following command:

sqlsrvnt -p -c ss-h2-sample

To run a particular configuration on a particular environment (e.g. ss-h2-sample.test.json), execute the following command:

sqlsrvnt -e test -c ss-h2-sample

To know the current version, execute the following command:

sqlsrvnt -v

Built With

• Gradle - Dependency Management
• Maven - Dependency Repository
• Groovy - Coding Language

Author

• Ronaldo Webb

License

This project is licensed under the MIT License - see the LICENSE.md file for details