doix-db 0.0.35 → 0.0.37

package/index.js

@@ -12,6 +12,7 @@ module.exports = {
 	DbObjectMap:    require ('./lib/model/DbObjectMap.js'),
 	DbObject:       require ('./lib/model/DbObject.js'),
 	DbModel:        require ('./lib/model/DbModel.js'),
+	DbMigrationPlan:require ('./lib/migration/DbMigrationPlan.js'),
 	DbQuery:        require ('./lib/query/DbQuery.js'),
 	DbQueryTable:   require ('./lib/query/DbQueryTable.js'),
 	DbQueryColumn:  require ('./lib/query/DbQueryColumn.js'),	

package/lib/DbClient.js

@@ -1,6 +1,9 @@
-const EventEmitter  = require ('events')
-const {randomUUID}  = require ('crypto')
-const DbQuery = require ('./query/DbQuery.js')
+const EventEmitter    = require ('events')
+const {randomUUID}    = require ('crypto')
+
+const DbQuery         = require ('./query/DbQuery.js')
+const DbMigrationPlan = require ('./migration/DbMigrationPlan.js')
+
 const NULL = Symbol.for ('NULL')
 
 class DbClient extends EventEmitter {
@@ -12,6 +15,12 @@ class DbClient extends EventEmitter {
 		this.uuid = randomUUID ()
 	
 	}
+	
+	createMigrationPlan () {
+	
+		return new DbMigrationPlan (this)
+	
+	}
 
 	async getArrayBySql (sql, params = [], options = {}) {
 

package/lib/DbLang.js

@@ -29,6 +29,18 @@ class DbLang {
 	
 	}
 
+	getDbObjectClassesToDiscover () {
+	
+		return [DbTable]
+	
+	}
+	
+	getRequiredMutation (asIs, toBe) {
+	
+		return null
+	
+	}
+
 	quoteName (s) {
 
 		return CH_QQ + QQ_ESC.escape (s) + CH_QQ
@@ -85,13 +97,18 @@ class DbLang {
 		
 	getDbColumnTypeDim (col) {
 
-		if (!('size' in col)) return col.type
+		const {type, size} = col; if (size == null) return type
 
-		let s = col.type + '(' + col.size
+		let s = `${type}(${size}`
 
-		if ('scale' in col) s += ',' + col.scale
+		const {scale} = col; if (scale != null) {
+			s += ','
+			s += scale
+		}
+		
+		s += ')'
 
-		return s + ')'
+		return s
 
 	}
 	

package/lib/migration/DbMigrationPlan.js

@@ -0,0 +1,88 @@
+const EventEmitter = require ('events')
+
+const ACTIONS = [
+	'create',
+	'alter',
+	'migrate',
+	'recreate',
+]
+
+class DbMigrationPlan extends EventEmitter {
+
+	constructor (db) {
+
+		super ()
+
+		this.db    = db
+		this.lang  = db.lang
+		this.model = db.model
+		this.toBe  = db.model.map
+
+		db.lang.migrationPlan = this
+
+		this.on ('existing', o => this.asIs.set (o.name, o))
+		
+		this.toDo = new Map; for (const a of ACTIONS) this.on (a, o => {
+		
+			if (!this.toDo.has (a)) this.toDo.set (a, [])
+			
+			this.toDo.get (a).push (o)
+		
+		})
+
+	}
+	
+	inspectStructure () {
+	
+		const {asIs} = this; if (!asIs) throw Error ('Existing database objects not discovered, call loadStructure () first')
+
+		const {lang} = this, hardClasses = lang.getDbObjectClassesToDiscover ()
+
+		for (const [name, object] of this.toBe.entries ()) {
+
+			const action = 
+
+				!hardClasses.includes (object.constructor) ? 'recreate' :
+
+				!asIs.has (name) ? 'create' : 
+				
+				lang.getRequiredMutation (asIs.get (name), object)
+
+			if (action) this.emit (action, object)
+
+		}
+	
+	}
+
+	async loadStructure () {
+	
+		this.asIs  = new Map ()
+
+		return Promise.all (this.lang.getDbObjectClassesToDiscover ().map (type => this.loadExistingObjects (type)))
+
+	}
+
+	async loadExistingObjects (type) {
+	
+		const methodName = `getStreamOfExisting${type.name.slice (2)}s`
+
+		const {db, asIs, toBe} = this, s = await db [methodName] ()
+
+		return new Promise ((ok, fail) => {
+		
+			s.on ('error', fail)
+			
+			s.on ('end', ok)
+			
+			s.on ('data', table => this.emit (			
+				toBe.has (table.name) ? 'existing' : 'unknown', 
+				table
+			))
+
+		})
+		
+	}
+
+}
+
+module.exports = DbMigrationPlan

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doix-db",
-  "version": "0.0.35",
+  "version": "0.0.37",
   "description": "Shared database related code for doix",
   "main": "index.js",
   "files": [
@@ -40,7 +40,7 @@
   },
   "homepage": "https://github.com/do-/node-doix-db#readme",
   "peerDependencies": {
-    "doix": "^0.0.42"
+    "doix": "^0.0.43"
   },
   "devDependencies": {
     "jest": "^29.3.1"