1、簡單 INSERT 查詢
首先戈盈,創(chuàng)建一個簡單例子:
// 創(chuàng)建一個新用戶
const user = await User.create({ firstName: 'zhangsan', age: 25 })
Model.create()
方法是使用 Model.build()
構(gòu)建為保存實例并使用 instance.save()
保存實例的簡寫。
2、簡單 SELECT 查詢
可以使用 findAll
方法從數(shù)據(jù)庫中讀取整個表:
// 查詢所有用戶
const users = await User.findAll()
// 相當(dāng)于 SQL
SELECT * FROM ...
3、SELECT 查詢特定屬性
使用 attributes
查詢特定字段:
Model.findAll({
attributes: ['name', 'age']
})
// 相當(dāng)于 SQL
SELECT name, age FROM ...
同時可以對字段重命名:
Model.findAll({
attributes: ['name', ['bar', 'baz'], 'age']
})
// 相當(dāng)于 SQL
SELECT name, bar AS baz, age FROM ...
也可以使用 sequelize.fn
進行聚合:
Model.findAll({
attributes: [
'name',
[sequelize.fn('COUNT', sequelize.col('bar')), 'baz'],
'age'
]
})
// 相當(dāng)于 SQL
SELECT name, COUNT(bar) AS baz, age FROM ...
使用聚合函數(shù)時培他,必須為它提供一個別名。
如果只想添加聚合遗座,那么列出模型的所有屬性會很麻煩:
// 列舉所有屬性:
Model.findAll({
attributes: [
'id', 'name', 'sex',
[sequelize.fn('COUNT', sequelize.col('bar')), 'baz'],
'age'
]
})
// 使用 include 屬性舀凛,如果以后再模型中添加、刪除屬性途蒋,它任然可以工作
Model.findAll({
attributes: {
include: [
[sequelize.fn('COUNT', sequelize.col('bar')), 'baz']
]
}
})
// 相當(dāng)于
SELECT id, name, sex, COUNT(bar) AS baz, age FROM ...
同樣猛遍,也可以排除某些屬性:
Model.findAll({
attributes: {
exclude: ['bar']
}
})
// 相當(dāng)于
SELECT id, name, sex, age FROM ...
4、應(yīng)用 WHERE 子句
where
參數(shù)用于過濾查詢号坡,where
子句有很多運算符懊烤,可以從 Op
中以 Symbol 的形式使用。
- 基礎(chǔ)
User.findAll({
where: {
id: 2
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE id = 2
上面代碼等效于:
const { Op } = require('sequelize')
User.findAll({
where: {
id: {
[Op.eq]: 2
}
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE id = 2
可以傳遞多個校驗:
User.findAll({
where: {
sex: 1,
age: 25
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE sex = 1 AND age = 25
上面的代碼等效于:
const { Op } = require('sequelize')
User.findAll({
where: {
[Op.and]: [
{ sex: 1 },
{ age: 25 }
]
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE sex = 1 AND age = 25
OR
可以通過類似的方式執(zhí)行:
const { Op } = require('sequelize')
User.findAll({
where: {
[Op.or]: [
{ id: 20 },
{ id: 25 }
]
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE id = 1 OR id = 25
由于以上的 OR
涉及相同字段宽堆,因此 Sequelize 允許使用稍有不同的結(jié)構(gòu)腌紧,該結(jié)構(gòu)更易讀且作用相同:
const { Op } = require('sequelize')
User.destroy({
where: {
id: {
[Op.or]: [20, 25]
}
}
})
// 相當(dāng)于
DELETE FROM tb_user WHERE id = 20 OR id = 25
- 操作符
Sequelize 提供的多種運算符:
const { Op } = require('sequelize')
User.findAll({
where: {
[Op.and]: [{ a: 5 }, { b: 6 }], // (a = 5) AND (b = 6)
[Op.or]: [{ a: 5 }, { b: 6 }], // (a = 5) OR (b = 6)
someAttribute: {
// 基本
[Op.eq]: 3, // = 3
[Op.ne]: 20, // != 20
[Op.is]: null, // IS NULL
[Op.not]: true, // IS NOT TRUE
[Op.or]: [5, 6], // (someAttribute = 5) OR (someAttribute = 6)
// 使用方言特定的列標(biāo)識符 (以下示例中使用 PG):
[Op.col]: 'user.organization_id', // = "user"."organization_id"
// 數(shù)字比較
[Op.gt]: 6, // > 6
[Op.gte]: 6, // >= 6
[Op.lt]: 10, // < 10
[Op.lte]: 10, // <= 10
[Op.between]: [6, 10], // BETWEEN 6 AND 10
[Op.notBetween]: [11, 15], // NOT BETWEEN 11 AND 15
// 其它操作符
[Op.all]: sequelize.literal('SELECT 1'), // > ALL (SELECT 1)
[Op.in]: [1, 2], // IN [1, 2]
[Op.notIn]: [1, 2], // NOT IN [1, 2]
[Op.like]: '%hat', // LIKE '%hat'
[Op.notLike]: '%hat', // NOT LIKE '%hat'
[Op.startsWith]: 'hat', // LIKE 'hat%'
[Op.endsWith]: 'hat', // LIKE '%hat'
[Op.substring]: 'hat', // LIKE '%hat%'
[Op.regexp]: '^[h|a|t]', // REGEXP/~ '^[h|a|t]' (僅 MySQL/PG)
[Op.notRegexp]: '^[h|a|t]', // NOT REGEXP/!~ '^[h|a|t]' (僅 MySQL/PG)
[Op.any]: [2, 3], // ANY ARRAY[2, 3]::INTEGER (僅 PG)
}
})
Op.in
的簡寫語法
直接將數(shù)組參數(shù)傳遞給 where
將隱式使用 IN
運算符:
User.findAll({
where: {
id: [1, 2, 3] // 等同使用 `id: { [Op.in]: [1, 2, 3] }`
}
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE id IN (1, 2, 3)
運算符的組合
運算符 Op.and
, Op.or
和 Op.not
可用于創(chuàng)建任意復(fù)雜的嵌套邏輯比較畜隶。
使用 Op.and
和 Op.or
示例
const { Op } = require('sequelize')
User.findAll({
where: {
rank: {
[Op.or]: {
[Op.lt]: 1000,
[Op.eq]: null
}
}
// rank < 1000 OR rank IS null
{
createdAt: {
[Op.lt]: new Date(),
[Op.gt]: new Date(new Date() - 24 * 60 * 60 * 1000)
}
}
// createdAt < [timestamp] AND createdAt > [timestamp]
{
[Op.or]: [
{ title: { [Op.like]: 'Boat%' } },
{ description: { [Op.like]: '%boat%' } }
]
}
// title LIKE 'Boat%' OR description LIKE '%boat%'
}
})
使用 Op.not
示例
User.findAll({
where: {
name: 'zhangsan',
[Op.not]: [
{ id: [1, 2, 3] },
{ description: { [Op.like]: 'Hello%' } }
]
}
})
上面代碼將生成:
SELECT * FROM tb_user WHERE (name = 'zhangsan' AND NOT id IN (1, 2, 3) OR description LIKE 'Hello%'))
- 高級查詢
如果你想得到類似 WHERE char_length('content') = 7
的結(jié)果怎么辦壁肋?
User.findAll({
where: sequelize.where(sequelize.fn('char_length', sequelize.col('content')), 7)
})
// 相當(dāng)于
SELECT * FROM tb_user WHERE char_length('content') = 7
sequelize.fn
和 sequelize.col
分別指定 SQL 函數(shù)調(diào)用和列,應(yīng)用這些方法籽慢,文不是傳遞純字符串(如:char_length(content))墩划,因為 Sequelize 需要以不同的方式對待這種情況(如:使用其他轉(zhuǎn)移字符)。
如果需要更復(fù)雜:
Post.findAll({
where: {
[Op.or]: [
sequelize.where(sequelize.fn('char_length', sequelize.col('content')), 7),
{
content: {
[Op.like]: 'Hello%'
}
},
{
[Op.and]: [
{ status: 'draft' },
sequelize.where(sequelize.fn('char_length', sequelize.col('content')), { [Op.gt]: 10 })
]
}
]
}
})
上面生成一下 SQL
SELECT * FROM WHERE (
char_length('content') = 7
OR
content LIKE 'Hello%'
OR (
status = 'draft'
AND
char_length('content') > 10
)
)
5嗡综、簡單 UPDATE 查詢
Update 查詢也接受 where
參數(shù),就像上面的讀取查詢一樣杜漠。
// 將所有沒有姓氏的人改為‘jeff’
await User.update({ lastName: 'jeff' }, {
where: {
lastName: null
}
})
6极景、簡單 DELETE 查詢
Delete 查詢也接受 where
參數(shù),就像上面的讀取查詢一樣驾茴。
// 刪除所有名為‘jeff’的人
await User.destroy({
where: {
firstName: 'jeff'
}
})
要銷毀所有內(nèi)容盼樟,可以使用 TRUNCATE
SQL:
// 截斷表格
await User.destory({
truncate: true
})
7、批量創(chuàng)建
Sequelize 提供了 Model.builCreate
方法锈至,以允許僅一個查詢即可一次創(chuàng)建多個記錄晨缴。通過接受數(shù)組對象文不是單個對象,Model.bulkCreate
的用法與 Model.create
非常相似峡捡。
const users = await User.bulkCreate([
{ name: 'zhangsan' },
{ name: 'lisi' }
])
但是击碗,默認(rèn)情況下筑悴,bulkCreate
不會在要創(chuàng)建的每個對象上運行驗證(create
可以做到)。為了使 bulkCreate
也運行這些驗證稍途,必須通過 validate: true
參數(shù)阁吝。但這會降低性能,實例:
const Foo = sequelize.define('foo', {
bar: DataTypes.TEXT,
validate: {
len: [4, 6]
}
})
// 這個不會引發(fā)錯誤械拍,兩個實例都將被創(chuàng)建
await Foo.bulkCreate([
{ name: 'abc123' },
{ name: 'naem too long'}
])
// 這將引發(fā)錯誤突勇,不會創(chuàng)建任何內(nèi)容
await Foo.bulkCreate([
{ name: 'abc123' },
{ name: 'name too long'}
], { validate: true })
如果你直接從用戶獲取值,那么限制實際插入的列可能會有所幫助。 為了做到這一點坷虑,bulkCreate()
接受一個 fields 參數(shù),該參數(shù)須為你要定義字段的數(shù)組(其余字段將被忽略).
await User.bulkCreate([
{ username: 'foo' },
{ username: 'bar', admin: true }
], { fields: ['username'] });
// foo 和 bar 都不會是管理員.
8甲馋、排序和分組
Sequelize 提供了 order
and group
參數(shù),來與 ORDER BY
和 GROUP BY
一起使用迄损。
排序
order
參數(shù)采用一系列項來讓 sequelize 方法對查詢進行排序定躏。這些 項 本身是 [column, direction]
形式的數(shù)組,該列將被正確轉(zhuǎn)義海蔽,并且將在有效方向列表中進行驗證(例如ASC
共屈,DESC
,NULLS FIRST
等)
Subtask.findAll({
order: [
// 將轉(zhuǎn)義 title 并針對有效方向列表進行降序排列
['title', 'DESC'],
// 將按最大年齡進行升序排序
sequelize.fn('max', sequelize.col('age')),
// 將按最大年齡進行降序排序
[sequelize.fn('max', sequelize.col('age')), 'DESC'],
// 將按 otherfunction(`col1`, 12, 'lalala') 進行降序排序
[sequelize.fn('otherfunction', sequelize.col('col1'), 12, 'lalala'), 'DESC'],
// 將使用模型名稱作為關(guān)聯(lián)名稱按關(guān)聯(lián)模型的 createdAt 排序.
[Task, 'createdAt', 'DESC'],
// 將使用模型名稱作為關(guān)聯(lián)名稱通過關(guān)聯(lián)模型的 createdAt 排序.
[Task, Project, 'createdAt', 'DESC'],
// 將使用關(guān)聯(lián)名稱按關(guān)聯(lián)模型的 createdAt 排序.
['Task', 'createdAt', 'DESC'],
// 將使用關(guān)聯(lián)的名稱按嵌套的關(guān)聯(lián)模型的 createdAt 排序.
['Task', 'Project', 'createdAt', 'DESC'],
// 將使用關(guān)聯(lián)對象按關(guān)聯(lián)模型的 createdAt 排序. (首選方法)
[Subtask.associations.Task, 'createdAt', 'DESC'],
// 將使用關(guān)聯(lián)對象按嵌套關(guān)聯(lián)模型的 createdAt 排序. (首選方法)
[Subtask.associations.Task, Task.associations.Project, 'createdAt', 'DESC'],
// 將使用簡單的關(guān)聯(lián)對象按關(guān)聯(lián)模型的 createdAt 排序.
[{model: Task, as: 'Task'}, 'createdAt', 'DESC'],
// 將由嵌套關(guān)聯(lián)模型的 createdAt 簡單關(guān)聯(lián)對象排序.
[{model: Task, as: 'Task'}, {model: Project, as: 'Project'}, 'createdAt', 'DESC']
],
// 將按最大年齡降序排列
order: sequelize.literal('max(age) DESC'),
// 如果忽略方向,則默認(rèn)升序,將按最大年齡升序排序
order: sequelize.fn('max', sequelize.col('age')),
// 如果省略方向,則默認(rèn)升序, 將按年齡升序排列
order: sequelize.col('age'),
// 將根據(jù)方言隨機排序(但不是 fn('RAND') 或 fn('RANDOM'))
order: sequelize.random()
});
Foo.findOne({
order: [
// 將返回 `name`
['name'],
// 將返回 `username` DESC
['username', 'DESC'],
// 將返回 max(`age`)
sequelize.fn('max', sequelize.col('age')),
// 將返回 max(`age`) DESC
[sequelize.fn('max', sequelize.col('age')), 'DESC'],
// 將返回 otherfunction(`col1`, 12, 'lalala') DESC
[sequelize.fn('otherfunction', sequelize.col('col1'), 12, 'lalala'), 'DESC'],
// 將返回 otherfunction(awesomefunction(`col`)) DESC, 這種嵌套可能是無限的!
[sequelize.fn('otherfunction', sequelize.fn('awesomefunction', sequelize.col('col'))), 'DESC']
]
});
回顧一下,order 數(shù)組的元素可以如下:
- 一個字符串 (它將被自動引用)
- 一個數(shù)組, 其第一個元素將被引用,第二個將被逐字追加
- 一個具有
raw
字段的對象:-
raw
內(nèi)容將不加引用地逐字添加 - 其他所有內(nèi)容都將被忽略,如果未設(shè)置
raw
,查詢將失敗
-
- 調(diào)用
Sequelize.fn
(這將在 SQL 中生成一個函數(shù)調(diào)用) - 調(diào)用
Sequelize.col
(這將引用列名)
分組
分組和排序的語法相同,只是分組不接受方向作為數(shù)組的最后一個參數(shù)(不存在 ASC
, DESC
, NULLS FIRST
等).
你還可以將字符串直接傳遞給 group
,該字符串將直接(普通)包含在生成的 SQL 中. 請謹(jǐn)慎使用,請勿與用戶生成的內(nèi)容一起使用.
Project.findAll({ group: 'name' });
// 生成 'GROUP BY name'
9党窜、限制和分頁
使用 limit
和 offset
參數(shù)可以進行 限制/分頁:
// 提取10個實例/行
Project.findAll({ limit: 10 })
// 跳過8個實例/行
Project.findAll({ offset: 8 })
// 跳過5個實例,然后獲取5個實例
Project.findAll({ offset: 5, limit: 5 })
通常這些與 order
參數(shù)一起使用拗引。
10、使用方法
count
count
方法僅計算數(shù)據(jù)庫中元素出現(xiàn)的次數(shù)幌衣。
// 計算 age 大于 25 的人數(shù)
const amount = await User.count({
where: {
age: {
[Op.gt]: 25
}
}
})
max
矾削,min
和 sum
Sequelize 還提供了 max,min 和 sum 便捷方法.
await User.max('age') // 40
await User.max('age', { where: { age: { [Op.lt]: 20 } } }) // 10
await User.min('age') // 5
await User.min('age', { where: { age: { [Op.gt]: 5 } } }) // 10
await User.sum('age') // 55
await User.sum('age', { where: { age: { [Op.gt]: 5 } } }) // 50