gopher

"use strict";
 
const Gopher = require('gopherdata');
 
//Assign Gardens (Gopher vernacular for Db Connection Configurations)
const GARDENS = ['./libraries/connection/finance-connections.json',
                     './libraries/connection/myDatabase-connections.json'];
/*******************************************************************************
                            Create a generic Gopher         
********************************************************************************/
 
  var runGopher = function(dbConnection,transactionName,callback){
 
    // Add Transaction Properties here:
    let transactionPlan = {transaction      : transactionName,
                           outputFormat     : 'array',
                           responseOutput   : ['dbResponse','metaData','metrics']};
 
    new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
      .run(transactionPlan,
        function(err,res){
          if (err)  {
            return callback(err,res);
          }
          return callback(err,res);
        }
      );
  }
/*******************************************************************************
                            Send Gopher on it's way
********************************************************************************/
 
 //get a production db table listing
  runGopher('finance-Prod','get-db-tables',
    function(gophErr, gophRes){
      if(gophErr){console.log(gophRes);}
    console.log(gophRes)
    }
  );
 
  //get a development db table listing
  runGopher('finance-Dev','get-db-tables',
    function(gophErr, gophRes){
      if(gophErr){console.log(gophRes);}
    console.log(gophRes)
    }
  );
 

 
"use strict";
 const Gopher = require('gopherdata');
 
 //Assign Gardens (Gopher vernacular for Db Connection Configurations)
 const GARDENS = ['./libraries/connection/myDatabase-connections.json',
                  './libraries/connection/corporate-connections.json',
                  './libraries/connection/finance-connections.json'];
/*******************************************************************************
   Create Different Gophers (i.e. a Gopher Schema) and Configure their     
   Transaction Properties                                                  
********************************************************************************/
 
  //--------------------Without Bind Variables--------------------
   exports.run = function(dbConnection,transactionName,callback){
     let transactionPlan = {transaction : transactionName};
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err)  {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //----------------------With Bind Variables---------------------
 
   exports.runWBindVariables = function(dbConnection,transactionName,bindVariables,callback){
 
     let transactionPlan = {
       transaction        : transactionName,
       bindVariables      : bindVariables
     };
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err)  {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //---------------------------Show SQL---------------------------
 
   exports.showSql = function(dbConnection,transactionName,callback){
 
     let transactionPlan = {
       transaction        : transactionName,
       responseOutput     : ['sqlOnly']
     };
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err) {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //---------------------------Verbose----------------------------
 
   exports.runVerbose = function(dbConnection,transactionName,callback){
 
     let transactionPlan = {
       transaction        : transactionName,
       responseOutput     : ['verbose']
     };
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err) {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //------------------------Get Db Tables-------------------------
 
   exports.getTables = function(dbConnection,callback){
 
     let transactionPlan = {transaction  : 'get-db-tables'};
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err) {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //------------------------Get Db Columns------------------------
 
   exports.getColumns = function(dbConnection,table,callback){
 
     let transactionPlan = {
       transaction    : 'get-db-table-columns',
       bindVariables  : {tableName:table}
     };
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err)  {return callback(err,res);}
           return callback(err,res);
         }
       );
   }
 
  //--------------------------Modifiable--------------------------
 
   exports.runModifiable = function(dbConnection,transactionPlan,callback){
 
     new Gopher({"connection":dbConnection,"connectionLibraries":GARDENS})
       .run(transactionPlan,
         function(err,res){
           if (err) {return callback(err,res);}
           return callback(err,res);
          }
        );
    }

 
"use strict";
const gopher = require('./gopher-schema.js');
let connection = '', // a named connection (configured from within a Connection Library)
    transaction = '', // a named transaction (i.e. a canned DDL/DML statement configured from within a Transaction Library)
    bindVariables = {}, // unique bind variables associated with a transaction (set/configured from within a Transaction Library)
    transactionPlan = {}; // a means by which to override a stored Transaction's default settings
 

 
    connection = 'finance-Dev';
    transaction = 'get-db-tables';
 
    gopher.run(connection,transaction,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-Prod';
    transaction = 'get-quarterly-report-2016';
    bindVariables = {
      storeID    : '1234',
      quarter    : 3
 
    };
 
    gopher.runWBindVariables(connection,transaction, bindVariables,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-Dev';
    transaction = 'get-quarterly-report-2016';
    bindVariables = {
      storeID    : '1234',
      quarter    : 3
    };     
 
    gopher.showSql(connection,transaction,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-Prod';
 
    gopher.getTables(connection,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-Prod';
    var table = 'quarterly_metrics';
 
    gopher.getColumns(connection,table,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-Prod';
    transaction = 'get-db-tables';
 
    gopher.runVerbose(connection,transaction,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );

 
    connection = 'finance-QA';
    transactionPlan = {
        transaction       :'get-quarterly-report-2016',
        bindVariables     :{
               storeID    : '1234',
               quarter    : 3
               }
        outputFormat      : 'object', // format used for the database output. choices are "array", "object", or "json". if not set/configured, the application default is "json"
       maxRowsReturned   : 200 ,// the number of rows returned from database output. if or not set/configured, the application default is 2000
       zeroRowMessage    : 'No information found for North America Region', // the message returned when nothing is returned. if not set/configured, the application default is "0 rows returned"
       responseOutput    : ['host','network','connection','dbStatement','error','dbResponse','metaData','metrics'], // use any of the following choices, or use ONLY one of the following special commands: "dataOnly", "sqlOnly", or "verbose". if not set/configured, the application default is "dataOnly"
       timeZone          : 'local'// sets the time zone for timestamps returned in the response output information (this will NOT modify times/dates/timestamps within the returned dataset)
    };
 
    gopher.runModifiable(connectTo,transactionPlan,
      function(gophErr, gophRes){
        if(gophErr){console.log(gophRes);}
        console.log(gophRes)
      }
    );