Sequelize 一共有四种关联关系(Association)可供选择:
- BelongsTo
- HasOne
- HasMany
- BelongsToMany
基础概念
Source 和 Target
首先让我们先熟悉一个基本概念,这个基本概念将会在大多数关联关系中会被提及,那就是 source
和target
。假定我们现在需要在两个Model间建立一个关联关系,如下所示,我们需要在User
和Project
这两个Model之间建立hasOne
的关联关系。
class User extends Model {}
User.init({
name: Sequelize.STRING,
email: Sequelize.STRING
}, {
sequelize,
modelName: 'user'
});
class Project extends Model {}
Project.init({
name: Sequelize.STRING
}, {
sequelize,
modelName: 'project'
});
User.hasOne(Project);
在这里,User
就是source,Project
就是target。
Foreign Keys
在sequelize中,当你在model间创建关联关系的时候,将会自动添加带约束条件的外键(foreign key)引用,如下所示:
class Task extends Model {}
Task.init({ title: Sequelize.STRING }, { sequelize, modelName: 'task' });
class User extends Model {}
User.init({ username: Sequelize.STRING }, { sequelize, modelName: 'user' });
User.hasMany(Task); // 将会在Task model中添加userId字段
Task.belongsTo(User); // 同样会在Task model中添加userId字段
如上代码对应的会生成如下SQL:
CREATE TABLE IF NOT EXISTS "users" (
"id" SERIAL,
"username" VARCHAR(255),
"createdAt" TIMESTAMP WITH TIME ZONE NOT NULL,
"updatedAt" TIMESTAMP WITH TIME ZONE NOT NULL,
PRIMARY KEY ("id")
);
CREATE TABLE IF NOT EXISTS "tasks" (
"id" SERIAL,
"title" VARCHAR(255),
"createdAt" TIMESTAMP WITH TIME ZONE NOT NULL,
"updatedAt" TIMESTAMP WITH TIME ZONE NOT NULL,
"userId" INTEGER REFERENCES "users" ("id") ON DELETE
SET
NULL ON UPDATE CASCADE,
PRIMARY KEY ("id")
);
tasks
和 users
模型之间的关联关系会在tasks
表中注入userId
外键,且标记为users
表的一个引用。当引用的用户被删除时,userId
字段将会被设置成NULL
,对应的,当userId
对应的用户id
被更新时也会同步更新。这些选项可以在调用关联时通过传入onUpdate
和onDelete
等选项来覆写。认可的选项包括RESTRICT
, CASCADE
, NO ACTION
, SET DEFAULT
, SET NULL
等。
对于1对1和1对多的关联关系,删除和更新的默认选项分别是SET NULL
和CASCADE
。这也就意味着,当你尝试在一个多对多关联中的一边更新或者删除一行,在联查表中所有引用那一行记录的所有记录都会被更新或者删除。
underscored 选项
Sequelize 允许在 Model 中增加 underscored
选项。当该选项为true
时,由 Sequelize 中定义的和自动生成的所有以驼峰命名法命名的字段都会以下划线分割的形式来最终呈现。不只是我们在Model中定义的字段,由关联关系产生的外键也会以下划线的形式进行分割。
class Task extends Model {}
Task.init({
title: Sequelize.STRING
}, {
underscored: true,
sequelize,
modelName: 'task'
});
class User extends Model {}
User.init({
userName: Sequelize.STRING
}, {
underscored: true,
sequelize,
modelName: 'user'
});
// 将会添加userId字段到Task model中,但是对应的数据库字段会变成 `user_id`
User.hasMany(Task);
// 同样会添加userId字段到Task model中,但是对应的数据库字段会变成 `user_id`
Task.belongsTo(User);
对应生成的SQL语句:
CREATE TABLE IF NOT EXISTS "users" (
"id" SERIAL,
"user_name" VARCHAR(255),
"created_at" TIMESTAMP WITH TIME ZONE NOT NULL,
"updated_at" TIMESTAMP WITH TIME ZONE NOT NULL,
PRIMARY KEY ("id")
);
CREATE TABLE IF NOT EXISTS "tasks" (
"id" SERIAL,
"title" VARCHAR(255),
"created_at" TIMESTAMP WITH TIME ZONE NOT NULL,
"updated_at" TIMESTAMP WITH TIME ZONE NOT NULL,
"user_id" INTEGER REFERENCES "users" ("id") ON DELETE
SET
NULL ON UPDATE CASCADE,
PRIMARY KEY ("id")
);
可以看到,当underscored
选项为true
时,包括使用驼峰命名的userName
字段,还有自动生成的timestamp字段,都会以下划线分割的形式生成对应的数据库字段。另外需要注意的是,model中的字段依然保持驼峰命名的形式。
一对一关联(One-To-One associations)
一对一关联指的是使用单个外键关联两个特定Model的关联关系。
BelongsTo
BelongsTo
关联关系特指的是一对一关联关系的外键在关联关系的source
端。
一个简单的例子,一个球员是一个球队的一部分,球员是属于球队的,每个球员身上都会带着一个所属球队的ID,以此来说明这个球员是属于这个球队的。
class Player extends Model {}
Player.init({/* attributes */}, { sequelize, modelName: 'player' });
class Team extends Model {}
Team.init({/* attributes */}, { sequelize, modelName: 'team' });
Player.belongsTo(Team); // 将会在Player上添加一个teamId属性来存储Team的主键值
(未完待续。。。)