In the documentation for sequlize they use the import function like so
// in your server file - e.g. app.js
var Project = sequelize.import(__dirname + "/path/to/models/project")
// The model definition is done in /path/to/models/project.js
// As you might notice, the DataTypes are the very same as explained above
module.exports = function(sequelize, DataTypes) {
return sequelize.define("Project", {
name: DataTypes.STRING,
description: DataTypes.TEXT
})
}
However, what would be so wrong with this?
// in your server file - e.g. app.js
var Project = require(__dirname + "/path/to/models/project")
// The model definition is done in /path/to/models/project.js
var Project = sequelize.define("Project", {
name: Sequelize.STRING,
description: Sequelize.TEXT
});
module.exports = Project
Well, as you can see your model definition needs two things:
Sequelize or DataTypes
sequelize
In your first example when using sequelize.import('something'); it is similar to use require('something')(this, Sequelize); (this being the sequelize instance)
Both are necessary to initialize your model, but the important thing to understand is: One of these is a classtype so it's global, the other one is an instance and has to be created with your connection parameters.
So if you do this:
var Project = sequelize.define("Project", {
name: Sequelize.STRING,
description: Sequelize.TEXT
});
module.exports = Project
Where does sequelize come from? It has to be instantiated and passed somehow.
Here is an example with require instead of import:
// /path/to/app.js
var Sequelize = require('sequelize');
var sequelize = new Sequelize(/* ... */);
var Project = require('/path/to/models/project')(sequelize, Sequelize);
// /path/to/models/project.js
module.exports = function (sequelize, DataTypes) {
sequelize.define("Project", {
name: DataTypes.STRING,
description: DataTypes.TEXT
});
};
module.exports = Project
You could even change it so you wouldn't have to pass Sequelize by requiring it in the model itself, but you would still need to create a sequelize instance prior to define the model.
sequelize.import is deprecated as of sequelize 6
As mentioned at https://sequelize.org/master/manual/models-definition.html
Deprecated: sequelize.import
Note: You should not use sequelize.import. Please just use require instead.
So you should just port:
// index.js
const sequelize = new Sequelize(...)
const User = sequelize.import('./user')
// user.js
module.exports = (sequelize, DataTypes) => {
// Define User.
return User;
}
to:
// index.js
const sequelize = new Sequelize(...)
const User = require('./user')(sequelize)
// user.js
const { DataTypes } = require('sequelize')
module.exports = (sequelize) => {
// Define User.
return User;
}
Related
Please am new to Nodejs but am trying to insert a data into my database using sequelize but am getting Cannot read property .create of undefined.
This is my index.js file
const fs = require('fs')
const path = require('path')
const Sequelize = require('sequelize')
const config = require('../config/config')
const db = {}
const sequelize = new Sequelize(
config.DB,
config.USER,
config.PASSWORD,
{
host: config.HOST,
dialect: config.dialect,
operatorsAliases: false,
pool: {
max: config.pool.max,
min: config.pool.min,
acquire: config.pool.acquire,
idle: config.pool.idle
}
});
fs
.readdirSync(__dirname)
.filter((file) =>
file !== 'index.js'
)
.forEach((file) => {
const model = require(path.join(__dirname, file))(sequelize, Sequelize.DataTypes)
// db[model] = model
db.User = model
})
db.sequelize = sequelize
db.Sequelize = Sequelize
module.exports = db;
This is my Model/User.js File
module.exports = (sequelize, DataTypes) => {
sequelize.define('User', {
hmtec_email: {
type: DataTypes.STRING,
unique: true
},
hmtec_password: DataTypes.STRING
})
This is my Controllers/AuthController.js File
const {User} = require ('../models/User')
module.exports = {
async register (req, res) {
try {
const user = await User.create(req.body)
res.send(user.toJSON())
} catch (err) {
console.log(err);
res.status(400).send({
error: 'Email already in Use'
})
}
}
I don't know what wrong with the code, I dont know why am getting that error of .create is undefined
I think your problem is in the last file .. AuthController.js
const {User} = require ('../models/User')
You are using the Es6 new destruction assignment
More Info here https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment
Normally you should define your variable without the brackets
That mean you got all of the variable available.
But adding the brackets means that you want to get the child of the object, this child is named user .. and then name the variable also as user
and search these info
From the require file after the equal.
But in your user file .. you are exporting a function .. that does not have any child named user
Thus undefined
Better alternative is to use Classes
More info here : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
So in user model
// Inside your function you need to use sequalize module , iam not familar with it but you must require it to use it
const Sequelize = require('sequelize');
// Define the Class
class user {
// add the name you want to use for the function - here I used create so the other code also work - also I inserted async because this is asynchronous and also I removed the sequalize from parameters because you don't need it now after it is required above.
async create (DataTypes) => {
await Sequelize.define('User', {
hmtec_email: {
type: DataTypes.STRING,
unique: true
},
hmtec_password: DataTypes.STRING
})
}
module.exports = user;
Now when you require the file in Authcontroller , remove the brackets
const User = require ('../models/User')
and now you can use User.create(YOUR_DATA_VARIABLE);in your authController.js
and if there is any other functions inside this class you also can use them in the same manner.
I hope this fix your problem.
How I can turn on Intellisense of node.js sequelize?
There is no model method:
What I can do?
i solved the problem related to sequelize intellisense by changing my general require syntax to
const {Sequelize}=require('sequelize');
What I found is that The previous versions of Intellisense is working, but not stable ( or 6.x) version.
So you can try this:
const {Sequelize} = require("sequelize");
or
const Sequelize = require("sequelize").Sequelize
Either of this following works.
follow this you will get Intellisense works properly.
/models/index.js
'use strict';
const Sequelize = require('sequelize');
const db = {};
/**
* #type {Sequelize.Sequelize}=con
*/
let con = new Sequelize(process.env.db_database, process.env.db_username, process.env.db_password, {
host: process.env.db_host,
dialect: "mysql"
});
(async function () {
try {
//ck connection
await con.authenticate()
//attach models
db.User = require('./User')
db.Test = require('./Test')
//associate
Object.keys(db).forEach(modelName => {
// if (db[modelName].associate) {
// db[modelName].associate(db);
// }
});
//sync
await con.sync({
logging: true,
force: false
})
} catch (e) {
console.log("error db con: ", e.name)
}
}())
db.con = con
module.exports = db;
/models/User.js
const { DataTypes } = require('sequelize');
const { con } = require('.');
const User = con.define("User", {
name: {
type: DataTypes.STRING,
allowNull: false
},
password: {
type: DataTypes.STRING,
allowNull: false
}
})
module.exports = User
according to:
https://github.com/sequelize/sequelize/issues/11103
const Sequelize = require('sequelize').Sequelize;
Here is an ES6 way to get IntelliSense working on your models (instead of just the instantiated class).
First - declare the sequelize instance which can be imported into many files.
// sequelize.js
const { Sequelize } = require('sequelize');
const sequelize = new Sequelize(...);
export default sequelize;
Second - follow the suggested setup by sequelize-cli. Note you need to reimport the model. I know this might seem annoying to continually add export declarations here but when you add this 1 line, you get all the benefit :)
// models/index.js
import Sequelize from 'sequelize';
import sequelize from '../config/sequelize';
export * from './user';
export * from './another-model';
// ... etc
let db = {};
const basename = path.basename(__filename);
fs.readdirSync(__dirname)
.filter((file) => file.indexOf('.') !== 0 && file !== basename && file.slice(-3) === '.js')
.forEach((file) => {
const module = require(path.join(__dirname, file));
Object.values(module).forEach((model) => {
db[model.name] = model;
});
});
Object.keys(db).forEach((modelName) => {
if (db[modelName].associate) {
db[modelName].associate(db);
}
});
export {
sequelize,
Sequelize,
migrations
};
Third - update model file like so.
Note: adding export keyword here and importing your base sequelize instance.
//models/MyModel.js
import Sequelize from 'sequelize';
import sequelize from '../sequelize';
const { DataTypes } = Sequelize;
export const User = sequelize.define('User', {
userId: DataTypes.UUID,
...
}, {});
User.associate = function (models) {
User.belongsTo(models.Admin, {
foreignKey: 'adminId',
});
};
Sharing this since I struggled to find a working example since if you follow the official docs, you don't get IntelliSense on the models.
example showing models on db object
example showing sequelize intellisense
The reason you are not getting the Intellisense might be because you are not importing your models through sequelize correctly. Assuming you are defining your models in separate files and then importing them. I would recommend doing the following:
Create an index.js file in your models folder
Use sequelize.import to import all your models and associate them as well.
Then export them all from index.js along with seqeulize db instance and Sequelize module.
Wherever in your project you need your models just require db from /models.
models/index.js
const sequelize = new Sequelize(DB_NAME, DB_USERNAME, DB_PASSWORD)
const db = {
Sequelize: Sequelize,
sequelize,
User: sequelize.import("./user"),
Message: sequelize.import("./message")
}
Object.keys(db).forEach(model => {
if ("associate" in db[model]) {
db[model].associate(db)
}
})
module.exports = db
This is my model which is create from sequelize cli: (it describes an user in User.js)
'use strict';
module.exports = (sequelize, DataTypes) => {
const User = sequelize.define('User', {
username: DataTypes.STRING
}, {});
User.associate = function(models) {
// associations can be defined here
};
return User;
};
When I try to create it in my script file, I get this following error:
User.build is not a function
Here's how I call the build method:
const User = require('../models/User');
User.build({
username: message["name"],
}).save();
In your case it returns a function not constructor
you have to pass sequelize and DataTypes while importing it
const User= require('../models/User')(sequelize, DataTypes);
Hope it'll work for you
You need to require model from "model/index"
so change this
const User = require('../models/User');
to this
const {User} = require('../models/index');
refer to this answer
I use sequelize-cli to auto generate code for model Student:
module.exports = (sequelize, DataTypes) => {
var _stu = sequelize.define('stu', {
name: DataTypes.STRING,
password: DataTypes.STRING,
gender: DataTypes.INTEGER,
}, {
classMethods: {
associate: function(models) {
// associations can be defined here
}
}
});
return _stu
};
My question are
How to get model named stu? As the sequelize is defined in function signature.
When sequelize model:generate,sequelize read config in config.json,where dbname,passowrd are specified.
How the sequelize in the function signature knows database connection config,say,name,password,etc as I don't specify in this js file.
Answer for question 1:
"sequelize.import" will do this job.
Try this code:
const Sequelize = require('sequelize')
const sequelize = new Sequelize(...)
const stu = sequelize.import('./models/stu')
stu.findAll.then(...)
When you generate models via the CLI, it creates a handy models/index.js file that handles passing in a Sequelize instance for you. You can simply require cherry picked, existing models via ES6 destructuring like this:
var { stu } = require("./models");
stu.findAll().then(...);
Alternatively, you could require them all at once, and then access specific models as needed:
var models = require("./models");
models.stu.findAll().then(...);
The way i make it works was importing model with the require() function and then call it with required parameters.
Explanation
By require function you will get another function that returns your model.
module.exports = (sequelize, DataTypes) => {
const stu = sequelize.define('stu', {
// ...database fields
}, {});
stu.associate = function(models) {
// associations can be defined here
};
return sty;
} // note that module.exports is a function
Now, this function requires the initialized sequelize object and a DataTypes object, so you just have to pass the instance of sequelize and Sequelize.DataTypes and then it will return your model, example:
const Sequelize = require('sequelize');
const sequelize = new Sequelize(...);
const Stu = require('./models/stu')(sequelize, Sequelize.DataTypes);
Finally you can get your database rows with Stu.findAll().
Hope this can help you.
I have two models defined like this:
user.js
var sequelize = require('../database.js').sequelize,
Sequelize = require('../database.js').Sequelize,
userAttributes = require('./userAttributes.js');
User = sequelize.define('user', {},{
classMethods: {
createRider: function(params) {
var reqs = ['name', 'phone', 'fbprofile'],
values = [],
newUser;
reqs.forEach((req) => {
var value = params[req];
});
//Here I want to use the userAttributes-object.
return newUser;
}
}
});
module.exports = User;
userAttributes.js
var sequelize = require('../database.js').sequelize,
Sequelize = require('../database.js').Sequelize,
User = require('./user.js');
UserAttribute = sequelize.define('userAttributes', {
name: Sequelize.STRING,
value: Sequelize.STRING,
});
UserAttribute.belongsTo(User);
module.exports = UserAttribute;
in user User.addRider I want to add some records to UserAttributes, so I want to inclued that model in user. In userAttributes, I need to require Users to define it as a belongsTo. This doesn't seem to work. How can I solve this?
You can use a single file which imports all models and associates them after all models have been imported. This way, you do not need any circular references.
The second most popular answer in this question describes how to do it: How to organize a node app that uses sequelize?.