@hackthedev/dsync-sql 1.0.0

package/README.md

@@ -0,0 +1,82 @@
+# dSyncSql
+
+dSyncSql is supposed to be a helper for handling MySQL / MariaDB connections and executing queries. In addition it will also allow you to automatically create a database's structure like tables, column and such and will automatically create missing columns and tables based off a json Object.
+
+> [!IMPORTANT]
+>
+> This readme is still work in progress and examples and all will come once done.
+
+------
+
+## Connection setup
+
+The library was made with the intent to always create a connection pool.
+
+```js
+import dSyncSql from "@hackthedev/dsync-sql"
+
+export let db = new dSyncSql({
+    host: "127.0.0.1",
+    user: "username",
+    password: "some_password",
+    database: "database_name",
+    waitForConnections: true,		// optional
+    connectionLimit: 10, 			// optional
+    queueLimit: 0,					// optional
+});
+```
+
+------
+
+## Defining a database
+
+The following is optional but dSyncSql was designed to automatically create the database structure to make deployment and updates smooth and automatic.
+
+```js
+const tables = [
+    {
+        name: "network_servers",
+        columns: [
+            {name: "id", type: "int(11) NOT NULL"},
+            {name: "address", type: "varchar(255) NOT NULL"},
+            {name: "status", type: "varchar(255) NOT NULL"},
+            {name: "data", type: "longtext"},
+            {name: "last_sync", type: "datetime NULL"},
+        ],
+        keys: [
+            {name: "PRIMARY KEY", type: "(id)"},
+            {name: "UNIQUE KEY", type: "address (address)"},
+        ],
+        autoIncrement: "id int(11) NOT NULL AUTO_INCREMENT",
+    }
+]
+```
+
+You could then loop through the tables object and create the tables and columns automatically using `checkAndCreateTable`.
+
+```js
+for (const table of tables) {
+    await db.checkAndCreateTable(table);
+}
+```
+
+------
+
+## Running Queries
+
+You can also run manual queries to your heart's desire using `queryDatabase`. The function also handles `ER_LOCK_DEADLOCK` errors and will retry to execute a statement 3 times on default
+
+```js
+await db.queryDatabase(
+    "SELECT * FROM network_servers WHERE stats = ?", 
+    ["verified"]
+);
+
+// with custom retry counter
+await db.queryDatabase(
+    "SELECT * FROM network_servers WHERE stats = ?", 
+    ["verified"], 
+    10
+);
+```
+

package/bun.lock

@@ -0,0 +1,72 @@
+{
+  "lockfileVersion": 1,
+  "configVersion": 0,
+  "workspaces": {
+    "": {
+      "dependencies": {
+        "@hackthedev/terminal-logger": "^1.0.0",
+        "mysql2": "^3.16.0",
+        "mysql2-promise": "^0.1.4",
+      },
+    },
+  },
+  "packages": {
+    "@hackthedev/terminal-logger": ["@hackthedev/terminal-logger@1.0.0", "", {}, "sha512-n2SiSpJXCCbFJwgyzR94aDkgelTsK0CG7Ruh6W0n05D5oAm8wZz8F1+0SCJISf2L0/lhTD39zeNxGRVYse8EKA=="],
+
+    "ansicolors": ["ansicolors@0.2.1", "", {}, "sha512-tOIuy1/SK/dr94ZA0ckDohKXNeBNqZ4us6PjMVLs5h1w2GBB6uPtOknp2+VF4F/zcy9LI70W+Z+pE2Soajky1w=="],
+
+    "aws-ssl-profiles": ["aws-ssl-profiles@1.1.2", "", {}, "sha512-NZKeq9AfyQvEeNlN0zSYAaWrmBffJh3IELMZfRpJVWgrpEbtEpnjvzqBPf+mxoI287JohRDoa+/nsfqqiZmF6g=="],
+
+    "bn.js": ["bn.js@2.0.0", "", {}, "sha512-NmOLApC80+n+P28y06yHgwGlOCkq/X4jRh5s590959FZXSrM+I/61h0xxuIaYsg0mD44mEAZYG/rnclWuRoz+A=="],
+
+    "cardinal": ["cardinal@0.4.4", "", { "dependencies": { "ansicolors": "~0.2.1", "redeyed": "~0.4.0" }, "bin": { "cdl": "bin/cdl.js" } }, "sha512-3MxV0o9wOpQcobrcSrRpaSxlYkohCcZu0ytOjJUww/Yo/223q4Ecloo7odT+M0SI5kPgb1JhvSaF4EEuVXOLAQ=="],
+
+    "core-util-is": ["core-util-is@1.0.3", "", {}, "sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ=="],
+
+    "denque": ["denque@2.1.0", "", {}, "sha512-HVQE3AAb/pxF8fQAoiqpvg9i3evqug3hoiwakOyZAwJm+6vZehbkYXZ0l4JxS+I3QxM97v5aaRNhj8v5oBhekw=="],
+
+    "double-ended-queue": ["double-ended-queue@2.0.0-0", "", {}, "sha512-t5ouWOpItmHrm0J0+bX/cFrIjBFWnJkk5LbIJq6bbU/M4aLX2c3LrM4QYsBptwvlPe3WzdpQefQ0v1pe/A5wjg=="],
+
+    "esprima": ["esprima@1.0.4", "", { "bin": { "esparse": "bin/esparse.js", "esvalidate": "bin/esvalidate.js" } }, "sha512-rp5dMKN8zEs9dfi9g0X1ClLmV//WRyk/R15mppFNICIFRG5P92VP7Z04p8pk++gABo9W2tY+kHyu6P1mEHgmTA=="],
+
+    "generate-function": ["generate-function@2.3.1", "", { "dependencies": { "is-property": "^1.0.2" } }, "sha512-eeB5GfMNeevm/GRYq20ShmsaGcmI81kIX2K9XQx5miC8KdHaC6Jm0qQ8ZNeGOi7wYB8OsdxKs+Y2oVuTFuVwKQ=="],
+
+    "iconv-lite": ["iconv-lite@0.7.2", "", { "dependencies": { "safer-buffer": ">= 2.1.2 < 3.0.0" } }, "sha512-im9DjEDQ55s9fL4EYzOAv0yMqmMBSZp6G0VvFyTMPKWxiSBHUj9NW/qqLmXUwXrrM7AvqSlTCfvqRb0cM8yYqw=="],
+
+    "inherits": ["inherits@2.0.4", "", {}, "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="],
+
+    "is-property": ["is-property@1.0.2", "", {}, "sha512-Ks/IoX00TtClbGQr4TWXemAnktAQvYB7HzcCxDGqEZU6oCmb2INHuOoKxbtR+HFkmYWBKv/dOZtGRiAjDhj92g=="],
+
+    "isarray": ["isarray@0.0.1", "", {}, "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ=="],
+
+    "long": ["long@5.3.2", "", {}, "sha512-mNAgZ1GmyNhD7AuqnTG3/VQ26o760+ZYBPKjPvugO8+nLbYfX6TVpJPseBvopbdY+qpZ/lKUnmEc1LeZYS3QAA=="],
+
+    "lru-cache": ["lru-cache@2.5.0", "", {}, "sha512-dVmQmXPBlTgFw77hm60ud//l2bCuDKkqC2on1EBoM7s9Urm9IQDrnujwZ93NFnAq0dVZ0HBXTS7PwEG+YE7+EQ=="],
+
+    "lru.min": ["lru.min@1.1.3", "", {}, "sha512-Lkk/vx6ak3rYkRR0Nhu4lFUT2VDnQSxBe8Hbl7f36358p6ow8Bnvr8lrLt98H8J1aGxfhbX4Fs5tYg2+FTwr5Q=="],
+
+    "mysql2": ["mysql2@3.16.0", "", { "dependencies": { "aws-ssl-profiles": "^1.1.1", "denque": "^2.1.0", "generate-function": "^2.3.1", "iconv-lite": "^0.7.0", "long": "^5.2.1", "lru.min": "^1.0.0", "named-placeholders": "^1.1.3", "seq-queue": "^0.0.5", "sqlstring": "^2.3.2" } }, "sha512-AEGW7QLLSuSnjCS4pk3EIqOmogegmze9h8EyrndavUQnIUcfkVal/sK7QznE+a3bc6rzPbAiui9Jcb+96tPwYA=="],
+
+    "mysql2-promise": ["mysql2-promise@0.1.4", "", { "dependencies": { "mysql2": "^0.15.7", "q": "^1.3.0" } }, "sha512-/h8ubU/36aIPpbfB6CENw9ZdbzIhZMZOIbstJUHVKp4J9JBRSLScrYImVx+3yZilgag732UhpQMMK5+ktdhLCw=="],
+
+    "named-placeholders": ["named-placeholders@1.1.6", "", { "dependencies": { "lru.min": "^1.1.0" } }, "sha512-Tz09sEL2EEuv5fFowm419c1+a/jSMiBjI9gHxVLrVdbUkkNUUfjsVYs9pVZu5oCon/kmRh9TfLEObFtkVxmY0w=="],
+
+    "q": ["q@1.5.1", "", {}, "sha512-kV/CThkXo6xyFEZUugw/+pIOywXcDbFYgSct5cT3gqlbkBE1SJdwy6UQoZvodiWF/ckQLZyDE/Bu1M6gVu5lVw=="],
+
+    "readable-stream": ["readable-stream@1.0.33", "", { "dependencies": { "core-util-is": "~1.0.0", "inherits": "~2.0.1", "isarray": "0.0.1", "string_decoder": "~0.10.x" } }, "sha512-72KxhcKi8bAvHP/cyyWSP+ODS5ef0DIRs0OzrhGXw31q41f19aoELCbvd42FjhpyEDxQMRiiC5rq9rfE5PzTqg=="],
+
+    "redeyed": ["redeyed@0.4.4", "", { "dependencies": { "esprima": "~1.0.4" } }, "sha512-pnk1vsaNLu1UAAClKsImKz9HjBvg9i8cbRqTRzJbiCjGF0fZSMqpdcA5W3juO3c4etFvTrabECkq9wjC45ZyxA=="],
+
+    "safer-buffer": ["safer-buffer@2.1.2", "", {}, "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg=="],
+
+    "seq-queue": ["seq-queue@0.0.5", "", {}, "sha512-hr3Wtp/GZIc/6DAGPDcV4/9WoZhjrkXsi5B/07QgX8tsdc6ilr7BFM6PM6rbdAX1kFSDYeZGLipIZZKyQP0O5Q=="],
+
+    "sqlstring": ["sqlstring@2.3.3", "", {}, "sha512-qC9iz2FlN7DQl3+wjwn3802RTyjCx7sDvfQEXchwa6CWOx07/WVfh91gBmQ9fahw8snwGEWU3xGzOt4tFyHLxg=="],
+
+    "string_decoder": ["string_decoder@0.10.31", "", {}, "sha512-ev2QzSzWPYmy9GuqfIVildA4OdcGLeFZQrq5ys6RtiuF+RQQiZWr8TZNyAcuVXyQRYfEO+MsoB/1BuQVhOJuoQ=="],
+
+    "mysql2-promise/mysql2": ["mysql2@0.15.8", "", { "dependencies": { "bn.js": "2.0.0", "cardinal": "0.4.4", "double-ended-queue": "2.0.0-0", "named-placeholders": "0.1.3", "readable-stream": "1.0.33" } }, "sha512-3x5o6C20bfwJYPSoT74MOoad7/chJoq4qXHDL5VAuRBBrIyErovLoj04Dz/5EY9X2kTxWSGNiTegtxpROTd2YQ=="],
+
+    "mysql2-promise/mysql2/named-placeholders": ["named-placeholders@0.1.3", "", { "dependencies": { "lru-cache": "2.5.0" } }, "sha512-Mt79RtxZ6MYTIEemPGv/YDKpbuavcAyGHb0r37xB2mnE5jej3uBzc4+nzOeoZ4nZiii1M32URKt9IjkSTZAmTA=="],
+  }
+}

