PublicArchive/sqlalchemy
2
0
Fork 0
mirror of https://github.com/sqlalchemy/sqlalchemy.git synced 2026-06-05 23:37:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

fix Query.update docstring

Browse Source
This commit is contained in:
Gaëtan de Menten
2009-02-10 11:25:25 +00:00
parent 03b5b34114
commit a9817ae244
1 changed files with 70 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/sqlalchemy/orm/query.py
+70 -70
View File
@@ -43,7 +43,7 @@ aliased = AliasedClass
def _generative(*assertions):
"""Mark a method as generative."""
@util.decorator
def generate(fn, *args, **kw):
self = args[0]._clone()
@@ -139,7 +139,7 @@ class Query(object):
if isinstance(from_obj, expression.Alias):
self._from_obj_alias = sql_util.ColumnAdapter(self._from_obj, equivs)
def _get_polymorphic_adapter(self, entity, selectable):
self.__mapper_loads_polymorphically_with(entity.mapper, sql_util.ColumnAdapter(selectable, entity.mapper._equivalent_columns))
@@ -282,7 +282,7 @@ class Query(object):
if self._order_by:
raise sa_exc.InvalidRequestError("Query.%s() being called on a Query with existing criterion. " % meth)
self.__no_criterion_condition(meth)
def __no_statement_condition(self, meth):
if self._statement:
raise sa_exc.InvalidRequestError(
@@ -317,35 +317,35 @@ class Query(object):
@property
def statement(self):
"""The full SELECT statement represented by this Query."""
return self._compile_context(labels=self._with_labels).statement._annotate({'_halt_adapt': True})
def subquery(self):
"""return the full SELECT statement represented by this Query, embedded within an Alias.
Eager JOIN generation within the query is disabled.
"""
return self.enable_eagerloads(False).statement.alias()
def __clause_element__(self):
return self.enable_eagerloads(False).statement
@_generative()
def enable_eagerloads(self, value):
"""Control whether or not eager joins are rendered.
When set to False, the returned Query will not render
When set to False, the returned Query will not render
eager joins regardless of eagerload() options
or mapper-level lazy=False configurations.
This is used primarily when nesting the Query's
statement into a subquery or other
selectable.
"""
self._enable_eagerloads = value
@_generative()
def with_labels(self):
"""Apply column labels to the return value of Query.statement.
@@ -408,7 +408,7 @@ class Query(object):
attribute of the mapper will be used, if any. This is useful
for mappers that don't have polymorphic loading behavior by default,
such as concrete table mappers.
"""
entity = self._generate_mapper_zero()
entity.set_with_polymorphic(self, cls_or_mappers, selectable=selectable, discriminator=discriminator)
@@ -726,20 +726,20 @@ class Query(object):
q2 = sess.query(SomeClass).filter(SomeClass.bar=='foo')
q3 = q1.union(q2)
The method accepts multiple Query objects so as to control
the level of nesting. A series of ``union()`` calls such as::
x.union(y).union(z).all()
will nest on each ``union()``, and produces::
SELECT * FROM (SELECT * FROM (SELECT * FROM X UNION SELECT * FROM y) UNION SELECT * FROM Z)
Whereas::
x.union(y, z).all()
produces::
SELECT * FROM (SELECT * FROM X UNION SELECT * FROM y UNION SELECT * FROM Z)
@@ -885,7 +885,7 @@ class Query(object):
@_generative(__no_statement_condition, __no_limit_offset)
def __join(self, keys, outerjoin, create_aliases, from_joinpoint):
# copy collections that may mutate so they do not affect
# the copied-from query.
self.__currenttables = set(self.__currenttables)
@@ -902,7 +902,7 @@ class Query(object):
# after the method completes,
# the query's joinpoint will be set to this.
right_entity = None
for arg1 in util.to_list(keys):
aliased_entity = False
alias_criterion = False
@@ -968,7 +968,7 @@ class Query(object):
if ent.corresponds_to(left_entity):
clause = ent.selectable
break
if not clause:
if isinstance(onclause, interfaces.PropComparator):
clause = onclause.__clause_element__()
@@ -983,14 +983,14 @@ class Query(object):
onclause = prop
# start looking at the right side of the join
mp, right_selectable, is_aliased_class = _entity_info(right_entity)
if mp is not None and right_mapper is not None and not mp.common_parent(right_mapper):
raise sa_exc.InvalidRequestError(
"Join target %s does not correspond to the right side of join condition %s" % (right_entity, onclause)
)
if not right_mapper and mp:
right_mapper = mp
@@ -1002,7 +1002,7 @@ class Query(object):
if not right_selectable.is_derived_from(right_mapper.mapped_table):
raise sa_exc.InvalidRequestError(
"Selectable '%s' is not derived from '%s'" %
"Selectable '%s' is not derived from '%s'" %
(right_selectable.description, right_mapper.mapped_table.description))
if not isinstance(right_selectable, expression.Alias):
@@ -1024,7 +1024,7 @@ class Query(object):
# for joins across plain relation()s, try not to specify the
# same joins twice. the __currenttables collection tracks
# what plain mapped tables we've joined to already.
if prop.table in self.__currenttables:
if prop.secondary is not None and prop.secondary not in self.__currenttables:
# TODO: this check is not strong enough for different paths to the same endpoint which
@@ -1037,7 +1037,7 @@ class Query(object):
if prop.secondary:
self.__currenttables.add(prop.secondary)
self.__currenttables.add(prop.table)
if of_type:
right_entity = of_type
else:
@@ -1055,8 +1055,8 @@ class Query(object):
onclause = right_adapter.traverse(onclause)
onclause = self._adapt_clause(onclause, False, True)
# determine if we want _ORMJoin to alias the onclause
# to the given left side. This is used if we're joining against a
# determine if we want _ORMJoin to alias the onclause
# to the given left side. This is used if we're joining against a
# select_from() selectable, from_self() call, or the onclause
# has been resolved into a MapperProperty. Otherwise we assume
# the onclause itself contains more specific information on how to
@@ -1064,10 +1064,10 @@ class Query(object):
join_to_left = not is_aliased_class or \
onclause is prop or \
clause is self._from_obj and self._from_obj_alias
# create the join
# create the join
clause = orm_join(clause, right_entity, onclause, isouter=outerjoin, join_to_left=join_to_left)
# set up state for the query as a whole
if alias_criterion:
# adapt filter() calls based on our right side adaptation
@@ -1078,14 +1078,14 @@ class Query(object):
# and adapt when it renders columns and fetches them from results
if aliased_entity:
self.__mapper_loads_polymorphically_with(
right_mapper,
right_mapper,
ORMAdapter(right_entity, equivalents=right_mapper._equivalent_columns)
)
# loop finished. we're selecting from
# loop finished. we're selecting from
# our final clause now
self._from_obj = clause
# future joins with from_joinpoint=True join from our established right_entity.
self._joinpoint = right_entity
@@ -1124,13 +1124,13 @@ class Query(object):
if isinstance(stop, int) and isinstance(start, int) and stop - start <= 0:
return []
# perhaps we should execute a count() here so that we
# can still use LIMIT/OFFSET ?
elif (isinstance(start, int) and start < 0) \
or (isinstance(stop, int) and stop < 0):
return list(self)[item]
res = self.slice(start, stop)
if step is not None:
return list(res)[None:None:item.step]
@@ -1202,7 +1202,7 @@ class Query(object):
if not isinstance(statement, (expression._TextClause, expression._SelectBaseMixin)):
raise sa_exc.ArgumentError("from_statement accepts text(), select(), and union() objects only.")
self._statement = statement
def first(self):
@@ -1437,18 +1437,18 @@ class Query(object):
def count(self):
"""Apply this query's criterion to a SELECT COUNT statement.
If column expressions or LIMIT/OFFSET/DISTINCT are present,
the query "SELECT count(1) FROM (SELECT ...)" is issued,
the query "SELECT count(1) FROM (SELECT ...)" is issued,
so that the result matches the total number of rows
this query would return. For mapped entities,
the primary key columns of each is written to the
the primary key columns of each is written to the
columns clause of the nested SELECT statement.
For a Query which is only against mapped entities,
a simpler "SELECT count(1) FROM table1, table2, ...
WHERE criterion" is issued.
a simpler "SELECT count(1) FROM table1, table2, ...
WHERE criterion" is issued.
"""
should_nest = [self._should_nest_selectable]
def ent_cols(ent):
@@ -1457,8 +1457,8 @@ class Query(object):
else:
should_nest[0] = True
return [ent.column]
return self._col_aggregate(sql.literal_column('1'), sql.func.count,
return self._col_aggregate(sql.literal_column('1'), sql.func.count,
nested_cols=chain(*[ent_cols(ent) for ent in self._entities]),
should_nest = should_nest[0]
)
@@ -1496,9 +1496,9 @@ class Query(object):
def delete(self, synchronize_session='fetch'):
"""Perform a bulk delete query.
Deletes rows matched by this query from the database.
:param synchronize_session: chooses the strategy for the removal of matched
Deletes rows matched by this query from the database.
:param synchronize_session: chooses the strategy for the removal of matched
objects from the session. Valid values are:
False
@@ -1526,10 +1526,10 @@ class Query(object):
The method does *not* offer in-Python cascading of relations - it is assumed that
ON DELETE CASCADE is configured for any foreign key references which require it.
The Session needs to be expired (occurs automatically after commit(), or call expire_all())
in order for the state of dependent objects subject to delete or delete-orphan cascade to be
in order for the state of dependent objects subject to delete or delete-orphan cascade to be
correctly represented.
Also, the ``before_delete()`` and ``after_delete()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension`
Also, the ``before_delete()`` and ``after_delete()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension`
methods are not called from this method. For a delete hook here, use the
``after_bulk_delete()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension` method.
@@ -1588,11 +1588,11 @@ class Query(object):
def update(self, values, synchronize_session='expire'):
"""Perform a bulk update query.
Updates rows matched by this query in the database.
Updates rows matched by this query in the database.
:param values: a dictionary with attributes names as keys and literal values or sql expressions
as values.
as values.
:param synchronize_session: chooses the strategy to update the
attributes on objects in the session. Valid values are:
@@ -1618,12 +1618,12 @@ class Query(object):
The method does *not* offer in-Python cascading of relations - it is assumed that
ON UPDATE CASCADE is configured for any foreign key references which require it.
The Session needs to be expired (occurs automatically after commit(), or call expire_all())
in order for the state of dependent objects subject foreign key cascade to be
in order for the state of dependent objects subject foreign key cascade to be
correctly represented.
Also, the ``before_update()`` and ``after_update()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension`
Also, the ``before_update()`` and ``after_update()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension`
methods are not called from this method. For an update hook here, use the
``after_bulk_update()`` :class:`~sqlalchemy.orm.interfaces.MapperExtension` method.
``after_bulk_update()`` :class:`~sqlalchemy.orm.interfaces.SessionExtension` method.
"""
@@ -1692,7 +1692,7 @@ class Query(object):
for ext in session.extensions:
ext.after_bulk_update(session, self, context, result)
return result.rowcount
def _compile_context(self, labels=True):
@@ -1957,7 +1957,7 @@ class _MapperEntity(_QueryEntity):
# apply adaptation to the mapper's order_by if needed.
if adapter:
context.order_by = adapter.adapt_list(util.to_list(context.order_by))
for value in self.mapper._iterate_polymorphic_properties(self._with_polymorphic):
if query._only_load_props and value.key not in query._only_load_props:
continue
@@ -1969,14 +1969,14 @@ class _MapperEntity(_QueryEntity):
only_load_props=query._only_load_props,
column_collection=context.primary_columns
)
if self._polymorphic_discriminator:
if adapter:
pd = adapter.columns[self._polymorphic_discriminator]
else:
pd = self._polymorphic_discriminator
context.primary_columns.append(pd)
def __str__(self):
return str(self.mapper)
@@ -1993,13 +1993,13 @@ class _ColumnEntity(_QueryEntity):
column = column.__clause_element__()
else:
self._result_label = getattr(column, 'key', None)
if not isinstance(column, expression.ColumnElement) and hasattr(column, '_select_iterable'):
for c in column._select_iterable:
if c is column:
break
_ColumnEntity(query, c)
if c is not column:
return