multi-db-orm 3.0.9 → 3.0.11

package/README.md

@@ -258,3 +258,17 @@ Working on enhancing the tool with below features in progress. Feel free to cont
 - [x] Range Operations like `>=` `<=`
 - [ ] Aggregations
 - [ ] InsertMany
+
+## Notes
+
+### Firebase
+
+Please create the indexes as well:
+
+https://console.firebase.google.com/u/0/project/<<PROJECT>>/firestore/databases/-default-/indexes?create_composite=ClBwcm9qZWN0cy9zZW1pYml0bWVkaWEvZGF0YWJhc2VzLyhkZWZhdWx0KS9jb2xsZWN0aW9uR3JvdXBzL3BzX3BpcGVsYW5lL2luZGV4ZXMvXxABGgoKBmFjdGl2ZRACGhQKEHVwZGF0ZWRUaW1lc3RhbXAQAhoMCghfX25hbWVfXxAC
+
+https://console.firebase.google.com/u/0/project/<<PROJECT>>/firestore/databases/-default-/indexes?create_composite=ClVwcm9qZWN0cy9zZW1pYml0bWVkaWEvZGF0YWJhc2VzLyhkZWZhdWx0KS9jb2xsZWN0aW9uR3JvdXBzL3BzX3BpcGVsYW5lX3Rhc2svaW5kZXhlcy9fEAEaEAoMcGlwZWxhbmVOYW1lEAEaCAoEc3RlcBABGgwKCF9fbmFtZV9fEAE
+
+https://console.firebase.google.com/u/0/project/<<PROJECT>>/firestore/databases/-default-/indexes?create_composite=ClVwcm9qZWN0cy9zZW1pYml0bWVkaWEvZGF0YWJhc2VzLyhkZWZhdWx0KS9jb2xsZWN0aW9uR3JvdXBzL3BzX3BpcGVsYW5lX2V4ZWMvaW5kZXhlcy9fEAEaCAoEbmFtZRABGg0KCXN0YXJ0VGltZRACGgwKCF9fbmFtZV9fEAI
+
+https://console.firebase.google.com/u/0/project/<<PROJECT>>/firestore/databases/-default-/indexes?create_composite=Clpwcm9qZWN0cy9zZW1pYml0bWVkaWEvZGF0YWJhc2VzLyhkZWZhdWx0KS9jb2xsZWN0aW9uR3JvdXBzL3BzX3BpcGVsYW5lX3Rhc2tfZXhlYy9pbmRleGVzL18QARoQCgxwaXBlbGFuZUV4SWQQARoNCglzdGFydFRpbWUQARoMCghfX25hbWVfXxAB

package/engines/firestoredb.js

