Start to refactor ADL and DataSource
This commit is contained in:
Raymond Feng
parent
b55cffec34
commit
8263a6d71b
|
|
@ -1,24 +1,24 @@
|
|||
var DataSource = require('../../jugglingdb').Schema;
|
||||
var dataSource = new DataSource();
|
||||
var ADL = require('../../jugglingdb').ADL;
|
||||
var adl = new ADL();
|
||||
// define models
|
||||
var Post = dataSource.define('Post', {
|
||||
var Post = adl.define('Post', {
|
||||
title: { type: String, length: 255 },
|
||||
content: { type: DataSource.Text },
|
||||
content: { type: ADL.Text },
|
||||
date: { type: Date, default: function () { return new Date;} },
|
||||
timestamp: { type: Number, default: Date.now },
|
||||
published: { type: Boolean, default: false, index: true }
|
||||
});
|
||||
|
||||
// simplier way to describe model
|
||||
var User = dataSource.define('User', {
|
||||
var User = adl.define('User', {
|
||||
name: String,
|
||||
bio: DataSource.Text,
|
||||
bio: ADL.Text,
|
||||
approved: Boolean,
|
||||
joinedAt: Date,
|
||||
age: Number
|
||||
});
|
||||
|
||||
var Group = dataSource.define('Group', {name: String});
|
||||
var Group = adl.define('Group', {name: String});
|
||||
|
||||
// define any custom method
|
||||
User.prototype.getNameAndAge = function () {
|
||||
|
|
@ -28,11 +28,9 @@ User.prototype.getNameAndAge = function () {
|
|||
var user = new User({name: 'Joe'});
|
||||
console.log(user);
|
||||
|
||||
console.log(dataSource.models);
|
||||
console.log(dataSource.definitions);
|
||||
|
||||
var user2 = User.create({name: 'Joe'});
|
||||
console.log(user2);
|
||||
console.log(adl.models);
|
||||
console.log(adl.definitions);
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
var DataSource = require('../../jugglingdb').DataSource;
|
||||
var ds = new DataSource('memory');
|
||||
// define models
|
||||
var Post = ds.define('Post', {
|
||||
title: { type: String, length: 255 },
|
||||
content: { type: DataSource.Text },
|
||||
date: { type: Date, default: function () { return new Date;} },
|
||||
timestamp: { type: Number, default: Date.now },
|
||||
published: { type: Boolean, default: false, index: true }
|
||||
});
|
||||
|
||||
// simplier way to describe model
|
||||
var User = ds.define('User', {
|
||||
name: String,
|
||||
bio: DataSource.Text,
|
||||
approved: Boolean,
|
||||
joinedAt: Date,
|
||||
age: Number
|
||||
});
|
||||
|
||||
var Group = ds.define('Group', {name: String});
|
||||
|
||||
// define any custom method
|
||||
User.prototype.getNameAndAge = function () {
|
||||
return this.name + ', ' + this.age;
|
||||
};
|
||||
|
||||
var user = new User({name: 'Joe'});
|
||||
console.log(user);
|
||||
|
||||
console.log(ds.models);
|
||||
console.log(ds.definitions);
|
||||
|
||||
|
||||
|
||||
|
||||
25
index.js
25
index.js
|
|
@ -1,8 +1,10 @@
|
|||
var fs = require('fs');
|
||||
var path = require('path');
|
||||
|
||||
exports.ADL = require('./lib/adl').Schema;
|
||||
exports.Schema = require('./lib/schema').Schema;
|
||||
exports.AbstractClass = require('./lib/model.js');
|
||||
exports.DataSource = require('./lib/datasource').DataSource;
|
||||
exports.ModelBaseClass = require('./lib/model.js');
|
||||
|
||||
var baseSQL = './lib/sql';
|
||||
|
||||
|
|
@ -10,27 +12,6 @@ exports.__defineGetter__('BaseSQL', function () {
|
|||
return require(baseSQL);
|
||||
});
|
||||
|
||||
exports.init = function (rw) {
|
||||
if (global.railway) {
|
||||
global.railway.orm = exports;
|
||||
} else {
|
||||
rw.orm = {Schema: exports.Schema, AbstractClass: exports.AbstractClass};
|
||||
}
|
||||
var railway = './lib/railway';
|
||||
|
||||
if (rw.version > '1.1.5-15') {
|
||||
rw.on('after routes', initialize);
|
||||
} else {
|
||||
initialize();
|
||||
}
|
||||
|
||||
function initialize() {
|
||||
try {
|
||||
var init = require(railway);
|
||||
} catch (e) {}
|
||||
if (init) init(rw);
|
||||
}
|
||||
};
|
||||
|
||||
exports.__defineGetter__('version', function () {
|
||||
return JSON.parse(fs.readFileSync(__dirname + '/package.json')).version;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,326 @@
|
|||
/**
|
||||
* Module dependencies
|
||||
*/
|
||||
var ModelBaseClass = require('./model.js');
|
||||
var DataAccessObject = require('./dao.js');
|
||||
var List = require('./list.js');
|
||||
var EventEmitter = require('events').EventEmitter;
|
||||
var util = require('util');
|
||||
var path = require('path');
|
||||
var fs = require('fs');
|
||||
|
||||
var existsSync = fs.existsSync || path.existsSync;
|
||||
|
||||
/**
|
||||
* Export public API
|
||||
*/
|
||||
exports.Schema = Schema;
|
||||
exports.ADL= new Schema();
|
||||
// exports.ModelBaseClass = ModelBaseClass;
|
||||
|
||||
/**
|
||||
* Helpers
|
||||
*/
|
||||
var slice = Array.prototype.slice;
|
||||
|
||||
Schema.Text = function Text() {};
|
||||
Schema.JSON = function JSON() {};
|
||||
|
||||
Schema.types = {};
|
||||
Schema.registerType = function (type) {
|
||||
this.types[type.name] = type;
|
||||
};
|
||||
|
||||
Schema.registerType(Schema.Text);
|
||||
Schema.registerType(Schema.JSON);
|
||||
|
||||
|
||||
/**
|
||||
* Schema - Data Model Definition
|
||||
*/
|
||||
function Schema() {
|
||||
// create blank models pool
|
||||
this.models = {};
|
||||
this.definitions = {};
|
||||
};
|
||||
|
||||
util.inherits(Schema, EventEmitter);
|
||||
|
||||
|
||||
/**
|
||||
* Define class
|
||||
*
|
||||
* @param {String} className
|
||||
* @param {Object} properties - hash of class properties in format
|
||||
* `{property: Type, property2: Type2, ...}`
|
||||
* or
|
||||
* `{property: {type: Type}, property2: {type: Type2}, ...}`
|
||||
* @param {Object} settings - other configuration of class
|
||||
* @return newly created class
|
||||
*
|
||||
* @example simple case
|
||||
* ```
|
||||
* var User = schema.define('User', {
|
||||
* email: String,
|
||||
* password: String,
|
||||
* birthDate: Date,
|
||||
* activated: Boolean
|
||||
* });
|
||||
* ```
|
||||
* @example more advanced case
|
||||
* ```
|
||||
* var User = schema.define('User', {
|
||||
* email: { type: String, limit: 150, index: true },
|
||||
* password: { type: String, limit: 50 },
|
||||
* birthDate: Date,
|
||||
* registrationDate: {type: Date, default: function () { return new Date }},
|
||||
* activated: { type: Boolean, default: false }
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
Schema.prototype.define = function defineClass(className, properties, settings) {
|
||||
var schema = this;
|
||||
var args = slice.call(arguments);
|
||||
|
||||
if (!className) throw new Error('Class name required');
|
||||
if (args.length == 1) properties = {}, args.push(properties);
|
||||
if (args.length == 2) settings = {}, args.push(settings);
|
||||
|
||||
properties = properties || {};
|
||||
settings = settings || {};
|
||||
|
||||
// every class can receive hash of data as optional param
|
||||
var ModelClass = function ModelConstructor(data, schema) {
|
||||
if (!(this instanceof ModelConstructor)) {
|
||||
return new ModelConstructor(data);
|
||||
}
|
||||
ModelBaseClass.call(this, data);
|
||||
hiddenProperty(this, 'schema', schema || this.constructor.schema);
|
||||
};
|
||||
|
||||
hiddenProperty(ModelClass, 'schema', schema);
|
||||
hiddenProperty(ModelClass, 'modelName', className);
|
||||
hiddenProperty(ModelClass, 'relations', {});
|
||||
|
||||
// inherit ModelBaseClass methods
|
||||
for (var i in ModelBaseClass) {
|
||||
ModelClass[i] = ModelBaseClass[i];
|
||||
}
|
||||
for (var j in ModelBaseClass.prototype) {
|
||||
ModelClass.prototype[j] = ModelBaseClass.prototype[j];
|
||||
}
|
||||
|
||||
ModelClass.getter = {};
|
||||
ModelClass.setter = {};
|
||||
|
||||
standartize(properties, settings);
|
||||
|
||||
// store class in model pool
|
||||
this.models[className] = ModelClass;
|
||||
this.definitions[className] = {
|
||||
properties: properties,
|
||||
settings: settings
|
||||
};
|
||||
|
||||
ModelClass.prototype.__defineGetter__('id', function () {
|
||||
return this.__data.id;
|
||||
});
|
||||
|
||||
properties.id = properties.id || { type: Number };
|
||||
|
||||
ModelClass.forEachProperty = function (cb) {
|
||||
Object.keys(properties).forEach(cb);
|
||||
};
|
||||
|
||||
ModelClass.registerProperty = function (attr) {
|
||||
var DataType = properties[attr].type;
|
||||
if(!DataType) {
|
||||
console.error('Not found: ' + attr);
|
||||
}
|
||||
if (DataType instanceof Array) {
|
||||
DataType = List;
|
||||
} else if (DataType.name === 'Date') {
|
||||
var OrigDate = Date;
|
||||
DataType = function Date(arg) {
|
||||
return new OrigDate(arg);
|
||||
};
|
||||
} else if (DataType.name === 'JSON' || DataType === JSON) {
|
||||
DataType = function JSON(s) {
|
||||
return s;
|
||||
};
|
||||
} else if (DataType.name === 'Text' || DataType === Schema.Text) {
|
||||
DataType = function Text(s) {
|
||||
return s;
|
||||
};
|
||||
}
|
||||
|
||||
Object.defineProperty(ModelClass.prototype, attr, {
|
||||
get: function () {
|
||||
if (ModelClass.getter[attr]) {
|
||||
return ModelClass.getter[attr].call(this);
|
||||
} else {
|
||||
return this.__data[attr];
|
||||
}
|
||||
},
|
||||
set: function (value) {
|
||||
if (ModelClass.setter[attr]) {
|
||||
ModelClass.setter[attr].call(this, value);
|
||||
} else {
|
||||
if (value === null || value === undefined) {
|
||||
this.__data[attr] = value;
|
||||
} else {
|
||||
this.__data[attr] = DataType(value);
|
||||
}
|
||||
}
|
||||
},
|
||||
configurable: true,
|
||||
enumerable: true
|
||||
});
|
||||
|
||||
ModelClass.prototype.__defineGetter__(attr + '_was', function () {
|
||||
return this.__dataWas[attr];
|
||||
});
|
||||
|
||||
Object.defineProperty(ModelClass.prototype, '_' + attr, {
|
||||
get: function () {
|
||||
return this.__data[attr];
|
||||
},
|
||||
set: function (value) {
|
||||
this.__data[attr] = value;
|
||||
},
|
||||
configurable: true,
|
||||
enumerable: false
|
||||
});
|
||||
};
|
||||
|
||||
ModelClass.forEachProperty(ModelClass.registerProperty);
|
||||
|
||||
return ModelClass;
|
||||
|
||||
};
|
||||
|
||||
function standartize(properties, settings) {
|
||||
Object.keys(properties).forEach(function (key) {
|
||||
var v = properties[key];
|
||||
if (
|
||||
typeof v === 'function' ||
|
||||
typeof v === 'object' && v && v.constructor.name === 'Array'
|
||||
) {
|
||||
properties[key] = { type: v };
|
||||
}
|
||||
});
|
||||
// TODO: add timestamps fields
|
||||
// when present in settings: {timestamps: true}
|
||||
// or {timestamps: {created: 'created_at', updated: false}}
|
||||
// by default property names: createdAt, updatedAt
|
||||
}
|
||||
|
||||
/**
|
||||
* Define single property named `prop` on `model`
|
||||
*
|
||||
* @param {String} model - name of model
|
||||
* @param {String} prop - name of propery
|
||||
* @param {Object} params - property settings
|
||||
*/
|
||||
Schema.prototype.defineProperty = function (model, prop, params) {
|
||||
this.definitions[model].properties[prop] = params;
|
||||
this.models[model].registerProperty(prop);
|
||||
if (this.adapter.defineProperty) {
|
||||
this.adapter.defineProperty(model, prop, params);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Extend existing model with bunch of properties
|
||||
*
|
||||
* @param {String} model - name of model
|
||||
* @param {Object} props - hash of properties
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* // Instead of doing this:
|
||||
*
|
||||
* // amend the content model with competition attributes
|
||||
* db.defineProperty('Content', 'competitionType', { type: String });
|
||||
* db.defineProperty('Content', 'expiryDate', { type: Date, index: true });
|
||||
* db.defineProperty('Content', 'isExpired', { type: Boolean, index: true });
|
||||
*
|
||||
* // schema.extend allows to
|
||||
* // extend the content model with competition attributes
|
||||
* db.extendModel('Content', {
|
||||
* competitionType: String,
|
||||
* expiryDate: { type: Date, index: true },
|
||||
* isExpired: { type: Boolean, index: true }
|
||||
* });
|
||||
*/
|
||||
Schema.prototype.extendModel = function (model, props) {
|
||||
var t = this;
|
||||
standartize(props, {});
|
||||
Object.keys(props).forEach(function (propName) {
|
||||
var definition = props[propName];
|
||||
t.defineProperty(model, propName, definition);
|
||||
});
|
||||
};
|
||||
|
||||
|
||||
|
||||
Schema.prototype.copyModel = function copyModel(Master) {
|
||||
var schema = this;
|
||||
var className = Master.modelName;
|
||||
var md = Master.schema.definitions[className];
|
||||
var Slave = function SlaveModel() {
|
||||
Master.apply(this, [].slice.call(arguments));
|
||||
this.schema = schema;
|
||||
};
|
||||
|
||||
util.inherits(Slave, Master);
|
||||
|
||||
Slave.__proto__ = Master;
|
||||
|
||||
hiddenProperty(Slave, 'schema', schema);
|
||||
hiddenProperty(Slave, 'modelName', className);
|
||||
hiddenProperty(Slave, 'relations', Master.relations);
|
||||
|
||||
if (!(className in schema.models)) {
|
||||
|
||||
// store class in model pool
|
||||
schema.models[className] = Slave;
|
||||
schema.definitions[className] = {
|
||||
properties: md.properties,
|
||||
settings: md.settings
|
||||
};
|
||||
}
|
||||
|
||||
return Slave;
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Define hidden property
|
||||
*/
|
||||
function hiddenProperty(where, property, value) {
|
||||
Object.defineProperty(where, property, {
|
||||
writable: false,
|
||||
enumerable: false,
|
||||
configurable: false,
|
||||
value: value
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Define readonly property on object
|
||||
*
|
||||
* @param {Object} obj
|
||||
* @param {String} key
|
||||
* @param {Mixed} value
|
||||
*/
|
||||
function defineReadonlyProp(obj, key, value) {
|
||||
Object.defineProperty(obj, key, {
|
||||
writable: false,
|
||||
enumerable: true,
|
||||
configurable: true,
|
||||
value: value
|
||||
});
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,496 @@
|
|||
/**
|
||||
* Module dependencies
|
||||
*/
|
||||
var ADL = require('./adl.js').Schema;
|
||||
var ModelBaseClass = require('./model.js');
|
||||
var DataAccessObject = require('./dao.js');
|
||||
var List = require('./list.js');
|
||||
var EventEmitter = require('events').EventEmitter;
|
||||
var util = require('util');
|
||||
var path = require('path');
|
||||
var fs = require('fs');
|
||||
|
||||
var existsSync = fs.existsSync || path.existsSync;
|
||||
|
||||
/**
|
||||
* Export public API
|
||||
*/
|
||||
exports.DataSource = DataSource;
|
||||
|
||||
/**
|
||||
* Helpers
|
||||
*/
|
||||
var slice = Array.prototype.slice;
|
||||
|
||||
/**
|
||||
* DataSource - adapter-specific classes factory.
|
||||
*
|
||||
* All classes in single schema shares same adapter type and
|
||||
* one database connection
|
||||
*
|
||||
* @param name - type of schema adapter (mysql, mongoose, sequelize, redis)
|
||||
* @param settings - any database-specific settings which we need to
|
||||
* establish connection (of course it depends on specific adapter)
|
||||
*
|
||||
* - host
|
||||
* - port
|
||||
* - username
|
||||
* - password
|
||||
* - database
|
||||
* - debug {Boolean} = false
|
||||
*
|
||||
* @example DataSource creation, waiting for connection callback
|
||||
* ```
|
||||
* var schema = new DataSource('mysql', { database: 'myapp_test' });
|
||||
* schema.define(...);
|
||||
* schema.on('connected', function () {
|
||||
* // work with database
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
function DataSource(name, settings) {
|
||||
if (!(this instanceof DataSource)) {
|
||||
return new DataSource(name, settings);
|
||||
}
|
||||
ADL.call(this);
|
||||
this.setup(name, settings);
|
||||
};
|
||||
|
||||
util.inherits(DataSource, ADL);
|
||||
|
||||
// Copy over statics
|
||||
for (var m in ADL) {
|
||||
if (!DataSource[m]) {
|
||||
DataSource[m] = ADL[m];
|
||||
}
|
||||
}
|
||||
|
||||
DataSource.prototype.setup = function(name, settings) {
|
||||
var schema = this;
|
||||
|
||||
// just save everything we get
|
||||
this.name = name;
|
||||
this.settings = settings;
|
||||
|
||||
// Disconnected by default
|
||||
this.connected = false;
|
||||
this.connecting = false;
|
||||
|
||||
if (name) {
|
||||
// and initialize schema using adapter
|
||||
// this is only one initialization entry point of adapter
|
||||
// this module should define `adapter` member of `this` (schema)
|
||||
var adapter;
|
||||
if (typeof name === 'object') {
|
||||
adapter = name;
|
||||
this.name = adapter.name;
|
||||
} else if (name.match(/^\//)) {
|
||||
// try absolute path
|
||||
adapter = require(name);
|
||||
} else if (existsSync(__dirname + '/adapters/' + name + '.js')) {
|
||||
// try built-in adapter
|
||||
adapter = require('./adapters/' + name);
|
||||
} else {
|
||||
// try foreign adapter
|
||||
try {
|
||||
adapter = require('jugglingdb-' + name);
|
||||
} catch (e) {
|
||||
return console.log('\nWARNING: JugglingDB adapter "' + name + '" is not installed,\nso your models would not work, to fix run:\n\n npm install jugglingdb-' + name, '\n');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (adapter) {
|
||||
adapter.initialize(this, function () {
|
||||
|
||||
// we have an adaper now?
|
||||
if (!this.adapter) {
|
||||
throw new Error('Adapter is not defined correctly: it should create `adapter` member of schema');
|
||||
}
|
||||
|
||||
this.adapter.log = function (query, start) {
|
||||
schema.log(query, start);
|
||||
};
|
||||
|
||||
this.adapter.logger = function (query) {
|
||||
var t1 = Date.now();
|
||||
var log = this.log;
|
||||
return function (q) {
|
||||
log(q || query, t1);
|
||||
};
|
||||
};
|
||||
|
||||
this.connected = true;
|
||||
this.emit('connected');
|
||||
|
||||
}.bind(this));
|
||||
}
|
||||
|
||||
schema.connect = function(cb) {
|
||||
var schema = this;
|
||||
schema.connecting = true;
|
||||
if (schema.adapter.connect) {
|
||||
schema.adapter.connect(function(err) {
|
||||
if (!err) {
|
||||
schema.connected = true;
|
||||
schema.connecting = false;
|
||||
schema.emit('connected');
|
||||
}
|
||||
if (cb) {
|
||||
cb(err);
|
||||
}
|
||||
});
|
||||
} else {
|
||||
if (cb) {
|
||||
process.nextTick(cb);
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Define class
|
||||
*
|
||||
* @param {String} className
|
||||
* @param {Object} properties - hash of class properties in format
|
||||
* `{property: Type, property2: Type2, ...}`
|
||||
* or
|
||||
* `{property: {type: Type}, property2: {type: Type2}, ...}`
|
||||
* @param {Object} settings - other configuration of class
|
||||
* @return newly created class
|
||||
*
|
||||
* @example simple case
|
||||
* ```
|
||||
* var User = schema.define('User', {
|
||||
* email: String,
|
||||
* password: String,
|
||||
* birthDate: Date,
|
||||
* activated: Boolean
|
||||
* });
|
||||
* ```
|
||||
* @example more advanced case
|
||||
* ```
|
||||
* var User = schema.define('User', {
|
||||
* email: { type: String, limit: 150, index: true },
|
||||
* password: { type: String, limit: 50 },
|
||||
* birthDate: Date,
|
||||
* registrationDate: {type: Date, default: function () { return new Date }},
|
||||
* activated: { type: Boolean, default: false }
|
||||
* });
|
||||
* ```
|
||||
*/
|
||||
DataSource.prototype.define = function defineClass(className, properties, settings) {
|
||||
var NewClass = ADL.prototype.define.call(this, className, properties, settings);
|
||||
|
||||
// inherit DataAccessObject methods
|
||||
for (var m in DataAccessObject) {
|
||||
NewClass[m] = DataAccessObject[m];
|
||||
}
|
||||
for (var n in DataAccessObject.prototype) {
|
||||
NewClass.prototype[n] = DataAccessObject.prototype[n];
|
||||
}
|
||||
|
||||
if(this.adapter) {
|
||||
// pass control to adapter
|
||||
this.adapter.define({
|
||||
model: NewClass,
|
||||
properties: properties,
|
||||
settings: settings
|
||||
});
|
||||
}
|
||||
|
||||
return NewClass;
|
||||
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* Drop each model table and re-create.
|
||||
* This method make sense only for sql adapters.
|
||||
*
|
||||
* @warning All data will be lost! Use autoupdate if you need your data.
|
||||
*/
|
||||
DataSource.prototype.automigrate = function (cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.automigrate) {
|
||||
this.adapter.automigrate(cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Update existing database tables.
|
||||
* This method make sense only for sql adapters.
|
||||
*/
|
||||
DataSource.prototype.autoupdate = function (cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.autoupdate) {
|
||||
this.adapter.autoupdate(cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Discover existing database tables.
|
||||
* This method returns an array of model objects, including {type, name, onwer}
|
||||
*
|
||||
* @param options An object that contains the following settings:
|
||||
* all: true - Discovering all models, false - Discovering the models owned by the current user
|
||||
* views: true - Including views, false - only tables
|
||||
* limit: The page size
|
||||
* offset: The starting index
|
||||
*/
|
||||
DataSource.prototype.discoverModels = function (options, cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.discoverModels) {
|
||||
this.adapter.discoverModels(options, cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Discover properties for a given model.
|
||||
* @param options An object that contains the following settings:
|
||||
* model: The model name
|
||||
* limit: The page size
|
||||
* offset: The starting index
|
||||
* The method return an array of properties, including {owner, tableName, columnName, dataType, dataLength, nullable}
|
||||
*/
|
||||
DataSource.prototype.discoverModelProperties = function (options, cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.discoverModelProperties) {
|
||||
this.adapter.discoverModelProperties(options, cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Discover primary keys for a given owner/table
|
||||
*
|
||||
* Each primary key column description has the following columns:
|
||||
* TABLE_SCHEM String => table schema (may be null)
|
||||
* TABLE_NAME String => table name
|
||||
* COLUMN_NAME String => column name
|
||||
* KEY_SEQ short => sequence number within primary key( a value of 1 represents the first column of the primary key, a value of 2 would represent the second column within the primary key).
|
||||
* PK_NAME String => primary key name (may be null)
|
||||
*
|
||||
* @param owner
|
||||
* @param table
|
||||
* @param cb
|
||||
*/
|
||||
DataSource.prototype.discoverPrimaryKeys= function(owner, table, cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.discoverPrimaryKeys) {
|
||||
this.adapter.discoverPrimaryKeys(owner, table, cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Discover foreign keys for a given owner/table
|
||||
*
|
||||
* PKTABLE_SCHEM String => primary key table schema being imported (may be null)
|
||||
* PKTABLE_NAME String => primary key table name being imported
|
||||
* PKCOLUMN_NAME String => primary key column name being imported
|
||||
* FKTABLE_CAT String => foreign key table catalog (may be null)
|
||||
* FKTABLE_SCHEM String => foreign key table schema (may be null)
|
||||
* FKTABLE_NAME String => foreign key table name
|
||||
* FKCOLUMN_NAME String => foreign key column name
|
||||
* KEY_SEQ short => sequence number within a foreign key( a value of 1 represents the first column of the foreign key, a value of 2 would represent the second column within the foreign key).
|
||||
* FK_NAME String => foreign key name (may be null)
|
||||
* PK_NAME String => primary key name (may be null)
|
||||
*
|
||||
* @param owner
|
||||
* @param table
|
||||
* @param cb
|
||||
*/
|
||||
DataSource.prototype.discoverForeignKeys= function(owner, table, cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.discoverForeignKeys) {
|
||||
this.adapter.discoverForeignKeys(owner, table, cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether migrations needed
|
||||
* This method make sense only for sql adapters.
|
||||
*/
|
||||
DataSource.prototype.isActual = function (cb) {
|
||||
this.freeze();
|
||||
if (this.adapter.isActual) {
|
||||
this.adapter.isActual(cb);
|
||||
} else if (cb) {
|
||||
cb(null, true);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Log benchmarked message. Do not redefine this method, if you need to grab
|
||||
* chema logs, use `schema.on('log', ...)` emitter event
|
||||
*
|
||||
* @private used by adapters
|
||||
*/
|
||||
DataSource.prototype.log = function (sql, t) {
|
||||
this.emit('log', sql, t);
|
||||
};
|
||||
|
||||
/**
|
||||
* Freeze schema. Behavior depends on adapter
|
||||
*/
|
||||
DataSource.prototype.freeze = function freeze() {
|
||||
if (this.adapter.freezeSchema) {
|
||||
this.adapter.freezeSchema();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return table name for specified `modelName`
|
||||
* @param {String} modelName
|
||||
*/
|
||||
DataSource.prototype.tableName = function (modelName) {
|
||||
return this.definitions[modelName].settings.table = this.definitions[modelName].settings.table || modelName
|
||||
};
|
||||
|
||||
/**
|
||||
* Define foreign key
|
||||
* @param {String} className
|
||||
* @param {String} key - name of key field
|
||||
*/
|
||||
DataSource.prototype.defineForeignKey = function defineForeignKey(className, key, foreignClassName) {
|
||||
// quit if key already defined
|
||||
if (this.definitions[className].properties[key]) return;
|
||||
|
||||
if (this.adapter.defineForeignKey) {
|
||||
var cb = function (err, keyType) {
|
||||
if (err) throw err;
|
||||
this.definitions[className].properties[key] = {type: keyType};
|
||||
}.bind(this);
|
||||
switch (this.adapter.defineForeignKey.length) {
|
||||
case 4:
|
||||
this.adapter.defineForeignKey(className, key, foreignClassName, cb);
|
||||
break;
|
||||
default:
|
||||
case 3:
|
||||
this.adapter.defineForeignKey(className, key, cb);
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
this.definitions[className].properties[key] = {type: Number};
|
||||
}
|
||||
this.models[className].registerProperty(key);
|
||||
};
|
||||
|
||||
/**
|
||||
* Close database connection
|
||||
*/
|
||||
DataSource.prototype.disconnect = function disconnect(cb) {
|
||||
if (typeof this.adapter.disconnect === 'function') {
|
||||
this.connected = false;
|
||||
this.adapter.disconnect(cb);
|
||||
} else if (cb) {
|
||||
cb();
|
||||
}
|
||||
};
|
||||
|
||||
DataSource.prototype.copyModel = function copyModel(Master) {
|
||||
var schema = this;
|
||||
var className = Master.modelName;
|
||||
var md = Master.schema.definitions[className];
|
||||
var Slave = function SlaveModel() {
|
||||
Master.apply(this, [].slice.call(arguments));
|
||||
this.schema = schema;
|
||||
};
|
||||
|
||||
util.inherits(Slave, Master);
|
||||
|
||||
Slave.__proto__ = Master;
|
||||
|
||||
hiddenProperty(Slave, 'schema', schema);
|
||||
hiddenProperty(Slave, 'modelName', className);
|
||||
hiddenProperty(Slave, 'relations', Master.relations);
|
||||
|
||||
if (!(className in schema.models)) {
|
||||
|
||||
// store class in model pool
|
||||
schema.models[className] = Slave;
|
||||
schema.definitions[className] = {
|
||||
properties: md.properties,
|
||||
settings: md.settings
|
||||
};
|
||||
|
||||
if (!schema.isTransaction) {
|
||||
schema.adapter.define({
|
||||
model: Slave,
|
||||
properties: md.properties,
|
||||
settings: md.settings
|
||||
});
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return Slave;
|
||||
};
|
||||
|
||||
DataSource.prototype.transaction = function() {
|
||||
var schema = this;
|
||||
var transaction = new EventEmitter;
|
||||
transaction.isTransaction = true;
|
||||
transaction.origin = schema;
|
||||
transaction.name = schema.name;
|
||||
transaction.settings = schema.settings;
|
||||
transaction.connected = false;
|
||||
transaction.connecting = false;
|
||||
transaction.adapter = schema.adapter.transaction();
|
||||
|
||||
// create blank models pool
|
||||
transaction.models = {};
|
||||
transaction.definitions = {};
|
||||
|
||||
for (var i in schema.models) {
|
||||
schema.copyModel.call(transaction, schema.models[i]);
|
||||
}
|
||||
|
||||
transaction.connect = schema.connect;
|
||||
|
||||
transaction.exec = function(cb) {
|
||||
transaction.adapter.exec(cb);
|
||||
};
|
||||
|
||||
return transaction;
|
||||
};
|
||||
|
||||
/**
|
||||
* Define hidden property
|
||||
*/
|
||||
function hiddenProperty(where, property, value) {
|
||||
Object.defineProperty(where, property, {
|
||||
writable: false,
|
||||
enumerable: false,
|
||||
configurable: false,
|
||||
value: value
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Define readonly property on object
|
||||
*
|
||||
* @param {Object} obj
|
||||
* @param {String} key
|
||||
* @param {Mixed} value
|
||||
*/
|
||||
function defineReadonlyProp(obj, key, value) {
|
||||
Object.defineProperty(obj, key, {
|
||||
writable: false,
|
||||
enumerable: true,
|
||||
configurable: true,
|
||||
value: value
|
||||
});
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue