1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
"""Test MySQL FOR UPDATE behavior.
See #4246
"""
import contextlib
from sqlalchemy import Column
from sqlalchemy import exc
from sqlalchemy import ForeignKey
from sqlalchemy import Integer
from sqlalchemy import literal_column
from sqlalchemy import Table
from sqlalchemy import testing
from sqlalchemy import text
from sqlalchemy import update
from sqlalchemy.dialects.mysql import base as mysql
from sqlalchemy.exc import ProgrammingError
from sqlalchemy.orm import joinedload
from sqlalchemy.orm import relationship
from sqlalchemy.orm import Session
from sqlalchemy.sql import column
from sqlalchemy.sql import table
from sqlalchemy.testing import AssertsCompiledSQL
from sqlalchemy.testing import expect_raises_message
from sqlalchemy.testing import fixtures
class MySQLForUpdateLockingTest(fixtures.DeclarativeMappedTest):
__backend__ = True
__only_on__ = "mysql", "mariadb"
__requires__ = ("mysql_for_update",)
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
x = Column(Integer)
y = Column(Integer)
bs = relationship("B")
__table_args__ = {
"mysql_engine": "InnoDB",
"mariadb_engine": "InnoDB",
}
class B(Base):
__tablename__ = "b"
id = Column(Integer, primary_key=True)
a_id = Column(ForeignKey("a.id"))
x = Column(Integer)
y = Column(Integer)
__table_args__ = {
"mysql_engine": "InnoDB",
"mariadb_engine": "InnoDB",
}
@classmethod
def insert_data(cls, connection):
A = cls.classes.A
B = cls.classes.B
# all the x/y are < 10
s = Session(connection)
s.add_all(
[
A(x=5, y=5, bs=[B(x=4, y=4), B(x=2, y=8), B(x=7, y=1)]),
A(x=7, y=5, bs=[B(x=4, y=4), B(x=5, y=8)]),
]
)
s.commit()
@contextlib.contextmanager
def run_test(self):
connection = testing.db.connect()
connection.exec_driver_sql("set innodb_lock_wait_timeout=1")
main_trans = connection.begin()
try:
yield Session(bind=connection)
finally:
main_trans.rollback()
connection.close()
def _assert_a_is_locked(self, should_be_locked):
A = self.classes.A
with testing.db.begin() as alt_trans:
alt_trans.exec_driver_sql("set innodb_lock_wait_timeout=1")
# set x/y > 10
try:
alt_trans.execute(update(A).values(x=15, y=19))
except (exc.InternalError, exc.OperationalError) as err:
assert "Lock wait timeout exceeded" in str(err)
assert should_be_locked
else:
assert not should_be_locked
def _assert_b_is_locked(self, should_be_locked):
B = self.classes.B
with testing.db.begin() as alt_trans:
alt_trans.exec_driver_sql("set innodb_lock_wait_timeout=1")
# set x/y > 10
try:
alt_trans.execute(update(B).values(x=15, y=19))
except (exc.InternalError, exc.OperationalError) as err:
assert "Lock wait timeout exceeded" in str(err)
assert should_be_locked
else:
assert not should_be_locked
def test_basic_lock(self):
A = self.classes.A
with self.run_test() as s:
s.query(A).with_for_update().all()
# test our fixture
self._assert_a_is_locked(True)
def test_basic_not_lock(self):
A = self.classes.A
with self.run_test() as s:
s.query(A).all()
# test our fixture
self._assert_a_is_locked(False)
def test_joined_lock_subquery(self):
A = self.classes.A
with self.run_test() as s:
s.query(A).options(joinedload(A.bs)).with_for_update().first()
# test for issue #4246, should be locked
self._assert_a_is_locked(True)
self._assert_b_is_locked(True)
def test_joined_lock_subquery_inner_for_update(self):
A = self.classes.A
B = self.classes.B
with self.run_test() as s:
q = s.query(A).with_for_update().subquery()
s.query(q).join(B).all()
# FOR UPDATE is inside the subquery, should be locked
self._assert_a_is_locked(True)
# FOR UPDATE is inside the subquery, B is not locked
self._assert_b_is_locked(False)
def test_joined_lock_subquery_inner_for_update_outer(self):
A = self.classes.A
B = self.classes.B
with self.run_test() as s:
q = s.query(A).with_for_update().subquery()
s.query(q).join(B).with_for_update().all()
# FOR UPDATE is inside the subquery, should be locked
self._assert_a_is_locked(True)
# FOR UPDATE is also outside the subquery, B is locked
self._assert_b_is_locked(True)
def test_joined_lock_subquery_order_for_update_outer(self):
A = self.classes.A
B = self.classes.B
with self.run_test() as s:
q = s.query(A).order_by(A.id).subquery()
s.query(q).join(B).with_for_update().all()
# FOR UPDATE is inside the subquery, should not be locked
self._assert_a_is_locked(False)
self._assert_b_is_locked(True)
def test_joined_lock_no_subquery(self):
A = self.classes.A
with self.run_test() as s:
s.query(A).options(joinedload(A.bs)).with_for_update().all()
# no subquery, should be locked
self._assert_a_is_locked(True)
self._assert_b_is_locked(True)
class MySQLForUpdateCompileTest(fixtures.TestBase, AssertsCompiledSQL):
__dialect__ = mysql.dialect()
table1 = table(
"mytable", column("myid"), column("name"), column("description")
)
table2 = table("table2", column("mytable_id"))
join = table2.join(table1, table2.c.mytable_id == table1.c.myid)
for_update_of_dialect = mysql.dialect()
for_update_of_dialect.server_version_info = (8, 0, 0)
for_update_of_dialect.supports_for_update_of = True
def test_for_update_basic(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s FOR UPDATE",
)
def test_for_update_read(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s LOCK IN SHARE MODE",
)
def test_for_update_skip_locked(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(skip_locked=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE SKIP LOCKED",
)
def test_for_update_read_and_skip_locked(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True, skip_locked=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE SKIP LOCKED",
)
def test_for_update_nowait(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(nowait=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE NOWAIT",
)
def test_for_update_read_and_nowait(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True, nowait=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE NOWAIT",
)
def test_for_update_of_nowait(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(of=self.table1, nowait=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE OF mytable NOWAIT",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_basic(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(of=self.table1),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE OF mytable",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_skip_locked(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(of=self.table1, skip_locked=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE OF mytable SKIP LOCKED",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_join_one(self):
self.assert_compile(
self.join.select()
.where(self.table2.c.mytable_id == 7)
.with_for_update(of=[self.join]),
"SELECT table2.mytable_id, "
"mytable.myid, mytable.name, mytable.description "
"FROM table2 "
"INNER JOIN mytable ON table2.mytable_id = mytable.myid "
"WHERE table2.mytable_id = %s "
"FOR UPDATE OF mytable, table2",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_column_list_aliased(self):
ta = self.table1.alias()
self.assert_compile(
ta.select()
.where(ta.c.myid == 7)
.with_for_update(of=[ta.c.myid, ta.c.name]),
"SELECT mytable_1.myid, mytable_1.name, mytable_1.description "
"FROM mytable AS mytable_1 "
"WHERE mytable_1.myid = %s FOR UPDATE OF mytable_1",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_join_aliased(self):
ta = self.table1.alias()
alias_join = self.table2.join(
ta, self.table2.c.mytable_id == ta.c.myid
)
self.assert_compile(
alias_join.select()
.where(self.table2.c.mytable_id == 7)
.with_for_update(of=[alias_join]),
"SELECT table2.mytable_id, "
"mytable_1.myid, mytable_1.name, mytable_1.description "
"FROM table2 "
"INNER JOIN mytable AS mytable_1 "
"ON table2.mytable_id = mytable_1.myid "
"WHERE table2.mytable_id = %s "
"FOR UPDATE OF mytable_1, table2",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_read_nowait(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True, of=self.table1, nowait=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE OF mytable NOWAIT",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_read_skip_locked(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True, of=self.table1, skip_locked=True),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE OF mytable SKIP LOCKED",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_read_nowait_column_list(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(
read=True,
of=[self.table1.c.myid, self.table1.c.name],
nowait=True,
),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE OF mytable NOWAIT",
dialect=self.for_update_of_dialect,
)
def test_for_update_of_read(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(read=True, of=self.table1),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"LOCK IN SHARE MODE OF mytable",
dialect=self.for_update_of_dialect,
)
def test_for_update_textual_of(self):
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(of=text("mytable")),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE OF mytable",
dialect=self.for_update_of_dialect,
)
self.assert_compile(
self.table1.select()
.where(self.table1.c.myid == 7)
.with_for_update(of=literal_column("mytable")),
"SELECT mytable.myid, mytable.name, mytable.description "
"FROM mytable WHERE mytable.myid = %s "
"FOR UPDATE OF mytable",
dialect=self.for_update_of_dialect,
)
class SkipLockedTest(fixtures.TablesTest):
__only_on__ = ("mysql", "mariadb")
__backend__ = True
@classmethod
def define_tables(cls, metadata):
Table(
"stuff",
metadata,
Column("id", Integer, primary_key=True),
Column("value", Integer),
)
@testing.only_on(["mysql>=8", "mariadb>=10.6"])
def test_skip_locked(self, connection):
stuff = self.tables.stuff
stmt = stuff.select().with_for_update(skip_locked=True)
connection.execute(stmt).fetchall()
@testing.only_on(["mysql<8", "mariadb<10.6"])
def test_unsupported_skip_locked(self, connection):
stuff = self.tables.stuff
stmt = stuff.select().with_for_update(skip_locked=True)
with expect_raises_message(
ProgrammingError, "You have an error in your SQL syntax"
):
connection.execute(stmt).fetchall()
|
