Start to add discovery

This commit is contained in:
Raymond Feng 2013-07-20 23:38:40 -07:00
parent 275405521b
commit 1329b40073
3 changed files with 379 additions and 1 deletions

375
lib/discovery.js Normal file
View File

@ -0,0 +1,375 @@
var MySQL = require('./mysql').MySQL;
function paginateSQL(sql, options) {
options = options || {};
var limit = '';
if(options.offset || options.skip || options.limit) {
limit = 'LIMIT '+ (options.offset || options.skip || 1);
if(options.limit) {
limit = limit + ' ' + options.limit;
}
}
return sql + limit;
}
/**
* Build sql for listing tables
* @param options {all: for all owners, owner: for a given owner}
* @returns {string} The sql statement
*/
function queryTables(options) {
var sqlTables = null;
var owner = options.owner || options.schema;
if (options.all && !owner) {
sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
+ ' FROM information_schema.tables', 'table_schema, table_name', options);
} else if (owner) {
sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name", table_schema AS "owner"'
+ ' FROM information_schema.tables WHERE table_schema=\'' + owner + '\'', 'table_schema, table_name', options);
} else {
sqlTables = paginateSQL('SELECT \'table\' AS "type", table_name AS "name",'
+ ' USER() AS "owner" FROM information_schema.tables',
'table_name', options);
}
return sqlTables;
}
/**
* Build sql for listing views
* @param options {all: for all owners, owner: for a given owner}
* @returns {string} The sql statement
*/
function queryViews(options) {
var sqlViews = null;
if (options.views) {
var owner = options.owner || options.schema;
if (options.all && !owner) {
sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+ ' table_schema AS "owner" FROM information_schema.views',
'table_schema, table_name', options);
} else if (owner) {
sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+ ' table_schema AS "owner" FROM information_schema.views WHERE table_schema=\'' + owner + '\'',
'owner, table_name', options);
} else {
sqlViews = paginateSQL('SELECT \'view\' AS "type", table_name AS "name",'
+ ' USER() AS "owner" FROM information_schema.views',
'table_name', options);
}
}
return sqlViews;
}
/**
* Discover the models
*/
MySQL.prototype.discoverModelDefinitions = function (options, cb) {
if (!cb && typeof options === 'function') {
cb = options;
options = {};
}
options = options || {};
var self = this;
var calls = [function (callback) {
self.query(queryTables(options), callback);
}];
if (options.views) {
calls.push(function (callback) {
self.query(queryViews(options), callback);
});
}
async.parallel(calls, function (err, data) {
if (err) {
cb(err, data);
} else {
var merged = [];
merged = merged.concat(data.shift());
if (data.length) {
merged = merged.concat(data.shift());
}
cb(err, merged);
}
});
}
/**
* Discover the tables/views synchronously
*/
MySQL.prototype.discoverModelDefinitionsSync = function (options) {
options = options || {};
var sqlTables = queryTables(options);
var tables = this.querySync(sqlTables);
var sqlViews = queryViews(options);
if(sqlViews) {
var views = this.querySync(sqlViews);
tables = tables.concat(views);
}
return tables;
}
/**
* Normalize the arguments
* @param table string, required
* @param options object, optional
* @param cb function, optional
*/
function getArgs(table, options, cb) {
if('string' !== typeof table || !table) {
throw new Error('table is a required string argument: ' + table);
}
options = options || {};
if(!cb && 'function' === typeof options) {
cb = options;
options = {};
}
if(typeof options !== 'object') {
throw new Error('options must be an object: ' + options);
}
return {
owner: options.owner || options.schema,
table: table,
options: options,
cb: cb
};
}
/**
* Build the sql statement to query columns for a given table
* @param owner
* @param table
* @returns {String} The sql statement
*/
function queryColumns(owner, table) {
var sql = null;
if (owner) {
sql = paginateSQL('SELECT table_schema AS "owner", table_name AS "tableName", column_name AS "columnName", data_type AS "dataType",'
+ ' data_length AS "dataLength", is_nullable AS "nullable"'
+ ' FROM information_schema.columns'
+ ' WHERE table_schema=\'' + owner + '\''
+ (table ? ' AND table_name=\'' + table + '\'' : ''),
'table_name, column_name', {});
} else {
sql = paginateSQL('SELECT USER() AS "owner", table_name AS "tableName", column_name AS "columnName", data_type AS "dataType",'
+ ' data_length AS "dataLength", is_nullable AS "nullable"'
+ ' FROM information_schema.columns'
+ (table ? ' WHERE table_name=\'' + table + '\'' : ''),
'table_name, column_name', {});
}
return sql;
}
MySQL.prototype.discoverModelProperties = function (table, options, cb) {
var args = getArgs(table, options, cb);
var owner = args.owner;
table = args.table;
options = args.options;
cb = args.cb;
var sql = queryColumns(owner, table);
var callback = function (err, results) {
if (err) {
cb(err, results);
} else {
results.map(function (r) {
r.type = oracleDataTypeToJSONType(r.dataType, r.dataLength);
});
cb(err, results);
}
};
this.query(sql, callback);
}
MySQL.prototype.discoverModelPropertiesSync = function (table, options) {
var args = getArgs(table, options);
var owner = args.owner;
table = args.table;
options = args.options;
var sql = queryColumns(owner, table);
var results = this.querySync(sql);
results.map(function (r) {
r.type = oracleDataTypeToJSONType(r.dataType, r.dataLength);
});
return results;
}
/**
* Build the sql statement for querying primary keys of a given table
* @param owner
* @param table
* @returns {string}
*/
// http://docs.oracle.com/javase/6/docs/api/java/sql/DatabaseMetaData.html#getPrimaryKeys(java.lang.String, java.lang.String, java.lang.String)
function queryForPrimaryKeys(owner, table) {
var sql = 'SELECT table_schema AS "owner", '
+ 'table_name AS "tableName", column_name AS "columnName", ordinal_position AS "keySeq", constraint_name AS "pkName" FROM'
+ ' information_schema.key_column_usage'
+ ' WHERE constraint_name=\'PRIMARY\'';
if (owner) {
sql += ' AND table_schema=\'' + owner + '\'';
}
if (table) {
sql += ' AND table_name=\'' + table + '\'';
}
sql += ' ORDER BY table_schema, constraint_name, table_name, ordinal_position';
return sql;
}
/**
* Discover primary keys for a given table
* @param table
* @param options
* @param cb
*/
MySQL.prototype.discoverPrimaryKeys= function(table, options, cb) {
var args = getArgs(table, options, cb);
var owner = args.owner;
table = args.table;
options = args.options;
cb = args.cb;
var sql = queryForPrimaryKeys(owner, table);
this.query(sql, cb);
}
/**
* Discover primary keys synchronously for a given table
* @param table
* @param options
* @returns {*}
*/
MySQL.prototype.discoverPrimaryKeysSync= function(table, options) {
var args = getArgs(table, options);
var owner = args.owner;
table = args.table;
options = args.options;
var sql = queryForPrimaryKeys(owner, table);
return this.querySync(sql);
}
/**
* Build the sql statement for querying foreign keys of a given table
* @param owner
* @param table
* @returns {string}
*/
function queryForeignKeys(owner, table) {
var sql =
'SELECT table_schema AS "fkOwner", constraint_name AS "fkName", table_name AS "fkTableName",'
+ ' column_name AS "fkColumnName", ordinal_position AS "keySeq",'
+ ' referenced_table_schema AS "pkOwner", \'PRIMARY\' AS "pkName", '
+ ' referenced_table_name AS "pkTableName", referenced_column_name AS "pkColumnName"'
+ ' FROM information_schema.key_column_usage'
+ ' WHERE'
+ ' constraint_name!=\'PRIMARY\' and POSITION_IN_UNIQUE_CONSTRAINT IS NOT NULL';
if (owner) {
sql += ' AND table_schema=\'' + owner + '\'';
}
if (table) {
sql += ' AND table_name=\'' + table + '\'';
}
return sql;
}
/**
* Discover foreign kets for a given table
* @param table
* @param options
* @param cb
*/
MySQL.prototype.discoverForeignKeys= function(table, options, cb) {
var args = getArgs(table, options, cb);
var owner = args.owner;
table = args.table;
options = args.options;
cb = args.cb;
var sql = queryForeignKeys(owner, table);
this.query(sql, cb);
}
/**
* Discover foreign keys synchronously for a given table
* @param owner
* @param options
* @returns {*}
*/
MySQL.prototype.discoverForeignKeysSync= function(table, options) {
var args = getArgs(table, options);
var owner = args.owner;
table = args.table;
options = args.options;
var sql = queryForeignKeys(owner, table);
return this.querySync(sql);
}
/**
* Retrieves a description of the foreign key columns that reference the given table's primary key columns (the foreign keys exported by a table).
* They are ordered by fkTableOwner, fkTableName, and keySeq.
* @param owner
* @param table
* @returns {string}
*/
function queryExportedForeignKeys(owner, table) {
var sql = 'SELECT a.constraint_name AS "fkName", a.owner AS "fkOwner", a.table_name AS "fkTableName",'
+ ' a.column_name AS "fkColumnName", a.position AS "keySeq",'
+ ' jcol.constraint_name AS "pkName", jcol.owner AS "pkOwner",'
+ ' jcol.table_name AS "pkTableName", jcol.column_name AS "pkColumnName"'
+ ' FROM'
+ ' (SELECT'
+ ' uc1.table_name, uc1.constraint_name, uc1.r_constraint_name, col.column_name, col.position, col.owner'
+ ' FROM'
+ ' information_schema.key_column_usage'
+ ' WHERE'
+ ' uc.constraint_type=\'P\' and uc1.r_constraint_name = uc.constraint_name and uc1.constraint_type = \'R\''
+ ' and uc1.constraint_name=col.constraint_name';
if(owner) {
sql += ' and col.owner=\'' + owner + '\'';
}
if(table) {
sql += ' and uc.table_Name=\'' + table + '\'';
}
sql += ' ) a'
+ ' INNER JOIN'
+ ' USER_CONS_COLUMNS jcol'
+ ' ON'
+ ' a.r_constraint_name=jcol.constraint_name'
+ ' order by a.owner, a.table_name, a.position';
return sql;
}
MySQL.prototype.discoverExportedForeignKeys= function(table, options, cb) {
var args = getArgs(table, options, cb);
var owner = args.owner;
table = args.table;
options = args.options;
cb = args.cb;
var sql = queryExportedForeignKeys(owner, table);
this.query(sql, cb);
}
/**
* Discover foreign keys synchronously for a given table
* @param owner
* @param table
* @returns {*}
*/
MySQL.prototype.discoverExportedForeignKeysSync= function(table, options) {
var args = getArgs(table, options);
var owner = args.owner;
table = args.table;
options = args.options;
var sql = queryExportedForeignKeys(owner, table);
return this.querySync(sql);
}

View File

@ -66,6 +66,8 @@ exports.initialize = function initializeSchema(schema, callback) {
};
exports.MySQL = MySQL;
/**
* MySQL adapter
*/
@ -852,3 +854,4 @@ function unsigned(p, dt){
}
return dt;
}

View File

@ -6,7 +6,7 @@ global.getSchema = function() {
var db = new Schema(require('../'), {
host: '127.0.0.1',
port: 3306,
database: 'myapp_test',
database: 'test',
username: 'strongloop',
password: 'password'
});