ags-sql-gen 1.0.3 → 1.0.4

package/README.md

@@ -3,6 +3,8 @@
 
 AGS is a lightweight Node.js MySQL helper library that simplifies database operations such as **SELECT**, **INSERT**, **UPDATE**, **DELETE**, and **JOIN** queries.  
 It also includes a fun bonus function: `getDadJokes()` — because debugging is better with a laugh. 😄
+`AGS-SQL-Template` is a ready-to-use SQL helper class designed for developers who frequently interact with MySQL databases in Node.js.  
+It provides easy methods for `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `JOIN`, and aggregation queries (`SUM`, `MIN`, `MAX`, `AVG`) without needing to manually write long SQL statements every time.
 
 
 ## 🚀 Features
@@ -27,7 +29,7 @@ npm install mysql2
 ```js
 import AGS from "ags-sql-lib";
 
-const sql = new AGS("root", "password", "localhost", "my_database");
+const sql = new AGS.connect("root", "password", "localhost", "my_database");
 ```
 ### select
 Select all columns
@@ -95,6 +97,27 @@ const result = await sql.selectInnerJoin(
   "tblusers.id = tblorders.user_id"
 );
 ```
+### Aggregation queries
+
+```js
+Calculate the total of all 'grade' values in one table
+const totalGrades = await sql.sum("grade", "tbl_grades");
+
+Get the lowest grade
+const lowestGrade = await sql.min("grade", "tbl_grades");
+
+Get the highest grade
+const highestGrade = await sql.max("grade", "tbl_grades");
+
+Get the average grade
+const averageGrade = await sql.avg("grade", "tbl_grades");
+
+multiple tables
+const totalResults = await db.sum("amount", ["tbl_sales", "tbl_purchases"]);
+const minResults = await db.min("score", ["tbl_quiz1", "tbl_quiz2"]);
+const maxResults = await db.max("salary", ["tbl_teachers", "tbl_admin"]);
+const avgResults = await db.avg("grade", ["tbl_midterm", "tbl_final"]);
+```
 ### BONUS
 ```js
 import { getDadJokes } from "ags-sql-lib";

package/connection.js

@@ -1,6 +1,6 @@
-const connection = require("./database/dbConnection");
+import connection from "./database/dbConnection.js";
 
-module.exports = class {
+export default class {
     #sqlOperation;
 
     constructor(user, password, host, database) {
@@ -18,7 +18,6 @@ module.exports = class {
         }
         return result;
       }
-
       const sql = `SELECT ${columnName || "*"} FROM ${tableName}`;
       const [result] = await this.#sqlOperation.query(sql);
       return result;
@@ -139,4 +138,80 @@ module.exports = class {
     console.log(error);
    }
   }
+
+  async sum(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT SUM(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT SUM(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async max(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT MAX(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT MAX(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async min(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT MIN(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT MIN(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
+
+  async avg(columnName, tableName){
+    try {
+      if(Array.isArray(tableName)){
+        let result = [];
+        for(let i in tableName){
+          const sql = `SELECT AVG(${columnName}) FROM ${tableName[i]}`;
+          const [selectResult] = await this.#sqlOperation.query(sql);
+          result.push(selectResult);
+        }
+        return result;
+      }
+      const sql = `SELECT AVG(${columnName}) FROM ${tableName}`;
+      const [result] = await this.#sqlOperation.query(sql);
+      return result;
+    } catch (error) {
+      console.log(error);
+    }
+  }
 };

package/database/dbConnection.js

@@ -1,6 +1,6 @@
-const mysql = require("mysql2");
+import mysql from "mysql2";
 
-module.exports = (user, password, host, database) => {
+export default (user, password, host, database) => {
   const dbConnection = mysql
     .createPool({
       user: user,

package/getJokes.js

@@ -1,6 +1,6 @@
-const { exec } = require("child_process");
+import { exec } from "child_process";
 
-module.exports = async () => {
+export default async () => {
   return new Promise((resolve, reject) => {
     try {
       exec("curl https://icanhazdadjoke.com", (error, stdout, stderr) => {

package/index.js

@@ -1,4 +1,7 @@
-module.exports = {
-  connect: require("./connection"),
-  getJokes: require("./getJokes")
-};
+import connect from "./connection.js";
+import getJokes from "./getJokes.js";
+
+export default {
+  connect,
+  getJokes
+};

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "ags-sql-gen",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "lightweight Node.js MySQL helper library",
   "main": "index.js",
-  "type": "commonjs",
+  "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },