@hackthedev/dsync-sql 1.0.0 → 1.0.2

package/README.md

@@ -2,10 +2,6 @@
 
 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
@@ -20,9 +16,9 @@ export let db = new dSyncSql({
     user: "username",
     password: "some_password",
     database: "database_name",
-    waitForConnections: true,		// optional
-    connectionLimit: 10, 			// optional
-    queueLimit: 0,					// optional
+    waitForConnections: true, // optional
+    connectionLimit: 10, // optional
+    queueLimit: 0, // optional
 });
 ```
 
@@ -30,7 +26,11 @@ export let db = new dSyncSql({
 
 ## 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.
+The following is optional but dSyncSql was designed to automatically create the database structure to make deployment and updates smooth and automatic. 
+
+> [!CAUTION]
+>
+> The library wont create the database itself.
 
 ```js
 const tables = [

package/index.mjs

@@ -1,5 +1,8 @@
 import mysql from "mysql2/promise";
 import Logger from "@hackthedev/terminal-logger"
+import {serverconfig} from "../../dcts/index.mjs";
+import {spawn} from "node:child_process";
+import fs from "fs";
 
 export default class dSyncSql {
     constructor({
@@ -36,6 +39,24 @@ export default class dSyncSql {
         });
     }
 
+    async exportDatabase(outFile) {
+        if(!outFile) throw new Error('Output File path is required');
+        return await new Promise((resolve, reject) => {
+            const dump = spawn("mariadb-dump", [
+                "-h", this.host,
+                "-u", this.user,
+                `-p${this.password}`,
+                this.database
+            ]);
+
+            const stream = fs.createWriteStream(outFile);
+
+            dump.stdout.pipe(stream);
+            dump.stderr.on("data", d => reject(d.toString()));
+            dump.on("close", code => code === 0 ? resolve() : reject(code));
+        });
+    }
+
     async waitForConnection() {
         while (true) {
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hackthedev/dsync-sql",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "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": {