Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit 9775f361 by Mick Hansen
Options

Merge pull request #4796 from faceleg/feature/postgres-schema 

Initial modifications to get enums working with postgres schemas
2 parents e0a1d7b8 d4e2ee20
Inline Side-by-side
Showing with 69 additions and 36 deletions
changelog.md
# Next # Next
- [FIXED] Apply scopes to `aggregate` [#4764](https://github.com/sequelize/sequelize/issues/4764) - [FIXED] Apply scopes to `aggregate` [#4764](https://github.com/sequelize/sequelize/issues/4764)
- [FIXED] Improved postgres enum schema handling [#4796](https://github.com/sequelize/sequelize/issues/4796)
- [ADDED/FIXED] Lower case `onDelete` option to allow the use of `onDelete: 'CASCADE', hooks: true`. - [ADDED/FIXED] Lower case `onDelete` option to allow the use of `onDelete: 'CASCADE', hooks: true`.
# 3.13.0 # 3.13.0
......
lib/dialects/abstract/query-generator.js
...@@ -19,6 +19,16 @@ var throwMethodUndefined = function(methodName) { ...@@ -19,6 +19,16 @@ var throwMethodUndefined = function(methodName) {
var QueryGenerator = { var QueryGenerator = {
options: {}, options: {},
extractTableDetails: function(tableName, options) {
options = options || {};
tableName = tableName || {};
return {
schema: tableName.schema || options.schema || 'public',
tableName: _.isPlainObject(tableName) ? tableName.table : tableName,
delimiter: tableName.delimiter || options.delimiter || '.'
};
},
addSchema: function(param) { addSchema: function(param) {
var self = this; var self = this;
......
lib/dialects/postgres/query-generator.js
...@@ -5,8 +5,7 @@ var Utils = require('../../utils') ...@@ -5,8 +5,7 @@ var Utils = require('../../utils')
, util = require('util') , util = require('util')
, DataTypes = require('../../data-types') , DataTypes = require('../../data-types')
, AbstractQueryGenerator = require('../abstract/query-generator') , AbstractQueryGenerator = require('../abstract/query-generator')
, primaryKeys = {} , primaryKeys = {};
, _ = require('lodash');
var QueryGenerator = { var QueryGenerator = {
options: {}, options: {},
...@@ -719,34 +718,36 @@ var QueryGenerator = { ...@@ -719,34 +718,36 @@ var QueryGenerator = {
pgEnumName: function (tableName, attr, options) { pgEnumName: function (tableName, attr, options) {
options = options || {}; options = options || {};
var tableDetails = this.extractTableDetails(tableName, options)
, enumName = '"enum_' + tableDetails.tableName + '_' + attr + '"';
var enumName = '"enum_' + (_.isPlainObject(tableName) ? tableName.table : tableName) + '_' + attr + '"'; // pgListEnums requires the enum name only, without the schema
if (options.schema !== false && tableDetails.schema) {
if (options.schema !== false && tableName && tableName.schema) { enumName = this.quoteIdentifier(tableDetails.schema) + tableDetails.delimiter + enumName;
enumName = '"' + tableName.schema + '"' + tableName.delimiter + enumName;
} }
return enumName; return enumName;
}, },
pgListEnums: function(tableName, attrName) { pgListEnums: function(tableName, attrName, options) {
var enumName = '' var enumName = ''
, schema = tableName && tableName.schema ? tableName.schema : 'public'; , tableDetails = this.extractTableDetails(tableName, options);
if (!!tableName && !!attrName) { if (tableDetails.tableName && attrName) {
enumName = ' AND t.typname=' + this.pgEnumName(tableName, attrName, { schema: false }).replace(/"/g, "'"); enumName = ' AND t.typname=' + this.pgEnumName(tableDetails.tableName, attrName, { schema: false }).replace(/"/g, "'");
} }
var query = 'SELECT t.typname enum_name, array_agg(e.enumlabel) enum_value FROM pg_type t ' + var query = 'SELECT t.typname enum_name, array_agg(e.enumlabel) enum_value FROM pg_type t ' +
'JOIN pg_enum e ON t.oid = e.enumtypid ' + 'JOIN pg_enum e ON t.oid = e.enumtypid ' +
'JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace ' + 'JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace ' +
"WHERE n.nspname = '" + schema + "'" + enumName + ' GROUP BY 1'; "WHERE n.nspname = '" + tableDetails.schema + "'" + enumName + ' GROUP BY 1';
return query; return query;
}, },
pgEnum: function(tableName, attr, dataType, options) { pgEnum: function(tableName, attr, dataType, options) {
var enumName = this.pgEnumName(tableName, attr) var enumName = this.pgEnumName(tableName, attr, options)
, values; , values;
if (dataType.values) { if (dataType.values) {
......
lib/instance-validator.js
...@@ -64,10 +64,12 @@ InstanceValidator.prototype.validate = function() { ...@@ -64,10 +64,12 @@ InstanceValidator.prototype.validate = function() {
this.inProgress = true; this.inProgress = true;
var self = this; var self = this;
return Promise.settle([ return Promise.all([
self._builtinValidators(), self._builtinValidators(),
self._customValidators() self._customValidators()
]).then(function() { ].map(function(promise) {
return promise.reflect();
})).then(function() {
if (self.errors.length) { if (self.errors.length) {
return new sequelizeError.ValidationError(null, self.errors); return new sequelizeError.ValidationError(null, self.errors);
} }
...@@ -98,7 +100,7 @@ InstanceValidator.prototype.hookValidate = function() { ...@@ -98,7 +100,7 @@ InstanceValidator.prototype.hookValidate = function() {
/** /**
* Will run all the built-in validators. * Will run all the built-in validators.
* *
* @return {Promise(Array.<Promise.PromiseInspection>)} A promise from .settle(). * @return {Promise(Array.<Promise.PromiseInspection>)} A promise from .reflect().
* @private * @private
*/ */
InstanceValidator.prototype._builtinValidators = function() { InstanceValidator.prototype._builtinValidators = function() {
...@@ -119,17 +121,17 @@ InstanceValidator.prototype._builtinValidators = function() { ...@@ -119,17 +121,17 @@ InstanceValidator.prototype._builtinValidators = function() {
} }
if (self.modelInstance.validators.hasOwnProperty(field)) { if (self.modelInstance.validators.hasOwnProperty(field)) {
validators.push(self._builtinAttrValidate.call(self, value, field)); validators.push(self._builtinAttrValidate.call(self, value, field).reflect());
} }
}); });
return Promise.settle(validators); return Promise.all(validators);
}; };
/** /**
* Will run all the custom validators. * Will run all the custom validators.
* *
* @return {Promise(Array.<Promise.PromiseInspection>)} A promise from .settle(). * @return {Promise(Array.<Promise.PromiseInspection>)} A promise from .reflect().
* @private * @private
*/ */
InstanceValidator.prototype._customValidators = function() { InstanceValidator.prototype._customValidators = function() {
...@@ -142,12 +144,13 @@ InstanceValidator.prototype._customValidators = function() { ...@@ -142,12 +144,13 @@ InstanceValidator.prototype._customValidators = function() {
var valprom = self._invokeCustomValidator(validator, validatorType) var valprom = self._invokeCustomValidator(validator, validatorType)
// errors are handled in settling, stub this // errors are handled in settling, stub this
.catch(function() {}); .catch(function() {})
.reflect();
validators.push(valprom); validators.push(valprom);
}); });
return Promise.settle(validators); return Promise.all(validators);
}; };
/** /**
...@@ -184,16 +187,16 @@ InstanceValidator.prototype._builtinAttrValidate = function(value, field) { ...@@ -184,16 +187,16 @@ InstanceValidator.prototype._builtinAttrValidate = function(value, field) {
// Check for custom validator. // Check for custom validator.
if (typeof test === 'function') { if (typeof test === 'function') {
return validators.push(self._invokeCustomValidator(test, validatorType, true, value, field)); return validators.push(self._invokeCustomValidator(test, validatorType, true, value, field).reflect());
} }
var validatorPromise = self._invokeBuiltinValidator(value, test, validatorType, field); var validatorPromise = self._invokeBuiltinValidator(value, test, validatorType, field);
// errors are handled in settling, stub this // errors are handled in settling, stub this
validatorPromise.catch(function() {}); validatorPromise.catch(function() {});
validators.push(validatorPromise); validators.push(validatorPromise.reflect());
}); });
return Promise.settle(validators).then(this._handleSettledResult.bind(this, field)); return Promise.all(validators).then(this._handleReflectedResult.bind(this, field));
}; };
/** /**
...@@ -299,7 +302,7 @@ InstanceValidator.prototype._validateSchema = function(rawAttribute, field, valu ...@@ -299,7 +302,7 @@ InstanceValidator.prototype._validateSchema = function(rawAttribute, field, valu
/** /**
* Handles the returned result of a Promise.settle. * Handles the returned result of a Promise.reflect.
* *
* If errors are found it populates this.error. * If errors are found it populates this.error.
* *
...@@ -307,7 +310,7 @@ InstanceValidator.prototype._validateSchema = function(rawAttribute, field, valu ...@@ -307,7 +310,7 @@ InstanceValidator.prototype._validateSchema = function(rawAttribute, field, valu
* @param {Array.<Promise.PromiseInspection>} Promise inspection objects. * @param {Array.<Promise.PromiseInspection>} Promise inspection objects.
* @private * @private
*/ */
InstanceValidator.prototype._handleSettledResult = function(field, promiseInspections) { InstanceValidator.prototype._handleReflectedResult = function(field, promiseInspections) {
var self = this; var self = this;
promiseInspections.forEach(function(promiseInspection) { promiseInspections.forEach(function(promiseInspection) {
if (promiseInspection.isRejected()) { if (promiseInspection.isRejected()) {
......
lib/model.js
...@@ -2436,6 +2436,7 @@ Model.prototype.update = function(values, options) { ...@@ -2436,6 +2436,7 @@ Model.prototype.update = function(values, options) {
} }
}); });
} }
return null;
}).then(function() { }).then(function() {
// Run before hook // Run before hook
if (options.hooks) { if (options.hooks) {
......
lib/query-interface.js
...@@ -93,7 +93,7 @@ QueryInterface.prototype.createTable = function(tableName, attributes, options, ...@@ -93,7 +93,7 @@ QueryInterface.prototype.createTable = function(tableName, attributes, options,
for (i = 0; i < keyLen; i++) { for (i = 0; i < keyLen; i++) {
if (attributes[keys[i]].type instanceof DataTypes.ENUM) { if (attributes[keys[i]].type instanceof DataTypes.ENUM) {
sql = self.QueryGenerator.pgListEnums(tableName, attributes[keys[i]].field || keys[i]); sql = self.QueryGenerator.pgListEnums(tableName, attributes[keys[i]].field || keys[i], options);
promises.push(self.sequelize.query( promises.push(self.sequelize.query(
sql, { plain: true, raw: true, type: QueryTypes.SELECT, logging: options.logging, transaction: options.transaction } sql, { plain: true, raw: true, type: QueryTypes.SELECT, logging: options.logging, transaction: options.transaction }
)); ));
......
package.json
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
"url": "https://github.com/sequelize/sequelize/issues" "url": "https://github.com/sequelize/sequelize/issues"
}, },
"dependencies": { "dependencies": {
"bluebird": "^3.0.0", "bluebird": "^3.0.5",
"depd": "^1.0.0", "depd": "^1.0.0",
"dottie": "^1.0.0", "dottie": "^1.0.0",
"generic-pool": "2.2.1", "generic-pool": "2.2.1",
......
test/integration/dialects/postgres/dao.test.js
...@@ -390,15 +390,15 @@ if (dialect.match(/^postgres/)) { ...@@ -390,15 +390,15 @@ if (dialect.match(/^postgres/)) {
return User.sync({ return User.sync({
logging: function (sql) { logging: function (sql) {
if (sql.indexOf('neutral') > -1) { if (sql.indexOf('neutral') > -1) {
expect(sql.indexOf("ALTER TYPE \"enum_UserEnums_mood\" ADD VALUE 'neutral' BEFORE 'happy'")).to.not.be.equal(-1); expect(sql.indexOf("ALTER TYPE \"public\".\"enum_UserEnums_mood\" ADD VALUE 'neutral' BEFORE 'happy'")).to.not.be.equal(-1);
count++; count++;
} }
else if (sql.indexOf('ecstatic') > -1) { else if (sql.indexOf('ecstatic') > -1) {
expect(sql.indexOf("ALTER TYPE \"enum_UserEnums_mood\" ADD VALUE 'ecstatic' BEFORE 'meh'")).to.not.be.equal(-1); expect(sql.indexOf("ALTER TYPE \"public\".\"enum_UserEnums_mood\" ADD VALUE 'ecstatic' BEFORE 'meh'")).to.not.be.equal(-1);
count++; count++;
} }
else if (sql.indexOf('joyful') > -1) { else if (sql.indexOf('joyful') > -1) {
expect(sql.indexOf("ALTER TYPE \"enum_UserEnums_mood\" ADD VALUE 'joyful' AFTER 'meh'")).to.not.be.equal(-1); expect(sql.indexOf("ALTER TYPE \"public\".\"enum_UserEnums_mood\" ADD VALUE 'joyful' AFTER 'meh'")).to.not.be.equal(-1);
count++; count++;
} }
} }
......
test/integration/dialects/postgres/query-generator.test.js
...@@ -181,7 +181,7 @@ if (dialect.match(/^postgres/)) { ...@@ -181,7 +181,7 @@ if (dialect.match(/^postgres/)) {
}, },
{ {
arguments: ['myTable', {title: 'ENUM("A", "B", "C")', name: 'VARCHAR(255)'}], arguments: ['myTable', {title: 'ENUM("A", "B", "C")', name: 'VARCHAR(255)'}],
expectation: 'CREATE TABLE IF NOT EXISTS \"myTable\" (\"title\" \"enum_myTable_title\", \"name\" VARCHAR(255));' expectation: 'CREATE TABLE IF NOT EXISTS \"myTable\" (\"title\" \"public\".\"enum_myTable_title\", \"name\" VARCHAR(255));'
}, },
{ {
arguments: ['myTable', {title: 'VARCHAR(255)', name: 'VARCHAR(255)', id: 'INTEGER PRIMARY KEY'}], arguments: ['myTable', {title: 'VARCHAR(255)', name: 'VARCHAR(255)', id: 'INTEGER PRIMARY KEY'}],
...@@ -205,7 +205,7 @@ if (dialect.match(/^postgres/)) { ...@@ -205,7 +205,7 @@ if (dialect.match(/^postgres/)) {
}, },
{ {
arguments: ['myTable', {title: 'ENUM("A", "B", "C")', name: 'VARCHAR(255)'}], arguments: ['myTable', {title: 'ENUM("A", "B", "C")', name: 'VARCHAR(255)'}],
expectation: 'CREATE TABLE IF NOT EXISTS myTable (title "enum_myTable_title", name VARCHAR(255));', expectation: 'CREATE TABLE IF NOT EXISTS myTable (title public."enum_myTable_title", name VARCHAR(255));',
context: {options: {quoteIdentifiers: false}} context: {options: {quoteIdentifiers: false}}
}, },
{ {
......
test/unit/sql/enum.test.js
...@@ -5,7 +5,8 @@ var Support = require(__dirname + '/../support') ...@@ -5,7 +5,8 @@ var Support = require(__dirname + '/../support')
, DataTypes = require(__dirname + '/../../../lib/data-types') , DataTypes = require(__dirname + '/../../../lib/data-types')
, expectsql = Support.expectsql , expectsql = Support.expectsql
, current = Support.sequelize , current = Support.sequelize
, sql = current.dialect.QueryGenerator; , sql = current.dialect.QueryGenerator
, expect = require('chai').expect;
describe(Support.getTestDialectTeaser('SQL'), function() { describe(Support.getTestDialectTeaser('SQL'), function() {
...@@ -24,6 +25,22 @@ describe(Support.getTestDialectTeaser('SQL'), function() { ...@@ -24,6 +25,22 @@ describe(Support.getTestDialectTeaser('SQL'), function() {
} }
}); });
describe('pgEnumName', function() {
it('does not add schema when options: { schema: false }', function() {
expect(sql.pgEnumName(PublicUser.getTableName(), 'mood', { schema: false }))
.to.equal('"enum_users_mood"');
expect(sql.pgEnumName(FooUser.getTableName(), 'theirMood', { schema: false }))
.to.equal('"enum_users_theirMood"');
});
it('properly quotes both the schema and the enum name', function() {
expect(sql.pgEnumName(PublicUser.getTableName(), 'mood', PublicUser.rawAttributes.mood.type))
.to.equal('"public"."enum_users_mood"');
expect(sql.pgEnumName(FooUser.getTableName(), 'theirMood', FooUser.rawAttributes.mood.type))
.to.equal('"foo"."enum_users_theirMood"');
});
});
describe('pgEnum', function () { describe('pgEnum', function () {
it('uses schema #3171', function () { it('uses schema #3171', function () {
expectsql(sql.pgEnum(FooUser.getTableName(), 'mood', FooUser.rawAttributes.mood.type), { expectsql(sql.pgEnum(FooUser.getTableName(), 'mood', FooUser.rawAttributes.mood.type), {
...@@ -31,9 +48,9 @@ describe(Support.getTestDialectTeaser('SQL'), function() { ...@@ -31,9 +48,9 @@ describe(Support.getTestDialectTeaser('SQL'), function() {
}); });
}); });
it('does not add schema when public', function () { it('does add schema when public', function () {
expectsql(sql.pgEnum(PublicUser.getTableName(), 'theirMood', PublicUser.rawAttributes.mood.type), { expectsql(sql.pgEnum(PublicUser.getTableName(), 'theirMood', PublicUser.rawAttributes.mood.type), {
postgres: 'CREATE TYPE "enum_users_theirMood" AS ENUM(\'happy\', \'sad\');' postgres: 'CREATE TYPE "public"."enum_users_theirMood" AS ENUM(\'happy\', \'sad\');'
}); });
}); });
}); });
...@@ -45,7 +62,7 @@ describe(Support.getTestDialectTeaser('SQL'), function() { ...@@ -45,7 +62,7 @@ describe(Support.getTestDialectTeaser('SQL'), function() {
}); });
}); });
it('uses the default schema if options given', function () { it('uses the default schema if no options given', function () {
expectsql(sql.pgListEnums(), { expectsql(sql.pgListEnums(), {
postgres: 'SELECT t.typname enum_name, array_agg(e.enumlabel) enum_value FROM pg_type t JOIN pg_enum e ON t.oid = e.enumtypid JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace WHERE n.nspname = \'public\' GROUP BY 1' postgres: 'SELECT t.typname enum_name, array_agg(e.enumlabel) enum_value FROM pg_type t JOIN pg_enum e ON t.oid = e.enumtypid JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace WHERE n.nspname = \'public\' GROUP BY 1'
}); });
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!