Initial commit

Author: BrandonRomano

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brandon Romano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

ash_config.yaml

@@ -0,0 +1,3 @@
+name: SQL
+package: github.com/ash-shell/sql
+default_alias: sql

lib/drivers/interface.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+# This file is a blank interface that all sql drivers must adhere to.
+#
+# Some of these methods in this actual interface have error messages,
+# as this interface is actually imported before any specific driver is
+# loaded.
+#
+# When creating a driver, you must override all methods here.
+
+#################################################
+# Executes a database statement and outputs the
+# result as a space delimited string of columns.
+#
+# @param $1: The statement to be executed
+#################################################
+Sql__execute() {
+    Logger__error "No sql driver selected, must call 'Sql__open' before calling 'Sql__execute'"
+}
+
+#################################################
+# Here is an opportunity to provide any driver
+# specific logic for when the database is opened.
+#################################################
+Sql_driver_open() {
+    :
+}
+
+#################################################
+# Here is an opportunity to provide any driver
+# specific logic for when the database is closed.
+#################################################
+Sql_driver_close() {
+    :
+}

lib/drivers/mysql.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+# Temporary config file location
+Sql_MYSQL_CONFIG_FILE="/tmp/ash_sql_mysql_config.cnf"
+
+#################################################
+# Executes a database statement and
+# gives the output
+#
+# @param $1: the statement to be executed
+#################################################
+Sql__execute() {
+    "$SQL_MYSQL_PATH" \
+        --defaults-extra-file="$Sql_MYSQL_CONFIG_FILE" \
+        --database="$SQL_DATABASE_NAME" \
+        --silent \
+        --skip-column-names \
+        --batch \
+        --execute="$1"
+}
+
+#################################################
+# Generates the MySQL config file to be used
+#################################################
+Sql_driver_open() {
+    # Deleting old mysql config file if it existed
+    if [[ -e "$Sql_MYSQL_CONFIG_FILE" ]]; then
+        rm "$Sql_MYSQL_CONFIG_FILE"
+    fi
+
+    # Creating new MySQL config file
+    touch "$Sql_MYSQL_CONFIG_FILE"
+    chmod 600 "$Sql_MYSQL_CONFIG_FILE"
+
+    echo "[client]" >> "$Sql_MYSQL_CONFIG_FILE"
+    echo "user = $SQL_USER" >> "$Sql_MYSQL_CONFIG_FILE"
+    echo "password = $SQL_PASSWORD" >> "$Sql_MYSQL_CONFIG_FILE"
+    echo "host = $SQL_HOST" >> "$Sql_MYSQL_CONFIG_FILE"
+    echo "port = $SQL_PORT" >> "$Sql_MYSQL_CONFIG_FILE"
+}
+
+#################################################
+# Deletes the temporary database config file
+#################################################
+Sql_driver_close() {
+    # Deleting old mysql config file if it existed
+    if [[ -e "$Sql_MYSQL_CONFIG_FILE" ]]; then
+        rm "$Sql_MYSQL_CONFIG_FILE"
+    fi
+}

lib/drivers/postgres.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+#################################################
+# Executes a database statement and
+# gives the output
+#
+# @param $1: The statement to be executed
+#################################################
+Sql__execute() {
+    output=$("$SQL_POSTGRES_PATH" \
+        --username "$SQL_USER" \
+        --dbname "$SQL_DATABASE_NAME" \
+        --host "$SQL_HOST" \
+        --command "$1" \
+        --no-align \
+        --field-separator="	" \
+        --record-separator="\r\n" \
+        --tuples-only 2>&1)
+    result="$?"
+    printf "$output"
+    return $result
+}
+
+#################################################
+# Do nothing, no driver specific setup
+#################################################
+Sql_driver_open() {
+    :
+}
+
+#################################################
+# Do nothing, no driver specific shutdown
+#################################################
+Sql_driver_close() {
+    :
+}

lib/sql.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+Sql__PACKAGE_LOCATION="$(Ash__find_module_directory "github.com/ash-shell/sql")"
+Sql__DRIVER_MYSQL='mysql'
+Sql__DRIVER_POSTGRES='postgres'
+
+# Load the interface for appropriate non loaded messages
+. "$Sql__PACKAGE_LOCATION/lib/drivers/interface.sh"
+
+#################################################
+# Loads the appropriate database driver handles
+# all other setup operations
+#
+# @param $1: The driver to setup
+#################################################
+Sql__open() {
+    local driver="$1"
+    if [[ "$driver" = "" ]]; then
+        Logger__error "Sql__open must be passed a database driver name"
+    fi
+
+    # Loading the appropriate database driver
+    if [[ "$driver" = "$Sql__DRIVER_MYSQL" ]]; then
+        . "$Sql__PACKAGE_LOCATION/lib/drivers/mysql.sh"
+    elif [[ "$driver" = "$Sql__DRIVER_POSTGRES" ]]; then
+        . "$Sql__PACKAGE_LOCATION/lib/drivers/postgres.sh"
+    else
+        Logger__error "Invalid sql driver name '$driver'"
+        return
+    fi
+
+    # Run any driver specific logic
+    Sql_driver_open
+}
+
+#################################################
+# Shuts down the database
+#################################################
+Sql__close() {
+    Sql_driver_close
+}