@@ -1,230 +1,227 @@
 const { MultiDbORM } = require("./multidb");
 
 function replaceUndefinedWithNull(obj) {
-    try {
-
-        for (let key in obj) {
-            if (obj.hasOwnProperty(key)) {
-                if (typeof obj[key] === 'object' && obj[key] !== null) {
-                    replaceUndefinedWithNull(obj[key]);
-                } else if (typeof obj[key] === 'undefined') {
-                    obj[key] = null;
-                }
-            }
+  try {
+    for (let key in obj) {
+      if (obj.hasOwnProperty(key)) {
+        if (typeof obj[key] === "object" && obj[key] !== null) {
+          replaceUndefinedWithNull(obj[key]);
+        } else if (typeof obj[key] === "undefined") {
+          obj[key] = null;
         }
-    } catch (e) {
-        console.log('Error in sanitizing object before insert/update ! ', e.message)
+      }
     }
+  } catch (e) {
+    console.log(
+      "Error in sanitizing object before insert/update ! ",
+      e.message
+    );
+  }
 }
 
 class FireStoreDB extends MultiDbORM {
-
-    admin
-    serviceAccount
-    constructor(serviceAccount, appname) {
-        super()
-
-        var admin = require('firebase-admin');
-        this.serviceAccount = serviceAccount;
-
-        if (appname) {
-            admin = admin.initializeApp({
-                credential: admin.credential.cert(this.serviceAccount),
-                databaseURL: `https://${this.serviceAccount.project_id}.firebaseio.com`
-            }, appname);
-        } else
-            admin = admin.initializeApp({
-                credential: admin.credential.cert(this.serviceAccount),
-                databaseURL: `https://${this.serviceAccount.project_id}.firebaseio.com`
-            });
-
-        const db = admin.firestore();
-        this.db = db
-        this.admin = admin
-        console.log("Firestore Initialized");
-        this.dbType = 'firestore'
+  admin;
+  serviceAccount;
+  constructor(serviceAccount, appname) {
+    super();
+
+    var admin = require("firebase-admin");
+    this.serviceAccount = serviceAccount;
+
+    if (appname) {
+      admin = admin.initializeApp(
+        {
+          credential: admin.credential.cert(this.serviceAccount),
+          databaseURL: `https://${this.serviceAccount.project_id}.firebaseio.com`,
+        },
+        appname
+      );
+    } else
+      admin = admin.initializeApp({
+        credential: admin.credential.cert(this.serviceAccount),
+        databaseURL: `https://${this.serviceAccount.project_id}.firebaseio.com`,
+      });
+
+    const db = admin.firestore();
+    this.db = db;
+    this.admin = admin;
+    console.log("Firestore Initialized");
+    this.dbType = "firestore";
+  }
+
+  async run(query) {
+    if (this.loglevel > 3)
+      console.log("RUN : Not Supported in DB Type", this.dbType);
+  }
+
+  attachOptions(modelref, options) {
+    if (options.apply) {
+      if (options.apply.ineq) {
+        modelref = modelref.where(
+          options.apply.field,
+          options.apply.ineq.op,
+          options.apply.ineq.value
+        );
+      }
+      if (options.apply.sort) {
+        modelref = modelref.orderBy(options.apply.field, options.apply.sort);
+      }
+    } else if (options.sort) {
+      options.sort.forEach((srt) => {
+        modelref = modelref.orderBy(srt.field, srt.order);
+      });
     }
-
-    async run(query) {
-        if (this.loglevel > 3)
-            console.log('RUN : Not Supported in DB Type', this.dbType)
+    if (options.limit) {
+      modelref = modelref.limit(options.limit);
     }
 
-    attachOptions(modelref, options) {
-
-        if (options.apply) {
-            if (options.apply.ineq) {
-                modelref = modelref.where(options.apply.field, options.apply.ineq.op, options.apply.ineq.value)
-            }
-            if (options.apply.sort) {
-                modelref = modelref.orderBy(options.apply.field, options.apply.sort)
-            }
-        }
-        else if (options.sort) {
-            options.sort.forEach(srt => {
-                modelref = modelref.orderBy(srt.field, srt.order)
-            });
-        }
-        if (options.limit) {
-            modelref = modelref.limit(options.limit)
-        }
-
-        if (options.offset) {
-            modelref = modelref.offset(options.offset)
-        }
-
-        return modelref;
+    if (options.offset) {
+      modelref = modelref.offset(options.offset);
     }
 
-    async _get(modelname, filter, options) {
-
-        const modelref = this.getdb().collection(modelname);
-        var where = modelref
-        for (var key in filter) {
-            where = where.where(key, '==', filter[key])
-        }
-        if (options) {
-            where = this.attachOptions(where, options);
-        }
-        const snapshot = await where.get();
-        if (snapshot.empty) {
-            return;
-        }
+    return modelref;
+  }
 
-        return snapshot;
+  async _get(modelname, filter, options) {
+    const modelref = this.getdb().collection(modelname);
+    var where = modelref;
+    for (var key in filter) {
+      where = where.where(key, "==", filter[key]);
     }
-
-    async get(modelname, filter, options) {
-        var result = []
-        var snapshot = await this._get(modelname, filter, options)
-        if (snapshot == undefined)
-            return []
-        this.metrics.get(modelname, filter, options)
-        let that = this;
-        snapshot.forEach(doc => {
-            that.metrics.getOne(modelname, filter, options);
-            result.push(doc.data())
-        });
-        if (this.loglevel > 2)
-            console.log('Retrieved ', result)
-
-        return result;
-
+    if (options) {
+      where = this.attachOptions(where, options);
     }
-
-    async getOne(modelname, filter, id, options) {
-        var idx = id || filter.id
-        if (idx) {
-            this.metrics.getOne(modelname, filter, options);
-            const modelref = this.getdb().collection(modelname).doc(idx);
-            const doc = await modelref.get();
-            if (this.loglevel > 2)
-                console.log('Retrieved ', doc.data())
-            return doc.data();
-
-        }
-        else {
-            var rows = await this.get(modelname, filter, options)
-            if (rows != undefined) {
-                if (this.loglevel > 2)
-                    console.log('Retrieved ', rows[0])
-                return rows[0]
-            }
-            else {
-                return undefined;
-            }
-        }
+    const snapshot = await where.get();
+    if (snapshot.empty) {
+      return;
     }
 
-    async create(modelname, sampleObject) {
-        this.sync.create(modelname, sampleObject)
-        this.metrics.create(modelname, sampleObject);
-
-        if (this.loglevel > 3)
-            console.log('CREATE : Not required in DB Type', this.dbType)
+    return snapshot;
+  }
+
+  async get(modelname, filter, options) {
+    var result = [];
+    var snapshot = await this._get(modelname, filter, options);
+    if (snapshot == undefined) return [];
+    this.metrics.get(modelname, filter, options);
+    let that = this;
+    snapshot.forEach((doc) => {
+      that.metrics.getOne(modelname, filter, options);
+      result.push(doc.data());
+    });
+    if (this.loglevel > 2) console.log("Retrieved ", result);
+
+    return result;
+  }
+
+  async getOne(modelname, filter, id, options) {
+    var idx = id || filter.id;
+    if (idx) {
+      this.metrics.getOne(modelname, filter, options);
+      const modelref = this.getdb().collection(modelname).doc(idx);
+      const doc = await modelref.get();
+      if (this.loglevel > 2) console.log("Retrieved ", doc.data());
+      return doc.data();
+    } else {
+      var rows = await this.get(modelname, filter, options);
+      if (rows != undefined) {
+        if (this.loglevel > 2) console.log("Retrieved ", rows[0]);
+        return rows[0];
+      } else {
+        return undefined;
+      }
     }
+  }
 
-    async insert(modelname, object, id) {
-        replaceUndefinedWithNull(object)
-        this.sync.insert(modelname, object, id)
-        this.metrics.insert(modelname, object, id)
-
-        var db = this.getdb();
-        var idx = id || object.id || Date.now()
-        const docref = db.collection(modelname).doc("" + idx);
-        try {
-            replaceUndefinedWithNull(object)
-            return await docref.set(object);
-        } catch (e) {
-
-            if (e.message.indexOf("Firestore doesn't support JavaScript objects with custom prototypes") > -1) {
-                return await docref.set(JSON.parse(JSON.stringify(object)));
-            }
-            else {
-                throw e;
-            }
+  async create(modelname, sampleObject) {
+    this.sync.create(modelname, sampleObject);
+    this.metrics.create(modelname, sampleObject);
 
-        }
+    if (this.loglevel > 3)
+      console.log("CREATE : Not required in DB Type", this.dbType);
+  }
 
-    }
-
-    async update(modelname, filter, object, id) {
-        this.sync.update(modelname, filter, object, id)
-
-        var idx = id || filter.id || object.id
-
-
-        try {
-            replaceUndefinedWithNull(object)
-            if (idx) {
-                this.metrics.update(modelname, filter, object, id)
-                await this.getdb().collection(modelname).doc(idx).update(object);
-
-            } else {
-                var snaps = await this._get(modelname, filter)
-                let that = this;
-                snaps.forEach(async function (element) {
-                    that.metrics.getOne(modelname, filter, id)
-                    that.metrics.update(modelname, filter, object, id)
-                    await element.ref.update(object)
-                });
-            }
-        } catch (e) {
-
-            if (e.message.indexOf("Firestore doesn't support JavaScript objects with custom prototypes") > -1) {
-                return await this.update(modelname, filter, JSON.parse(JSON.stringify(object)), id);
-            }
-            else {
-                throw e;
-            }
-        }
+  async insert(modelname, object, id) {
+    replaceUndefinedWithNull(object);
+    this.sync.insert(modelname, object, id);
+    this.metrics.insert(modelname, object, id);
 
+    var db = this.getdb();
+    var idx = id || object.id || Date.now();
+    const docref = db.collection(modelname).doc("" + idx);
+    try {
+      replaceUndefinedWithNull(object);
+      return await docref.set(object);
+    } catch (e) {
+      if (
+        e.message.indexOf(
+          "Firestore doesn't support JavaScript objects with custom prototypes"
+        ) > -1
+      ) {
+        return await docref.set(JSON.parse(JSON.stringify(object)));
+      } else {
+        throw e;
+      }
     }
+  }
 
-    async delete(modelname, filter, id) {
-        this.sync.delete(modelname, filter, id)
-
+  async update(modelname, filter, object, id) {
+    this.sync.update(modelname, filter, object, id);
 
-        var idx = id || filter.id
+    var idx = id || filter.id || object.id;
 
-        if (idx) {
-            this.metrics.delete(modelname, filter, id)
-            await this.getdb().collection(modelname).doc(idx).delete();
-
-        } else {
-            var snaps = await this._get(modelname, filter)
-            let that = this;
-            snaps.forEach(async function (element) {
-                that.metrics.getOne(modelname, filter, id)
-                that.metrics.delete(modelname, filter, id)
-                await element.ref.delete();
-            });
-        }
+    try {
+      replaceUndefinedWithNull(object);
+      if (idx) {
+        this.metrics.update(modelname, filter, object, id);
+        await this.getdb().collection(modelname).doc(idx).update(object);
+      } else {
+        var snaps = (await this._get(modelname, filter)) || [];
+        let that = this;
+        snaps.forEach(async function (element) {
+          that.metrics.getOne(modelname, filter, id);
+          that.metrics.update(modelname, filter, object, id);
+          await element.ref.update(object);
+        });
+      }
+    } catch (e) {
+      if (
+        e.message.indexOf(
+          "Firestore doesn't support JavaScript objects with custom prototypes"
+        ) > -1
+      ) {
+        return await this.update(
+          modelname,
+          filter,
+          JSON.parse(JSON.stringify(object)),
+          id
+        );
+      } else {
+        throw e;
+      }
+    }
+  }
+
+  async delete(modelname, filter, id) {
+    this.sync.delete(modelname, filter, id);
+
+    var idx = id || filter.id;
+
+    if (idx) {
+      this.metrics.delete(modelname, filter, id);
+      await this.getdb().collection(modelname).doc(idx).delete();
+    } else {
+      var snaps = (await this._get(modelname, filter)) || [];
+      let that = this;
+      snaps.forEach(async function (element) {
+        that.metrics.getOne(modelname, filter, id);
+        that.metrics.delete(modelname, filter, id);
+        await element.ref.delete();
+      });
     }
+  }
 }
 
-
-
 module.exports = {
-    FireStoreDB
-}
+  FireStoreDB,
+};

package/engines/mysqldb.js

@@ -19,6 +19,7 @@ class MySQLDB extends MultiDbORM {
     const mysql = require("mysql");
     this.mysql = mysql;
     this.pool = mysql.createPool({
+      ...credentials,
       connectionLimit: credentials.connectionLimit || 10,
       host: credentials.host,
       port: credentials.port,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-db-orm",
-  "version": "3.0.9",
+  "version": "3.0.11",
   "description": "CRUD , Backup , Restore and Migration library for multiple databases",
   "main": "index.js",
   "dependencies": {