Skip to main content

yang_db/
row_lock.rs

1/// 事务 SELECT 的行锁模式。
2///
3/// 锁模式只能交给 MySQL/PostgreSQL 的 `Transaction::select_locked` 或便捷方法使用;
4/// 普通 `QueryBuilder` 不暴露加锁入口,避免锁语句在自动提交连接上失去预期语义。
5#[derive(Debug, Clone, Copy, PartialEq, Eq)]
6#[non_exhaustive]
7pub enum RowLock {
8    /// 排他行锁:`FOR UPDATE`。
9    ForUpdate,
10    /// 共享行锁:`FOR SHARE`。
11    ForShare,
12    /// 排他行锁并跳过已锁定行:`FOR UPDATE SKIP LOCKED`。
13    ForUpdateSkipLocked,
14    /// 共享行锁并跳过已锁定行:`FOR SHARE SKIP LOCKED`。
15    ForShareSkipLocked,
16    /// 排他行锁,但不禁外键引用:`FOR NO KEY UPDATE`(PostgreSQL)。
17    NoKeyUpdate,
18    /// 键共享锁:`FOR KEY SHARE`(PostgreSQL)。
19    KeyShare,
20}
21
22impl RowLock {
23    #[cfg(any(feature = "mysql", feature = "postgres"))]
24    pub(crate) const fn as_sql(self) -> &'static str {
25        match self {
26            Self::ForUpdate => "FOR UPDATE",
27            Self::ForShare => "FOR SHARE",
28            Self::ForUpdateSkipLocked => "FOR UPDATE SKIP LOCKED",
29            Self::ForShareSkipLocked => "FOR SHARE SKIP LOCKED",
30            Self::NoKeyUpdate => "FOR NO KEY UPDATE",
31            Self::KeyShare => "FOR KEY SHARE",
32        }
33    }
34}
35
36#[cfg(all(test, any(feature = "mysql", feature = "postgres")))]
37mod tests {
38    use super::RowLock;
39
40    #[test]
41    fn skip_locked_modes_render_expected_sql() {
42        assert_eq!(
43            RowLock::ForUpdateSkipLocked.as_sql(),
44            "FOR UPDATE SKIP LOCKED"
45        );
46        assert_eq!(
47            RowLock::ForShareSkipLocked.as_sql(),
48            "FOR SHARE SKIP LOCKED"
49        );
50        assert_eq!(RowLock::ForUpdate.as_sql(), "FOR UPDATE");
51        assert_eq!(RowLock::ForShare.as_sql(), "FOR SHARE");
52        assert_eq!(RowLock::NoKeyUpdate.as_sql(), "FOR NO KEY UPDATE");
53        assert_eq!(RowLock::KeyShare.as_sql(), "FOR KEY SHARE");
54    }
55}