multi-db-orm 1.3.0 → 1.3.2

package/.github/workflows/npm-publish.yml

@@ -1,24 +1,24 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
-
-name: NPM Publish
-
-on:
-  release:
-    types: [created]
-  push:
-    branches:
-      - "master"
-      
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-      - run: npm install
-      - uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: NPM Publish
+
+on:
+  release:
+    types: [created]
+  push:
+    branches:
+      - "master"
+      
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - run: npm install
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/.vscode/launch.json

@@ -1,17 +1,17 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Launch Program",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "program": "${workspaceFolder}/test/test.js"
-        }
-    ]
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/test/test.js"
+        }
+    ]
 }

package/.vscode/settings.json

@@ -1,11 +1,11 @@
-{
-    "sqltools.connections": [
-        {
-            "previewLimit": 50,
-            "driver": "SQLite",
-            "name": "test",
-            "database": "${workspaceFolder:multi-db-safe}/test.db"
-        }
-    ],
-    "sqltools.useNodeRuntime": true
+{
+    "sqltools.connections": [
+        {
+            "previewLimit": 50,
+            "driver": "SQLite",
+            "name": "test",
+            "database": "${workspaceFolder:multi-db-safe}/test.db"
+        }
+    ],
+    "sqltools.useNodeRuntime": true
 }

package/Dockerfile

@@ -1,17 +1,17 @@
-# The base image
-FROM node:10   
-
-# The working directory inside the image
-WORKDIR /multi-db-safe  
-
-# Copy everything from folder with the docker file to /app
-COPY . .
-
-# Run a commandline when docker build
-RUN npm install
-
-# Upon start of image this command will run , This is taken as a startup command and can be overriden from cmd line when 'docker run'
-CMD ["echo","Starting Migration..."]
-
-# Upon start of image this command will run , This is taken as a stable command and cannot be overriden from cmd line when 'docker run'
-ENTRYPOINT ["/multi-db-safe/migrate.sh"]
+# The base image
+FROM node:10   
+
+# The working directory inside the image
+WORKDIR /multi-db-safe  
+
+# Copy everything from folder with the docker file to /app
+COPY . .
+
+# Run a commandline when docker build
+RUN npm install
+
+# Upon start of image this command will run , This is taken as a startup command and can be overriden from cmd line when 'docker run'
+CMD ["echo","Starting Migration..."]
+
+# Upon start of image this command will run , This is taken as a stable command and cannot be overriden from cmd line when 'docker run'
+ENTRYPOINT ["/multi-db-safe/migrate.sh"]

package/README.md

@@ -1,196 +1,197 @@
-# multi-db-orm
-ORM for multiple SQL and NoSQL databases like firestore , MongoDB , SQlite with Sync ,  Backup and Restore support .
-
-[![NPM Publish](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml)
-
-## 1. Object Relational Mapping
-
-Supported databases:
-1. MongoDB
-2. Google Firestore
-3. SQlite3
-
-### Install
-The package is available on npm
-`
-npm install multi-db-orm
-`
-
-### Initialize
-```
-const { MultiDbORM, FireStoreDB, MongoDB, SQLiteDB, Sync } = require("multi-db-orm");
-
-// You can choose to initialize any or all of the supported databases in singe app
-
-// Firestore
-var firebasedb = new FireStoreDB(require("/path/to/serviceAccountFile.json"));
-
-// Sqlite
-var sqlitedb = new SQLiteDB("/path/to/mydatabase.db"); // if no path is passed , an in-memory db is used
-
-// MongoDB
-var mongodb = new MongoDB("mongodb+srv://username:PassW0rd@host.server.net/my_db_name","my_db_name");
-
-var db = firebasedb;
-```
-
-### Usage 
-You can perform Create,Insert,Get,GetOne,Update,Delete queries . You only need to base your code on the interface MultiDbORM
-
-<b>Note:</b>
- 1. Firestore DB requires a `documentPath` specified for each document in a collection . For FirestoreDB functions you can optionally specify this path as the last parameter in getOne,update,insert,delete functions or have a 'id' field in all your objects . If none are specified the Date.now() is used.
- 2. All the functions are `async` i.e. they return a promise so you can use `..then()` or `await`
-
-#### Create
-You can create a Table from a sample object in SQlite . NoSQL databases need not create a entity explicitly .
-```
-// db.create(modelname,sampleObject)
-
-var db = new SQLiteDB("/path/to/mydatabase.db"); // if no path is passed , an in-memory db is used
-db.create('game',aSampleGameObject); 
-// creates a game table in db . 
-// The fields and their data types are extracted from aSampleGameObject but aSampleGameObject is not saved in db
-```
-
-#### Insert
-The same code will insert a object to the database entity based on the Implementation of MultiDbORM selected from Initialize Step above . Calling `db.insert()` returns a promise so can be used with async/await easily .
-```
-// db.insert(modelname,object)
-
-var res = await db.insert('game', gm);
-
-OR
-
-db.insert('game', gm).then(response=>{
- console.log(response);
-}).catch(err=>{
- console.log(err);
-});
-```
-
-#### Get
-The code will retrieve object(s) from the database .
-```
-// db.get(modelname,filter)
-
-var games = await db.get('game', { amount: 19.00 , type: 'Hockey' }); 
-// returns an array of games having amount = 19.00 and type = Hockey
-
-var oneGame = await db.getOne('game', { country: 'India' }); // returns single game having country = 19.00 
-
-var oneGameFr = await db.getOne('game', { country: 'India' },"32g274hfn48vnf")); 
-// Only for firestore if docPath is passed optionally , filter is ignored and the object is returned
-```
-
-
-#### Get with Range and sort
-The code will retrieve object(s) from the database with range (supported range operations : > , < , >= , >= , != , = ) and sort (asc or desc) on single field , limit and offset.
-```
-var gamesFr = await mongodb.get('games', { amount: 400 }, {
-            apply: {
-                field: 'timeStamp',
-                sort: 'desc',
-                ineq: {
-                    op: '>=',
-                    value: 1650398288
-                }
-            },
-            limit: 2, offset: 1
-        })
-
-```
-
-#### Get with Sort , Limit and Offset
-The code will retrieve object(s) from the database with sort (asc or desc) , limit and offset.
-```
-var oneGameFr = await mongodb.get('game', 
- { country: 'India' },
- { sort: [{ field: 'timeStamp', order: 'asc' },
- { field: 'amount', order: 'asc' }], 
-  limit: 5, offset: 1 
-})
-
-```
-Note : 
-1. For firestore indexes have to be created before using sort . In case indexes are not there you will get an error in the console with a link where you can create the required index .
-2. sort is not applicable when using apply and will be ignored
-
-
-#### Update
-The code will update objects in the database .
-```
-// db.update(modelname,filter,object)
-
-
-var result = await db.update('game', { amount: 19.00 , type: 'Hockey' },{status : "cancelled",closingTime:Date.now()}); 
-// updates all the games having amount=19.00 and type=Hockey to status=cancelled 
-// and closingTime as current time while other fields are not touched
-
-var result_fire = await db.update('game', { amount: 19.00 , type: 'Hockey' },"32g274hfn48vnf"); 
-/* Only for firestore with optional docPath , it will update collection("game").doc("32g274hfn48vnf") .
-The filters amount and type are ignored when docPath is passed */
-```
-
-#### Delete
-The code will delete objects in the database .
-````
-// db.delete(modelname,filter)
-
-
-var result = await db.delete('game', { amount: 19.00 , type: 'Hockey' }); 
-// deletes all the games having amount=19.00 and type=Hockey  
-
-var result_fire = await db.delete('game', { amount: 19.00 , type: 'Hockey' },"32g274hfn48vnf");
-/* Only for firestore with optional docPath , it will delete collection("game").doc("32g274hfn48vnf") .
-The filters amount and type are ignored when docPath is passed */
-````
-
-
-
-
-## 2. Migration
-
-#### Mongo DB
-
-Pass your SOURCE and TARGET DB credentials 
-
-Using Docker
-```
-docker run shiveshnavin/multi-db-safe 'mongodb://username:paswd@dbhost:13873/sourceDBName' 'mongodb://username:paswd@dbhost:13873/targetDBName' 0
- 
-```
-Using Shell
-```
-./migrate.sh 'mongodb://username:paswd@dbhost:13873/sourceDBName' 'mongodb://username:paswd@dbhost:13873/targetDBName' 0
- 
-```
- 
-Note : To run deduplication as well set 1 instead of 0 at last cmd line argument
-
-## 3. Backup 
-
-#### Mongo DB
-```
-node backup.js 'mongodb://username:paswd@dbhost:13873/sourceDBName'
-```
-
-This will create a dump file in dumps/
-
-## 4. Restore
-
-#### Mongo DB
-```
-Without Deduplication : node restore.js dumpfile.json 'mongodb://username:paswd@dbhost:13873/targetDBName' 
-
-With Deduplication : node restore.js dumpfile.json 'mongodb://username:paswd@dbhost:13873/targetDBName' 1
-```
-
-
-## 5. Work in Progress
-Working on enhancing the tool with below features in progress. Feel free to contribute and create a PR .
-
-- [ ] Add Backup support for other databases
-- [ ] Add Restore support for other databases
-- [X] Range Operations like `>=` `<=` 
-- [ ] Aggregations
-- [ ] InsertMany
+# multi-db-orm
+ORM for multiple SQL and NoSQL databases like firestore , MongoDB , SQlite with Sync ,  Backup and Restore support .
+
+[![NPM Publish](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/shiveshnavin/multi-db-orm/actions/workflows/npm-publish.yml)
+
+## 1. Object Relational Mapping
+
+Supported databases:
+1. MongoDB
+2. Google Firestore
+3. SQlite3
+
+### Install
+The package is available on npm
+`
+npm install multi-db-orm
+`
+
+### Initialize
+```
+const { MultiDbORM, FireStoreDB, MongoDB, SQLiteDB, Sync } = require("multi-db-orm");
+
+// You can choose to initialize any or all of the supported databases in singe app
+
+// Firestore
+var firebasedb = new FireStoreDB(require("/path/to/serviceAccountFile.json"));
+Note: If you use firebase DB then keys with undefined values will be set to null while insert or update as firebase dosent support undefined values
+
+// Sqlite
+var sqlitedb = new SQLiteDB("/path/to/mydatabase.db"); // if no path is passed , an in-memory db is used
+
+// MongoDB
+var mongodb = new MongoDB("mongodb+srv://username:PassW0rd@host.server.net/my_db_name","my_db_name");
+
+var db = firebasedb;
+```
+
+### Usage 
+You can perform Create,Insert,Get,GetOne,Update,Delete queries . You only need to base your code on the interface MultiDbORM
+
+<b>Note:</b>
+ 1. Firestore DB requires a `documentPath` specified for each document in a collection . For FirestoreDB functions you can optionally specify this path as the last parameter in getOne,update,insert,delete functions or have a 'id' field in all your objects . If none are specified the Date.now() is used.
+ 2. All the functions are `async` i.e. they return a promise so you can use `..then()` or `await`
+
+#### Create
+You can create a Table from a sample object in SQlite . NoSQL databases need not create a entity explicitly .
+```
+// db.create(modelname,sampleObject)
+
+var db = new SQLiteDB("/path/to/mydatabase.db"); // if no path is passed , an in-memory db is used
+db.create('game',aSampleGameObject); 
+// creates a game table in db . 
+// The fields and their data types are extracted from aSampleGameObject but aSampleGameObject is not saved in db
+```
+
+#### Insert
+The same code will insert a object to the database entity based on the Implementation of MultiDbORM selected from Initialize Step above . Calling `db.insert()` returns a promise so can be used with async/await easily .
+```
+// db.insert(modelname,object)
+
+var res = await db.insert('game', gm);
+
+OR
+
+db.insert('game', gm).then(response=>{
+ console.log(response);
+}).catch(err=>{
+ console.log(err);
+});
+```
+
+#### Get
+The code will retrieve object(s) from the database .
+```
+// db.get(modelname,filter)
+
+var games = await db.get('game', { amount: 19.00 , type: 'Hockey' }); 
+// returns an array of games having amount = 19.00 and type = Hockey
+
+var oneGame = await db.getOne('game', { country: 'India' }); // returns single game having country = 19.00 
+
+var oneGameFr = await db.getOne('game', { country: 'India' },"32g274hfn48vnf")); 
+// Only for firestore if docPath is passed optionally , filter is ignored and the object is returned
+```
+
+
+#### Get with Range and sort
+The code will retrieve object(s) from the database with range (supported range operations : > , < , >= , >= , != , = ) and sort (asc or desc) on single field , limit and offset.
+```
+var gamesFr = await mongodb.get('games', { amount: 400 }, {
+            apply: {
+                field: 'timeStamp',
+                sort: 'desc',
+                ineq: {
+                    op: '>=',
+                    value: 1650398288
+                }
+            },
+            limit: 2, offset: 1
+        })
+
+```
+
+#### Get with Sort , Limit and Offset
+The code will retrieve object(s) from the database with sort (asc or desc) , limit and offset.
+```
+var oneGameFr = await mongodb.get('game', 
+ { country: 'India' },
+ { sort: [{ field: 'timeStamp', order: 'asc' },
+ { field: 'amount', order: 'asc' }], 
+  limit: 5, offset: 1 
+})
+
+```
+Note : 
+1. For firestore indexes have to be created before using sort . In case indexes are not there you will get an error in the console with a link where you can create the required index .
+2. sort is not applicable when using apply and will be ignored
+
+
+#### Update
+The code will update objects in the database .
+```
+// db.update(modelname,filter,object)
+
+
+var result = await db.update('game', { amount: 19.00 , type: 'Hockey' },{status : "cancelled",closingTime:Date.now()}); 
+// updates all the games having amount=19.00 and type=Hockey to status=cancelled 
+// and closingTime as current time while other fields are not touched
+
+var result_fire = await db.update('game', { amount: 19.00 , type: 'Hockey' },"32g274hfn48vnf"); 
+/* Only for firestore with optional docPath , it will update collection("game").doc("32g274hfn48vnf") .
+The filters amount and type are ignored when docPath is passed */
+```
+
+#### Delete
+The code will delete objects in the database .
+````
+// db.delete(modelname,filter)
+
+
+var result = await db.delete('game', { amount: 19.00 , type: 'Hockey' }); 
+// deletes all the games having amount=19.00 and type=Hockey  
+
+var result_fire = await db.delete('game', { amount: 19.00 , type: 'Hockey' },"32g274hfn48vnf");
+/* Only for firestore with optional docPath , it will delete collection("game").doc("32g274hfn48vnf") .
+The filters amount and type are ignored when docPath is passed */
+````
+
+
+
+
+## 2. Migration
+
+#### Mongo DB
+
+Pass your SOURCE and TARGET DB credentials 
+
+Using Docker
+```
+docker run shiveshnavin/multi-db-safe 'mongodb://username:paswd@dbhost:13873/sourceDBName' 'mongodb://username:paswd@dbhost:13873/targetDBName' 0
+ 
+```
+Using Shell
+```
+./migrate.sh 'mongodb://username:paswd@dbhost:13873/sourceDBName' 'mongodb://username:paswd@dbhost:13873/targetDBName' 0
+ 
+```
+ 
+Note : To run deduplication as well set 1 instead of 0 at last cmd line argument
+
+## 3. Backup 
+
+#### Mongo DB
+```
+node backup.js 'mongodb://username:paswd@dbhost:13873/sourceDBName'
+```
+
+This will create a dump file in dumps/
+
+## 4. Restore
+
+#### Mongo DB
+```
+Without Deduplication : node restore.js dumpfile.json 'mongodb://username:paswd@dbhost:13873/targetDBName' 
+
+With Deduplication : node restore.js dumpfile.json 'mongodb://username:paswd@dbhost:13873/targetDBName' 1
+```
+
+
+## 5. Work in Progress
+Working on enhancing the tool with below features in progress. Feel free to contribute and create a PR .
+
+- [ ] Add Backup support for other databases
+- [ ] Add Restore support for other databases
+- [X] Range Operations like `>=` `<=` 
+- [ ] Aggregations
+- [ ] InsertMany