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
|
from sqlalchemy import and_
from sqlalchemy import Column
from sqlalchemy import exc
from sqlalchemy import ForeignKey
from sqlalchemy import func
from sqlalchemy import insert_sentinel
from sqlalchemy import Integer
from sqlalchemy import join
from sqlalchemy import select
from sqlalchemy import testing
from sqlalchemy.orm import aliased
from sqlalchemy.orm import joinedload
from sqlalchemy.orm import noload
from sqlalchemy.orm import relationship
from sqlalchemy.orm import selectinload
from sqlalchemy.orm import Session
from sqlalchemy.testing import eq_
from sqlalchemy.testing import expect_warnings
from sqlalchemy.testing import fixtures
from sqlalchemy.testing.assertions import expect_raises_message
from sqlalchemy.testing.assertsql import CompiledSQL
from sqlalchemy.testing.entities import ComparableEntity
from sqlalchemy.testing.fixtures import fixture_session
class PartitionByFixture(fixtures.DeclarativeMappedTest):
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
class B(Base):
__tablename__ = "b"
id = Column(Integer, primary_key=True)
a_id = Column(ForeignKey("a.id"))
cs = relationship("C")
class C(Base):
__tablename__ = "c"
id = Column(Integer, primary_key=True)
b_id = Column(ForeignKey("b.id"))
_sentinel = insert_sentinel()
partition = select(
B,
func.row_number()
.over(order_by=B.id, partition_by=B.a_id)
.label("index"),
).alias()
cls.partitioned_b = partitioned_b = aliased(B, alias=partition)
A.partitioned_bs = relationship(
partitioned_b,
primaryjoin=and_(
partitioned_b.a_id == A.id, partition.c.index < 10
),
)
@classmethod
def insert_data(cls, connection):
A, B, C = cls.classes("A", "B", "C")
s = Session(connection)
s.add_all([A(id=i) for i in range(1, 4)])
s.flush()
s.add_all(
[
B(a_id=i, cs=[C(), C()])
for i in range(1, 4)
for j in range(1, 21)
]
)
s.commit()
class AliasedClassRelationshipTest(
PartitionByFixture, testing.AssertsCompiledSQL
):
# TODO: maybe make this more backend agnostic
__requires__ = ("window_functions",)
__dialect__ = "default"
def test_lazyload(self):
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
def go():
for a1 in s.query(A): # 1 query
eq_(len(a1.partitioned_bs), 9) # 3 queries
for b in a1.partitioned_bs:
eq_(len(b.cs), 2) # 9 * 3 = 27 queries
self.assert_sql_count(testing.db, go, 31)
def test_join_one(self):
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
q = s.query(A).join(A.partitioned_bs)
self.assert_compile(
q,
"SELECT a.id AS a_id FROM a JOIN "
"(SELECT b.id AS id, b.a_id AS a_id, row_number() "
"OVER (PARTITION BY b.a_id ORDER BY b.id) "
"AS index FROM b) AS anon_1 "
"ON anon_1.a_id = a.id AND anon_1.index < :index_1",
)
def test_join_two(self):
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
q = s.query(A, A.partitioned_bs.entity).join(A.partitioned_bs)
self.assert_compile(
q,
"SELECT a.id AS a_id, anon_1.id AS anon_1_id, "
"anon_1.a_id AS anon_1_a_id "
"FROM a JOIN "
"(SELECT b.id AS id, b.a_id AS a_id, row_number() "
"OVER (PARTITION BY b.a_id ORDER BY b.id) "
"AS index FROM b) AS anon_1 "
"ON anon_1.a_id = a.id AND anon_1.index < :index_1",
)
def test_selectinload_w_noload_after(self):
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
def go():
for a1 in s.query(A).options(
noload("*"), selectinload(A.partitioned_bs)
):
for b in a1.partitioned_bs:
eq_(b.cs, [])
self.assert_sql_count(testing.db, go, 2)
@testing.combinations("ac_attribute", "ac_attr_w_of_type")
def test_selectinload_w_joinedload_after(self, calling_style):
"""test has been enhanced to also test #7224"""
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
partitioned_b = self.partitioned_b
if calling_style == "ac_attribute":
opt = selectinload(A.partitioned_bs).joinedload(partitioned_b.cs)
elif calling_style == "ac_attr_w_of_type":
# this would have been a workaround for people who encountered
# #7224. The exception that was raised for "ac_attribute" actually
# suggested to use of_type() so we can assume this pattern is
# probably being used
opt = selectinload(
A.partitioned_bs.of_type(partitioned_b)
).joinedload(partitioned_b.cs)
else:
assert False
def go():
for a1 in s.query(A).options(opt):
for b in a1.partitioned_bs:
eq_(len(b.cs), 2)
self.assert_sql_count(testing.db, go, 2)
@testing.combinations(True, False)
def test_selectinload_w_joinedload_after_base_target_fails(
self, use_of_type
):
A, B, C = self.classes("A", "B", "C")
s = Session(testing.db)
partitioned_b = self.partitioned_b
with expect_raises_message(
exc.ArgumentError,
r'ORM mapped entity or attribute "B.cs" does not link from '
r'relationship "A.partitioned_bs.of_type\(aliased\(B\)\)"',
):
if use_of_type:
opt = selectinload(
A.partitioned_bs.of_type(partitioned_b)
).joinedload(B.cs)
else:
opt = selectinload(A.partitioned_bs).joinedload(B.cs)
q = s.query(A).options(opt)
q._compile_context()
class AltSelectableTest(
fixtures.DeclarativeMappedTest, testing.AssertsCompiledSQL
):
__dialect__ = "default"
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(ComparableEntity, Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
b_id = Column(ForeignKey("b.id"))
class B(ComparableEntity, Base):
__tablename__ = "b"
id = Column(Integer, primary_key=True)
class C(ComparableEntity, Base):
__tablename__ = "c"
id = Column(Integer, primary_key=True)
a_id = Column(ForeignKey("a.id"))
class D(ComparableEntity, Base):
__tablename__ = "d"
id = Column(Integer, primary_key=True)
c_id = Column(ForeignKey("c.id"))
b_id = Column(ForeignKey("b.id"))
# 1. set up the join() as a variable, so we can refer
# to it in the mapping multiple times.
j = join(B, D, D.b_id == B.id).join(C, C.id == D.c_id)
# 2. Create an AliasedClass to B
B_viacd = aliased(B, j, flat=True)
A.b = relationship(B_viacd, primaryjoin=A.b_id == j.c.b_id)
@classmethod
def insert_data(cls, connection):
A, B, C, D = cls.classes("A", "B", "C", "D")
sess = Session(connection)
for obj in [
B(id=1),
A(id=1, b_id=1),
C(id=1, a_id=1),
D(id=1, c_id=1, b_id=1),
]:
sess.add(obj)
sess.flush()
sess.commit()
def test_lazyload(self):
A, B = self.classes("A", "B")
sess = fixture_session()
a1 = sess.query(A).first()
with self.sql_execution_asserter() as asserter:
# note this is many-to-one. use_get is unconditionally turned
# off for relationship to aliased class for now.
eq_(a1.b, B(id=1))
asserter.assert_(
CompiledSQL(
"SELECT b.id AS b_id FROM b JOIN d ON d.b_id = b.id "
"JOIN c ON c.id = d.c_id WHERE :param_1 = b.id",
[{"param_1": 1}],
)
)
def test_joinedload(self):
A, B = self.classes("A", "B")
sess = fixture_session()
with self.sql_execution_asserter() as asserter:
# note this is many-to-one. use_get is unconditionally turned
# off for relationship to aliased class for now.
a1 = sess.query(A).options(joinedload(A.b)).first()
eq_(a1.b, B(id=1))
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.b_id AS a_b_id, b_1.id AS b_1_id "
"FROM a LEFT OUTER JOIN (b AS b_1 "
"JOIN d AS d_1 ON d_1.b_id = b_1.id "
"JOIN c AS c_1 ON c_1.id = d_1.c_id) ON a.b_id = b_1.id "
"LIMIT :param_1",
[{"param_1": 1}],
)
)
def test_selectinload(self):
A, B = self.classes("A", "B")
sess = fixture_session()
with self.sql_execution_asserter() as asserter:
# note this is many-to-one. use_get is unconditionally turned
# off for relationship to aliased class for now.
a1 = sess.query(A).options(selectinload(A.b)).first()
eq_(a1.b, B(id=1))
asserter.assert_(
CompiledSQL(
"SELECT a.id AS a_id, a.b_id AS a_b_id "
"FROM a LIMIT :param_1",
[{"param_1": 1}],
),
CompiledSQL(
"SELECT a_1.id AS a_1_id, b.id AS b_id FROM a AS a_1 "
"JOIN (b JOIN d ON d.b_id = b.id JOIN c ON c.id = d.c_id) "
"ON a_1.b_id = b.id WHERE a_1.id "
"IN (__[POSTCOMPILE_primary_keys])",
[{"primary_keys": [1]}],
),
)
def test_join(self):
A, B = self.classes("A", "B")
sess = fixture_session()
self.assert_compile(
sess.query(A).join(A.b),
"SELECT a.id AS a_id, a.b_id AS a_b_id "
"FROM a JOIN (b JOIN d ON d.b_id = b.id "
"JOIN c ON c.id = d.c_id) ON a.b_id = b.id",
)
class StructuralEagerLoadCycleTest(fixtures.DeclarativeMappedTest):
@classmethod
def setup_classes(cls):
Base = cls.DeclarativeBasic
class A(Base):
__tablename__ = "a"
id = Column(Integer, primary_key=True)
bs = relationship(lambda: B, back_populates="a")
class B(Base):
__tablename__ = "b"
id = Column(Integer, primary_key=True)
a_id = Column(ForeignKey("a.id"))
a = relationship(A, lazy="joined", back_populates="bs")
partitioned_b = aliased(B)
A.partitioned_bs = relationship(
partitioned_b, lazy="selectin", viewonly=True
)
@classmethod
def insert_data(cls, connection):
A, B = cls.classes("A", "B")
s = Session(connection)
a = A()
a.bs = [B() for _ in range(5)]
s.add(a)
s.commit()
@testing.variation("ensure_no_warning", [True, False])
def test_no_endless_loop(self, ensure_no_warning):
"""test #9590"""
A = self.classes.A
sess = fixture_session()
results = sess.scalars(select(A))
# the correct behavior is 1. no warnings and 2. no endless loop.
# however when the failure mode is occurring, it correctly warns,
# but then we don't get to see the endless loop happen.
# so test it both ways even though when things are "working", there's
# no problem
if ensure_no_warning:
a = results.first()
else:
with expect_warnings(
"Loader depth for query is excessively deep", assert_=False
):
a = results.first()
a.bs
|