package/index.mjs

@@ -0,0 +1,192 @@
+import mysql from "mysql2/promise";
+import Logger from "@hackthedev/terminal-logger"
+
+export default class dSyncSql {
+    constructor({
+                    host,
+                    user,
+                    password,
+                    database,
+                    waitForConnections = true,
+                    connectionLimit = 10,
+                    queueLimit = 0,
+                }) {
+
+        if(!host) throw new Error('host address is required');
+        if(!user) throw new Error('username is required');
+        if(!password) throw new Error('password is required');
+        if(!database) throw new Error('database is required');
+
+        this.connection_info = {host, user, password, database};
+
+        this.pool = mysql.createPool({
+            host,
+            user,
+            password,
+            database,
+            waitForConnections,
+            connectionLimit,
+            queueLimit: 0,
+            typeCast: function (field, next) {
+                if (field.type === "TINY" && field.length === 1) {
+                    return field.string() === "1";
+                }
+                return next();
+            },
+        });
+    }
+
+    async waitForConnection() {
+        while (true) {
+            try {
+                let conn = await this.pool.getConnection();
+                await conn.ping();
+                conn.release();
+                return;
+            } catch {
+                await new Promise((r) => setTimeout(r, 1000));
+            }
+        }
+    }
+
+    async queryDatabase(query, params, retryCount = 3) {
+        let connection;
+
+        try {
+            connection = await this.pool.getConnection();
+            const [results,] = await connection.execute(query, params);
+            return results;
+        } catch (err) {
+            if (err.code === 'ER_LOCK_DEADLOCK' && retryCount > 0) {
+                Logger.warn('Deadlock detected, retrying transaction...', retryCount);
+                // wait for a short period before retrying
+                await new Promise(resolve => setTimeout(resolve, 100));
+                return this.queryDatabase(query, params, retryCount - 1);
+            } else {
+                Logger.error('SQL Error executing query:');
+                Logger.error(err);
+                throw err;
+            }
+        } finally {
+            if (connection) connection.release();
+        }
+    }
+
+    async checkAndCreateTable(table) {
+        const query = `
+            SELECT COUNT(*)
+            FROM information_schema.tables
+            WHERE table_schema = ?
+              AND table_name = ?
+        `;
+
+        try {
+            const results = await this.queryDatabase(query, [this.connection_info.database, table.name]);
+            const tableExists = results[0]['COUNT(*)'] > 0;
+
+            if (tableExists) {
+                await this.checkAndCreateColumns(table);
+            } else {
+                await this.createTable(table);
+            }
+        } catch (err) {
+            Logger.error('Error in checkAndCreateTable:', err);
+        }
+    }
+
+    async checkAndCreateColumns(table) {
+        const query = `
+            SELECT COLUMN_NAME, IS_NULLABLE, COLUMN_TYPE, COLUMN_DEFAULT
+            FROM information_schema.columns
+            WHERE table_schema = ?
+              AND table_name = ?
+        `;
+
+        try {
+            const results = await this.queryDatabase(query, [this.connection_info.database, table.name]);
+            const existingColumns = results.map(row => row.COLUMN_NAME);
+            const missingColumns = table.columns.filter(col => !existingColumns.includes(col.name));
+
+            if (missingColumns.length > 0) {
+                console.log(`Adding missing columns to table "${table.name}":`, missingColumns);
+                await this.addMissingColumns(table.name, missingColumns);
+            } else {
+                //console.log(`All columns in table "${table.name}" are up to date.`);
+            }
+        } catch (err) {
+            Logger.error('Error in checkAndCreateColumns:', err);
+        }
+    }
+
+    async createTable(table) {
+        const columnsDefinition = table.columns.map(col => `${col.name} ${col.type}`).join(', ');
+        const createTableQuery = mysql.format(
+            `
+                CREATE TABLE ??
+                (
+                    ${columnsDefinition}
+                ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE =utf8mb4_general_ci
+            `,
+            [table.name]
+        );
+
+        try {
+            console.log('Executing CREATE TABLE query:', createTableQuery);
+            await this.queryDatabase(createTableQuery);
+
+            console.log(`Table "${table.name}" created successfully.`);
+            if (table.keys) {
+                await this.addKeys(table);
+            }
+            if (table.autoIncrement) {
+                await this.addAutoIncrement(table);
+            }
+        } catch (err) {
+            Logger.error('Error in createTable:', err);
+        }
+    }
+
+    async addMissingColumns(tableName, columns) {
+        const alter = columns
+            .map(col => `ADD COLUMN ${col.name} ${col.type}`)
+            .join(", ");
+
+        const query = mysql.format(
+            `ALTER TABLE ?? ${alter}`,
+            [tableName]
+        );
+
+        await this.queryDatabase(query);
+    }
+
+
+    async addKeys(table) {
+        const keysQueries = table.keys.map(key => `ADD ${key.name} ${key.type}`).join(', ');
+        const keysQuery = mysql.format(
+            `ALTER TABLE ?? ${keysQueries}`,
+            [table.name]
+        );
+
+        try {
+            console.log('Executing ADD KEYS query:', keysQuery);
+            await this.queryDatabase(keysQuery);
+        } catch (err) {
+            Logger.error('Error in addKeys:', err);
+        }
+    }
+
+
+    async addAutoIncrement(table) {
+        const autoIncrementQuery = mysql.format(
+            `ALTER TABLE ?? MODIFY ${table.autoIncrement}`,
+            [table.name]
+        );
+
+        try {
+            console.log('Executing AUTO_INCREMENT query:', autoIncrementQuery);
+            await this.queryDatabase(autoIncrementQuery);
+        } catch (err) {
+            Logger.error('Error in addAutoIncrement:', err);
+        }
+    }
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@hackthedev/dsync-sql",
+  "version": "1.0.0",
+  "description": "dSyncSql is supposed to be a helper for handling MySQL / MariaDB connections and executing queries. In addition it will also allow you to automatically create a database's structure like tables, column and such and will automatically create missing columns and tables based off a json Object.",
+  "homepage": "https://github.com/NETWORK-Z-Dev/dSyncSql#readme",
+  "bugs": {
+    "url": "https://github.com/NETWORK-Z-Dev/dSyncSql/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NETWORK-Z-Dev/dSyncSql.git"
+  },
+  "license": "ISC",
+  "author": "",
+  "main": "index.mjs",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@hackthedev/terminal-logger": "^1.0.0",
+    "mysql2": "^3.16.0",
+    "mysql2-promise": "^0.1.4"
+  },
+  "devDependencies": {}
+}