doix-db 0.0.36 → 0.0.41

package/index.js

@@ -1,4 +1,5 @@
 module.exports = {
+
 	DbEventLogger : require ('./lib/DbEventLogger.js'),
 	DbClient:       require ('./lib/DbClient.js'), 
 	DbPool:         require ('./lib/DbPool.js'), 
@@ -12,9 +13,18 @@ module.exports = {
 	DbObjectMap:    require ('./lib/model/DbObjectMap.js'),
 	DbObject:       require ('./lib/model/DbObject.js'),
 	DbModel:        require ('./lib/model/DbModel.js'),
+
+	DbType:                require ('./lib/model/types/DbType.js'),
+	DbTypeArithmetic:      require ('./lib/model/types/DbTypeArithmetic.js'),
+	DbTypeArithmeticFixed: require ('./lib/model/types/DbTypeArithmeticFixed.js'),
+	DbTypeArithmeticFloat: require ('./lib/model/types/DbTypeArithmeticFloat.js'),
+	DbTypeArithmeticInt:   require ('./lib/model/types/DbTypeArithmeticInt.js'),
+	DbTypeCharacter:       require ('./lib/model/types/DbTypeCharacter.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'),	
 	DbQueryOr:      require ('./lib/query/DbQueryOr.js'),
+
 }

package/lib/DbLang.js

@@ -3,6 +3,13 @@ const stringEscape = require ('string-escape-map')
 const DbTable = require ('./model/DbTable.js')
 const DbView  = require ('./model/DbView.js')
 
+const DbType =                require ('./model/types/DbType.js')
+const DbTypeArithmetic =      require ('./model/types/DbTypeArithmetic.js')
+const DbTypeArithmeticFixed = require ('./model/types/DbTypeArithmeticFixed.js')
+const DbTypeArithmeticFloat = require ('./model/types/DbTypeArithmeticFloat.js')
+const DbTypeArithmeticInt =   require ('./model/types/DbTypeArithmeticInt.js')
+const DbTypeCharacter =       require ('./model/types/DbTypeCharacter.js')
+
 const CH_Q = "'", CH_QQ = '"'
 
 const Q_ESC = new stringEscape ([
@@ -17,6 +24,49 @@ const DELIM_UPDATE = [',', ' AND ']
 
 class DbLang {
 
+	static TP_SMALLINT = new DbTypeArithmeticInt   ({name: 'SMALLINT', bytes: 2})
+	static TP_INT      = new DbTypeArithmeticInt   ({name: 'INT',      bytes: 4})
+	static TP_BIGINT   = new DbTypeArithmeticInt   ({name: 'BIGINT',   bytes: 8})
+	static TP_REAL     = new DbTypeArithmeticFloat ({name: 'REAL'})
+	static TP_NUMERIC  = new DbTypeArithmeticFixed ({name: 'NUMERIC'})
+	static TP_CHAR     = new DbTypeCharacter       ({name: 'CHAR'})
+	static TP_VARCHAR  = new DbTypeCharacter       ({name: 'VARCHAR'})
+
+	getTypeDefinition (name) {
+
+		name = name.toUpperCase ()
+
+		switch (name) {
+
+			case 'INT':
+			case 'INTEGER':
+				return DbLang.TP_INT
+
+			case 'BIGINT':
+				return DbLang.TP_BIGINT
+
+			case 'SMALLINT':
+				return DbLang.TP_SMALLINT
+
+			case 'CHAR':
+				return DbLang.TP_CHAR
+
+			case 'VARCHAR':
+				return DbLang.TP_VARCHAR
+
+			case 'NUMERIC':
+			case 'DECIMAL':
+				return DbLang.TP_NUMERIC
+
+			case 'REAL':
+				return DbLang.TP_REAL
+
+		}
+
+		return new DbType ({name})
+
+	}
+
 	getDbObjectClass (o) {
 	
 		if (o == null) throw Error ('Empty definition')
@@ -35,6 +85,63 @@ class DbLang {
 	
 	}
 
+	isEqualColumnDefault (column, existing) {
+
+		return column.default == existing.default
+
+	}
+
+	isAdequateColumnType (typeAsIs, typeToBe) {
+
+		if (typeToBe instanceof DbTypeArithmeticInt && typeAsIs instanceof DbTypeArithmeticInt) return (
+			typeAsIs.isSigned === typeToBe.isSigned &&
+			typeAsIs.bytes     >= typeToBe.bytes
+		)
+
+		return typeAsIs.name === typeToBe.name
+
+	}
+
+	isAdequateColumnTypeDim (asIs, toBe) {
+
+		const typeToBe = this.getTypeDefinition (toBe.type), typeAsIs = this.getTypeDefinition (asIs.type)
+
+		if (typeToBe !== typeAsIs && !this.isAdequateColumnType (typeAsIs, typeToBe)) return false
+
+		if (toBe.size > 0 && toBe.size > asIs.size) return false
+
+		if (typeToBe instanceof DbTypeArithmeticFixed && toBe.scale > asIs.scale) return false
+		
+		return true
+
+	}
+	
+	compareColumns (asIs, toBe) {
+	
+		const diff = []
+
+		if (asIs.nullable !== toBe.nullable) diff.push ('nullable')
+
+		if (!this.isEqualColumnDefault (asIs, toBe)) diff.push ('default')
+
+		if (!this.isAdequateColumnTypeDim (asIs, toBe)) diff.push ('typeDim')
+
+		return diff
+
+	}
+
+	getRequiredMutation (asIs, toBe) {
+	
+		return null
+	
+	}
+
+	getRequiredColumnMutation (asIs, toBe) {
+
+		return asIs.diff.length === 0 ? null : 'alter-column'
+	
+	}
+
 	quoteName (s) {
 
 		return CH_QQ + QQ_ESC.escape (s) + CH_QQ
@@ -71,14 +178,8 @@ class DbLang {
 		
 		}
 
-	}	
-	
-	getCanonicalTypeName (type) {
-	
-		return type.toUpperCase ()
-	
 	}
-	
+
 	getDbObjectName (o) {
 
 		const {schemaName, localName} = o
@@ -91,13 +192,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

@@ -1,5 +1,28 @@
+const DbRelation = require ('../model/DbRelation.js')
+
 const EventEmitter = require ('events')
 
+const OBJECT_ACTIONS = [
+	'create',
+	'alter',
+	'migrate',
+	'recreate',
+]
+
+const COLUMN_ACTIONS = [
+	'add-column',
+	'alter-column',
+	'migrate-column',
+]
+
+const add = (toDo, action, object) => {
+
+	if (!toDo.has (action)) toDo.set (action, [])
+			
+	toDo.get (action).push (object)
+
+}
+
 class DbMigrationPlan extends EventEmitter {
 
 	constructor (db) {
@@ -10,15 +33,91 @@ class DbMigrationPlan extends EventEmitter {
 		this.lang  = db.lang
 		this.model = db.model
 		this.toBe  = db.model.map
-		this.asIs  = new Map ()
+
+		db.lang.migrationPlan = this
 
 		this.on ('existing', o => this.asIs.set (o.name, o))
+		
+		this.toDo = new Map 
+		
+		for (const action of OBJECT_ACTIONS) 
+		
+			this.on (action, object => add (
+				this.toDo, 
+				action, object))
+
+		for (const action of COLUMN_ACTIONS) 
+			
+			this.on (action, column => add (
+				this.asIs.get (column.relation.name).toDo, 
+				action, column))
+
+	}		
+
+	compareRelation (asIs, toBe) {
+
+		const {lang} = this, {columns} = toBe, existingColumns = asIs.columns
+		
+		for (const [name, column] of Object.entries (columns)) {
+
+			if (name in existingColumns) {
+				
+				const existingColumn = existingColumns [name]
+
+				existingColumn.diff = lang.compareColumns (existingColumn, column)
+
+				const action = lang.getRequiredColumnMutation (existingColumn, column)
+
+				if (action !== null) this.emit (action, column)
+
+			}
+			else {
+
+				this.emit ('add-column', column)
+
+			}
+
+		}
+
+	}
+
+	compareObject (asIs, toBe) {
+
+		if (asIs.constructor === toBe.constructor && toBe instanceof DbRelation)
+		
+			this.compareRelation (asIs, toBe)
+
+		return this.lang.getRequiredMutation (asIs, toBe)
+
+	}
+
+	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' : 
+				
+				this.compareObject (asIs.get (name), object)
+				
+			if (action !== null) this.emit (action, object)
+
+		}
 
 	}
 
 	async loadStructure () {
+	
+		this.asIs  = new Map ()
 
-		return Promise.all (this.db.lang.getDbObjectClassesToDiscover ().map (type => this.loadExistingObjects (type)))
+		return Promise.all (this.lang.getDbObjectClassesToDiscover ().map (type => this.loadExistingObjects (type)))
 
 	}
 
@@ -33,11 +132,16 @@ class DbMigrationPlan extends EventEmitter {
 			s.on ('error', fail)
 			
 			s.on ('end', ok)
+
+			s.on ('data', object => {
 			
-			s.on ('data', table => this.emit (			
-				toBe.has (table.name) ? 'existing' : 'unknown', 
-				table
-			))
+				object.toDo = new Map
+				
+				const event = toBe.has (object.name) ? 'existing' : 'unknown'
+
+				this.emit (event, object)
+				
+			})
 
 		})
 		

package/lib/model/DbColumn.js

@@ -198,7 +198,9 @@ class DbColumn {
 		
 		if (this.type) {
 
-			this.type = lang.getCanonicalTypeName (this.type)
+			this.typeDef = lang.getTypeDefinition (this.type)
+
+			this.type = this.typeDef.name
 
 			this.typeDim = lang.getDbColumnTypeDim (this)
 

package/lib/model/types/DbType.js

@@ -0,0 +1,11 @@
+class DbType {
+
+	constructor (o) {
+	
+		for (const k in o) this [k] = o [k]
+	
+	}
+	
+}
+
+module.exports = DbType

package/lib/model/types/DbTypeArithmetic.js

@@ -0,0 +1,13 @@
+const DbType = require ('./DbType.js')
+
+class DbTypeArithmetic extends DbType {
+
+	constructor (o) {
+	
+		super (o)
+	
+	}
+
+}
+
+module.exports = DbTypeArithmetic

package/lib/model/types/DbTypeArithmeticFixed.js

@@ -0,0 +1,13 @@
+const DbTypeArithmetic = require ('./DbTypeArithmetic.js')
+
+class DbTypeArithmeticFixed extends DbTypeArithmetic {
+
+	constructor (o) {
+
+		super (o)
+
+	}
+
+}
+
+module.exports = DbTypeArithmeticFixed

package/lib/model/types/DbTypeArithmeticFloat.js

@@ -0,0 +1,13 @@
+const DbTypeArithmetic = require ('./DbTypeArithmetic.js')
+
+class DbTypeArithmeticFloat extends DbTypeArithmetic {
+
+	constructor (o) {
+	
+		super (o)
+	
+	}
+
+}
+
+module.exports = DbTypeArithmeticFloat

package/lib/model/types/DbTypeArithmeticInt.js

@@ -0,0 +1,15 @@
+const DbTypeArithmetic = require ('./DbTypeArithmetic.js')
+
+class DbTypeArithmeticInt extends DbTypeArithmetic {
+
+	constructor (o) {
+	
+		super (o)
+		
+		if (!('isSigned' in this)) this.isSigned = true
+	
+	}
+
+}
+
+module.exports = DbTypeArithmeticInt

package/lib/model/types/DbTypeCharacter.js

@@ -0,0 +1,13 @@
+const DbType = require ('./DbType.js')
+
+class DbTypeCharacter extends DbType {
+
+	constructor (o) {
+	
+		super (o)
+	
+	}
+
+}
+
+module.exports = DbTypeCharacter

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doix-db",
-  "version": "0.0.36",
+  "version": "0.0.41",
   "description": "Shared database related code for doix",
   "main": "index.js",
   "files": [