Files
sqlalchemy/test/orm/assorted_eager.py
T
2008-05-14 22:09:23 +00:00

879 lines
30 KiB
Python

"""Exercises for eager loading.
Derived from mailing list-reported problems and trac tickets.
"""
import testenv; testenv.configure_for_tests()
import datetime
from testlib import sa, testing
from testlib.sa import Table, Column, Integer, String, ForeignKey
from testlib.sa.orm import mapper, relation, backref, create_session
from testlib.testing import eq_
from orm import _base
class EagerTest(_base.MappedTest):
run_deletes = None
run_inserts = "once"
def define_tables(self, metadata):
# determine a literal value for "false" based on the dialect
# FIXME: this DefaultClause setup is bogus.
dialect = testing.db.dialect
bp = sa.Boolean().dialect_impl(dialect).bind_processor(dialect)
if bp:
false = str(bp(False))
elif testing.against('maxdb'):
false = text('FALSE')
else:
false = str(False)
self.other_artifacts['false'] = false
Table('owners', metadata ,
Column('id', Integer, primary_key=True, nullable=False),
Column('data', String(30)))
Table('categories', metadata,
Column('id', Integer, primary_key=True, nullable=False),
Column('name', String(20)))
Table('tests', metadata ,
Column('id', Integer, primary_key=True, nullable=False ),
Column('owner_id', Integer, ForeignKey('owners.id'),
nullable=False),
Column('category_id', Integer, ForeignKey('categories.id'),
nullable=False))
Table('options', metadata ,
Column('test_id', Integer, ForeignKey('tests.id'),
primary_key=True, nullable=False),
Column('owner_id', Integer, ForeignKey('owners.id'),
primary_key=True, nullable=False),
Column('someoption', sa.Boolean, server_default=false,
nullable=False))
def setup_classes(self):
class Owner(_base.BasicEntity):
pass
class Category(_base.BasicEntity):
pass
class Test(_base.BasicEntity):
pass
class Option(_base.BasicEntity):
pass
@testing.resolve_artifact_names
def setup_mappers(self):
mapper(Owner, owners)
mapper(Category, categories)
mapper(Option, options, properties=dict(
owner=relation(Owner),
test=relation(Test)))
mapper(Test, tests, properties=dict(
owner=relation(Owner, backref='tests'),
category=relation(Category),
owner_option=relation(Option,
primaryjoin=sa.and_(tests.c.id == options.c.test_id,
tests.c.owner_id == options.c.owner_id),
foreign_keys=[options.c.test_id, options.c.owner_id],
uselist=False)))
@testing.resolve_artifact_names
def insert_data(self):
session = create_session()
o = Owner()
c = Category(name='Some Category')
session.add_all((
Test(owner=o, category=c),
Test(owner=o, category=c, owner_option=Option(someoption=True)),
Test(owner=o, category=c, owner_option=Option())))
session.flush()
@testing.resolve_artifact_names
def test_noorm(self):
"""test the control case"""
# I want to display a list of tests owned by owner 1
# if someoption is false or he hasn't specified it yet (null)
# but not if he set it to true (example someoption is for hiding)
# desired output for owner 1
# test_id, cat_name
# 1 'Some Category'
# 3 "
# not orm style correct query
print "Obtaining correct results without orm"
result = sa.select(
[tests.c.id,categories.c.name],
sa.and_(tests.c.owner_id == 1,
sa.or_(options.c.someoption==None,
options.c.someoption==False)),
order_by=[tests.c.id],
from_obj=[tests.join(categories).outerjoin(options, sa.and_(
tests.c.id == options.c.test_id,
tests.c.owner_id == options.c.owner_id))]
).execute().fetchall()
eq_(result, [(1, u'Some Category'), (3, u'Some Category')])
@testing.resolve_artifact_names
def test_withouteagerload(self):
s = create_session()
l = (s.query(Test).
select_from(tests.outerjoin(options,
sa.and_(tests.c.id == options.c.test_id,
tests.c.owner_id ==
options.c.owner_id))).
filter(sa.and_(tests.c.owner_id==1,
sa.or_(options.c.someoption==None,
options.c.someoption==False))))
result = ["%d %s" % ( t.id,t.category.name ) for t in l]
eq_(result, [u'1 Some Category', u'3 Some Category'])
@testing.resolve_artifact_names
def test_witheagerload(self):
"""
Test that an eagerload locates the correct "from" clause with which to
attach to, when presented with a query that already has a complicated
from clause.
"""
s = create_session()
q=s.query(Test).options(sa.orm.eagerload('category'))
l=(q.select_from(tests.outerjoin(options,
sa.and_(tests.c.id ==
options.c.test_id,
tests.c.owner_id ==
options.c.owner_id))).
filter(sa.and_(tests.c.owner_id == 1,
sa.or_(options.c.someoption==None,
options.c.someoption==False))))
result = ["%d %s" % ( t.id,t.category.name ) for t in l]
eq_(result, [u'1 Some Category', u'3 Some Category'])
@testing.resolve_artifact_names
def test_dslish(self):
"""test the same as witheagerload except using generative"""
s = create_session()
q = s.query(Test).options(sa.orm.eagerload('category'))
l = q.filter (
sa.and_(tests.c.owner_id == 1,
sa.or_(options.c.someoption == None,
options.c.someoption == False))
).outerjoin('owner_option')
result = ["%d %s" % ( t.id,t.category.name ) for t in l]
eq_(result, [u'1 Some Category', u'3 Some Category'])
@testing.crashes('sybase', 'FIXME: unknown, verify not fails_on')
@testing.resolve_artifact_names
def test_without_outerjoin_literal(self):
s = create_session()
q = s.query(Test).options(sa.orm.eagerload('category'))
l = (q.filter(
(tests.c.owner_id==1) &
('options.someoption is null or options.someoption=%s' % false)).
join('owner_option'))
result = ["%d %s" % ( t.id,t.category.name ) for t in l]
eq_(result, [u'3 Some Category'])
@testing.resolve_artifact_names
def test_withoutouterjoin(self):
s = create_session()
q = s.query(Test).options(sa.orm.eagerload('category'))
l = q.filter(
(tests.c.owner_id==1) &
((options.c.someoption==None) | (options.c.someoption==False))
).join('owner_option')
result = ["%d %s" % ( t.id,t.category.name ) for t in l]
eq_(result, [u'3 Some Category'])
class EagerTest2(_base.MappedTest):
def define_tables(self, metadata):
Table('left', metadata,
Column('id', Integer, ForeignKey('middle.id'), primary_key=True),
Column('data', String(50), primary_key=True))
Table('middle', metadata,
Column('id', Integer, primary_key = True),
Column('data', String(50)))
Table('right', metadata,
Column('id', Integer, ForeignKey('middle.id'), primary_key=True),
Column('data', String(50), primary_key=True))
def setup_classes(self):
class Left(_base.BasicEntity):
def __init__(self, data):
self.data = data
class Middle(_base.BasicEntity):
def __init__(self, data):
self.data = data
class Right(_base.BasicEntity):
def __init__(self, data):
self.data = data
@testing.resolve_artifact_names
def setup_mappers(self):
# set up bi-directional eager loads
mapper(Left, left)
mapper(Right, right)
mapper(Middle, middle, properties=dict(
left=relation(Left,
lazy=False,
backref=backref('middle',lazy=False)),
right=relation(Right,
lazy=False,
backref=backref('middle', lazy=False)))),
@testing.fails_on('maxdb')
@testing.resolve_artifact_names
def test_eager_terminate(self):
"""Eager query generation does not include the same mapper's table twice.
Or, that bi-directional eager loads dont include each other in eager
query generation.
"""
p = Middle('m1')
p.left.append(Left('l1'))
p.right.append(Right('r1'))
session = create_session()
session.add(p)
session.flush()
session.clear()
obj = session.query(Left).filter_by(data='l1').one()
class EagerTest3(_base.MappedTest):
"""Eager loading combined with nested SELECT statements, functions, and aggregates."""
def define_tables(self, metadata):
Table('datas', metadata,
Column('id', Integer, primary_key=True, nullable=False),
Column('a', Integer, nullable=False))
Table('foo', metadata,
Column('data_id', Integer,
ForeignKey('datas.id'),
nullable=False, primary_key=True),
Column('bar', Integer))
Table('stats', metadata,
Column('id', Integer, primary_key=True, nullable=False ),
Column('data_id', Integer, ForeignKey('datas.id')),
Column('somedata', Integer, nullable=False ))
def setup_classes(self):
class Data(_base.BasicEntity):
pass
class Foo(_base.BasicEntity):
pass
class Stat(_base.BasicEntity):
pass
@testing.fails_on('maxdb')
@testing.resolve_artifact_names
def test_nesting_with_functions(self):
mapper(Data, datas)
mapper(Foo, foo, properties={
'data': relation(Data,backref=backref('foo',uselist=False))})
mapper(Stat, stats, properties={
'data':relation(Data)})
session = create_session()
data = [Data(a=x) for x in range(5)]
session.add_all(data)
session.add_all((
Stat(data=data[0], somedata=1),
Stat(data=data[1], somedata=2),
Stat(data=data[2], somedata=3),
Stat(data=data[3], somedata=4),
Stat(data=data[4], somedata=5),
Stat(data=data[0], somedata=6),
Stat(data=data[1], somedata=7),
Stat(data=data[2], somedata=8),
Stat(data=data[3], somedata=9),
Stat(data=data[4], somedata=10)))
session.flush()
arb_data = sa.select(
[stats.c.data_id, sa.func.max(stats.c.somedata).label('max')],
stats.c.data_id <= 5,
group_by=[stats.c.data_id]).alias('arb')
arb_result = arb_data.execute().fetchall()
# order the result list descending based on 'max'
arb_result.sort(lambda a, b: cmp(b['max'], a['max']))
# extract just the "data_id" from it
arb_result = [row['data_id'] for row in arb_result]
# now query for Data objects using that above select, adding the
# "order by max desc" separately
q = (session.query(Data).
options(sa.orm.eagerload('foo')).
select_from(datas.join(arb_data, arb_data.c.data_id == datas.c.id)).
order_by(sa.desc(arb_data.c.max)).
limit(10))
# extract "data_id" from the list of result objects
verify_result = [d.id for d in q]
eq_(verify_result, arb_result)
class EagerTest4(_base.MappedTest):
def define_tables(self, metadata):
Table('departments', metadata,
Column('department_id', Integer, primary_key=True),
Column('name', String(50)))
Table('employees', metadata,
Column('person_id', Integer, primary_key=True),
Column('name', String(50)),
Column('department_id', Integer,
ForeignKey('departments.department_id')))
def setup_classes(self):
class Department(_base.BasicEntity):
pass
class Employee(_base.BasicEntity):
pass
@testing.fails_on('maxdb')
@testing.resolve_artifact_names
def test_basic(self):
mapper(Employee, employees)
mapper(Department, departments, properties=dict(
employees=relation(Employee,
lazy=False,
backref='department')))
d1 = Department(name='One')
for e in 'Jim', 'Jack', 'John', 'Susan':
d1.employees.append(Employee(name=e))
d2 = Department(name='Two')
for e in 'Joe', 'Bob', 'Mary', 'Wally':
d2.employees.append(Employee(name=e))
sess = create_session()
sess.add_all((d1, d2))
sess.flush()
q = (sess.query(Department).
join('employees').
filter(Employee.name.startswith('J')).
distinct().
order_by([sa.desc(Department.name)]))
eq_(q.count(), 2)
assert q[0] is d2
class EagerTest5(_base.MappedTest):
"""Construction of AliasedClauses for the same eager load property but different parent mappers, due to inheritance."""
def define_tables(self, metadata):
Table('base', metadata,
Column('uid', String(30), primary_key=True),
Column('x', String(30)))
Table('derived', metadata,
Column('uid', String(30), ForeignKey('base.uid'),
primary_key=True),
Column('y', String(30)))
Table('derivedII', metadata,
Column('uid', String(30), ForeignKey('base.uid'),
primary_key=True),
Column('z', String(30)))
Table('comments', metadata,
Column('id', Integer, primary_key=True),
Column('uid', String(30), ForeignKey('base.uid')),
Column('comment', String(30)))
def setup_classes(self):
class Base(_base.BasicEntity):
def __init__(self, uid, x):
self.uid = uid
self.x = x
class Derived(Base):
def __init__(self, uid, x, y):
self.uid = uid
self.x = x
self.y = y
class DerivedII(Base):
def __init__(self, uid, x, z):
self.uid = uid
self.x = x
self.z = z
class Comment(_base.BasicEntity):
def __init__(self, uid, comment):
self.uid = uid
self.comment = comment
@testing.resolve_artifact_names
def test_basic(self):
commentMapper = mapper(Comment, comments)
baseMapper = mapper(Base, base, properties=dict(
comments=relation(Comment, lazy=False,
cascade='all, delete-orphan')))
mapper(Derived, derived, inherits=baseMapper)
mapper(DerivedII, derivedII, inherits=baseMapper)
sess = create_session()
d = Derived('uid1', 'x', 'y')
d.comments = [Comment('uid1', 'comment')]
d2 = DerivedII('uid2', 'xx', 'z')
d2.comments = [Comment('uid2', 'comment')]
sess.add_all((d, d2))
sess.flush()
sess.clear()
# this eager load sets up an AliasedClauses for the "comment"
# relationship, then stores it in clauses_by_lead_mapper[mapper for
# Derived]
d = sess.query(Derived).get('uid1')
sess.clear()
assert len([c for c in d.comments]) == 1
# this eager load sets up an AliasedClauses for the "comment"
# relationship, and should store it in clauses_by_lead_mapper[mapper
# for DerivedII]. the bug was that the previous AliasedClause create
# prevented this population from occurring.
d2 = sess.query(DerivedII).get('uid2')
sess.clear()
# object is not in the session; therefore the lazy load cant trigger
# here, eager load had to succeed
assert len([c for c in d2.comments]) == 1
class EagerTest6(_base.MappedTest):
def define_tables(self, metadata):
Table('design_types', metadata,
Column('design_type_id', Integer, primary_key=True))
Table('design', metadata,
Column('design_id', Integer, primary_key=True),
Column('design_type_id', Integer,
ForeignKey('design_types.design_type_id')))
Table('parts', metadata,
Column('part_id', Integer, primary_key=True),
Column('design_id', Integer, ForeignKey('design.design_id')),
Column('design_type_id', Integer,
ForeignKey('design_types.design_type_id')))
Table('inherited_part', metadata,
Column('ip_id', Integer, primary_key=True),
Column('part_id', Integer, ForeignKey('parts.part_id')),
Column('design_id', Integer, ForeignKey('design.design_id')))
def setup_classes(self):
class Part(_base.BasicEntity):
pass
class Design(_base.BasicEntity):
pass
class DesignType(_base.BasicEntity):
pass
class InheritedPart(_base.BasicEntity):
pass
@testing.resolve_artifact_names
def test_one(self):
p_m = mapper(Part, parts)
mapper(InheritedPart, inherited_part, properties=dict(
part=relation(Part, lazy=False)))
d_m = mapper(Design, design, properties=dict(
inheritedParts=relation(InheritedPart,
cascade="all, delete-orphan",
backref="design")))
mapper(DesignType, design_types)
d_m.add_property(
"type", relation(DesignType, lazy=False, backref="designs"))
p_m.add_property(
"design", relation(
Design, lazy=False,
backref=backref("parts", cascade="all, delete-orphan")))
d = Design()
sess = create_session()
sess.add(d)
sess.flush()
sess.clear()
x = sess.query(Design).get(1)
x.inheritedParts
class EagerTest7(_base.MappedTest):
def define_tables(self, metadata):
Table('companies', metadata,
Column('company_id', Integer, primary_key=True,
test_needs_autoincrement=True),
Column('company_name', String(40)))
Table('addresses', metadata,
Column('address_id', Integer, primary_key=True,
test_needs_autoincrement=True),
Column('company_id', Integer, ForeignKey("companies.company_id")),
Column('address', String(40)))
Table('phone_numbers', metadata,
Column('phone_id', Integer, primary_key=True,
test_needs_autoincrement=True),
Column('address_id', Integer, ForeignKey('addresses.address_id')),
Column('type', String(20)),
Column('number', String(10)))
Table('invoices', metadata,
Column('invoice_id', Integer, primary_key=True,
test_needs_autoincrement=True),
Column('company_id', Integer, ForeignKey("companies.company_id")),
Column('date', sa.DateTime))
Table('items', metadata,
Column('item_id', Integer, primary_key=True,
test_needs_autoincrement=True),
Column('invoice_id', Integer, ForeignKey('invoices.invoice_id')),
Column('code', String(20)),
Column('qty', Integer))
def setup_classes(self):
class Company(_base.ComparableEntity):
pass
class Address(_base.ComparableEntity):
pass
class Phone(_base.ComparableEntity):
pass
class Item(_base.ComparableEntity):
pass
class Invoice(_base.ComparableEntity):
pass
@testing.resolve_artifact_names
def testone(self):
"""
Tests eager load of a many-to-one attached to a one-to-many. this
testcase illustrated the bug, which is that when the single Company is
loaded, no further processing of the rows occurred in order to load
the Company's second Address object.
"""
mapper(Address, addresses)
mapper(Company, companies, properties={
'addresses' : relation(Address, lazy=False)})
mapper(Invoice, invoices, properties={
'company': relation(Company, lazy=False)})
a1 = Address(address='a1 address')
a2 = Address(address='a2 address')
c1 = Company(company_name='company 1', addresses=[a1, a2])
i1 = Invoice(date=datetime.datetime.now(), company=c1)
session = create_session()
session.add(i1)
session.flush()
company_id = c1.company_id
invoice_id = i1.invoice_id
session.clear()
c = session.query(Company).get(company_id)
session.clear()
i = session.query(Invoice).get(invoice_id)
eq_(c, i.company)
@testing.resolve_artifact_names
def testtwo(self):
"""The original testcase that includes various complicating factors"""
mapper(Phone, phone_numbers)
mapper(Address, addresses, properties={
'phones': relation(Phone, lazy=False, backref='address',
order_by=phone_numbers.default_order_by())})
mapper(Company, companies, properties={
'addresses': relation(Address, lazy=False, backref='company',
order_by=addresses.default_order_by())})
mapper(Item, items)
mapper(Invoice, invoices, properties={
'items': relation(Item, lazy=False, backref='invoice',
order_by=items.default_order_by()),
'company': relation(Company, lazy=False, backref='invoices')})
c1 = Company(company_name='company 1', addresses=[
Address(address='a1 address',
phones=[Phone(type='home', number='1111'),
Phone(type='work', number='22222')]),
Address(address='a2 address',
phones=[Phone(type='home', number='3333'),
Phone(type='work', number='44444')])
])
session = create_session()
session.add(c1)
session.flush()
company_id = c1.company_id
session.clear()
a = session.query(Company).get(company_id)
# set up an invoice
i1 = Invoice(date=datetime.datetime.now(), company=a)
item1 = Item(code='aaaa', qty=1, invoice=i1)
item2 = Item(code='bbbb', qty=2, invoice=i1)
item3 = Item(code='cccc', qty=3, invoice=i1)
session.flush()
invoice_id = i1.invoice_id
session.clear()
c = session.query(Company).get(company_id)
session.clear()
i = session.query(Invoice).get(invoice_id)
eq_(c, i.company)
class EagerTest8(_base.MappedTest):
def define_tables(self, metadata):
Table('prj', metadata,
Column('id', Integer, primary_key=True),
Column('created', sa.DateTime ),
Column('title', sa.Unicode(100)))
Table('task', metadata,
Column('id', Integer, primary_key=True),
Column('status_id', Integer,
ForeignKey('task_status.id'), nullable=False),
Column('title', sa.Unicode(100)),
Column('task_type_id', Integer ,
ForeignKey('task_type.id'), nullable=False),
Column('prj_id', Integer , ForeignKey('prj.id'), nullable=False))
Table('task_status', metadata,
Column('id', Integer, primary_key=True))
Table('task_type', metadata,
Column('id', Integer, primary_key=True))
Table('msg', metadata,
Column('id', Integer, primary_key=True),
Column('posted', sa.DateTime, index=True,),
Column('type_id', Integer, ForeignKey('msg_type.id')),
Column('task_id', Integer, ForeignKey('task.id')))
Table('msg_type', metadata,
Column('id', Integer, primary_key=True),
Column('name', sa.Unicode(20)),
Column('display_name', sa.Unicode(20)))
@testing.resolve_artifact_names
def fixtures(self):
return dict(
prj=(('id',),
(1,)),
task_status=(('id',),
(1,)),
task_type=(('id',),
(1,),),
task=(('title', 'task_type_id', 'status_id', 'prj_id'),
(u'task 1', 1, 1, 1)))
def setup_classes(self):
class Task_Type(_base.BasicEntity):
pass
class Joined(_base.ComparableEntity):
pass
@testing.fails_on('maxdb')
@testing.resolve_artifact_names
def test_nested_joins(self):
# this is testing some subtle column resolution stuff,
# concerning corresponding_column() being extremely accurate
# as well as how mapper sets up its column properties
mapper(Task_Type, task_type)
tsk_cnt_join = sa.outerjoin(prj, task, task.c.prj_id==prj.c.id)
j = sa.outerjoin(task, msg, task.c.id==msg.c.task_id)
jj = sa.select([ task.c.id.label('task_id'),
sa.func.count(msg.c.id).label('props_cnt')],
from_obj=[j],
group_by=[task.c.id]).alias('prop_c_s')
jjj = sa.join(task, jj, task.c.id == jj.c.task_id)
mapper(Joined, jjj, properties=dict(
type=relation(Task_Type, lazy=False)))
session = create_session()
eq_(session.query(Joined).limit(10).offset(0).one(),
Joined(id=1, title=u'task 1', props_cnt=0))
class EagerTest9(_base.MappedTest):
"""Test the usage of query options to eagerly load specific paths.
This relies upon the 'path' construct used by PropertyOption to relate
LoaderStrategies to specific paths, as well as the path state maintained
throughout the query setup/mapper instances process.
"""
def define_tables(self, metadata):
Table('accounts', metadata,
Column('account_id', Integer, primary_key=True),
Column('name', String(40)))
Table('transactions', metadata,
Column('transaction_id', Integer, primary_key=True),
Column('name', String(40)))
Table('entries', metadata,
Column('entry_id', Integer, primary_key=True),
Column('name', String(40)),
Column('account_id', Integer,
ForeignKey('accounts.account_id')),
Column('transaction_id', Integer,
ForeignKey('transactions.transaction_id')))
def setup_classes(self):
class Account(_base.BasicEntity):
pass
class Transaction(_base.BasicEntity):
pass
class Entry(_base.BasicEntity):
pass
@testing.resolve_artifact_names
def setup_mappers(self):
mapper(Account, accounts)
mapper(Transaction, transactions)
mapper(Entry, entries, properties=dict(
account=relation(Account,
uselist=False,
backref=backref('entries', lazy=True,
order_by=entries.c.entry_id)),
transaction=relation(Transaction,
uselist=False,
backref=backref('entries', lazy=False,
order_by=entries.c.entry_id))))
@testing.fails_on('maxdb')
@testing.resolve_artifact_names
def test_eagerload_on_path(self):
session = create_session()
tx1 = Transaction(name='tx1')
tx2 = Transaction(name='tx2')
acc1 = Account(name='acc1')
ent11 = Entry(name='ent11', account=acc1, transaction=tx1)
ent12 = Entry(name='ent12', account=acc1, transaction=tx2)
acc2 = Account(name='acc2')
ent21 = Entry(name='ent21', account=acc2, transaction=tx1)
ent22 = Entry(name='ent22', account=acc2, transaction=tx2)
session.add(acc1)
session.flush()
session.clear()
def go():
# load just the first Account. eager loading will actually load
# all objects saved thus far, but will not eagerly load the
# "accounts" off the immediate "entries"; only the "accounts" off
# the entries->transaction->entries
acc = (session.query(Account).
options(sa.orm.eagerload_all('entries.transaction.entries.account')).
order_by(Account.account_id)).first()
# no sql occurs
eq_(acc.name, 'acc1')
eq_(acc.entries[0].transaction.entries[0].account.name, 'acc1')
eq_(acc.entries[0].transaction.entries[1].account.name, 'acc2')
# lazyload triggers but no sql occurs because many-to-one uses
# cached query.get()
for e in acc.entries:
assert e.account is acc
self.assert_sql_count(testing.db, go, 1)
if __name__ == "__main__":
testenv.main()