diff options
Diffstat (limited to 'lib/sqlalchemy/orm')
| -rw-r--r-- | lib/sqlalchemy/orm/descriptor_props.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/interfaces.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/mapper.py | 6 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/properties.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/query.py | 4 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/relationships.py | 6 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/session.py | 4 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/strategies.py | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/orm/util.py | 2 |
9 files changed, 15 insertions, 15 deletions
diff --git a/lib/sqlalchemy/orm/descriptor_props.py b/lib/sqlalchemy/orm/descriptor_props.py index 6c87ef9ba..316ef4df4 100644 --- a/lib/sqlalchemy/orm/descriptor_props.py +++ b/lib/sqlalchemy/orm/descriptor_props.py @@ -628,7 +628,7 @@ class ComparableProperty(DescriptorProperty): the :mod:`~sqlalchemy.ext.hybrid` extension. See the example at :ref:`hybrid_custom_comparators`. - Allows any Python descriptor to behave like a SQL-enabled + Allows any Python descriptor to behave like an SQL-enabled attribute when used at the class level in queries, allowing redefinition of expression operator behavior. diff --git a/lib/sqlalchemy/orm/interfaces.py b/lib/sqlalchemy/orm/interfaces.py index faab70e37..8a024b683 100644 --- a/lib/sqlalchemy/orm/interfaces.py +++ b/lib/sqlalchemy/orm/interfaces.py @@ -109,7 +109,7 @@ class MapperProperty(_MappedAttribute, InspectionAttr, util.MemoizedSlots): return {} def setup(self, context, entity, path, adapter, **kwargs): - """Called by Query for the purposes of constructing a SQL statement. + """Called by Query for the purposes of constructing an SQL statement. Each MapperProperty associated with the target mapper processes the statement referenced by the query context, adding columns and/or diff --git a/lib/sqlalchemy/orm/mapper.py b/lib/sqlalchemy/orm/mapper.py index 2236b2f76..23be6556d 100644 --- a/lib/sqlalchemy/orm/mapper.py +++ b/lib/sqlalchemy/orm/mapper.py @@ -266,7 +266,7 @@ class Mapper(InspectionAttr): :ref:`inheritance_toplevel` - :param inherit_condition: For joined table inheritance, a SQL + :param inherit_condition: For joined table inheritance, an SQL expression which will define how the two tables are joined; defaults to a natural join between the two tables. @@ -396,7 +396,7 @@ class Mapper(InspectionAttr): } It may also be specified - as a SQL expression, as in this example where we + as an SQL expression, as in this example where we use the :func:`.case` construct to provide a conditional approach:: @@ -436,7 +436,7 @@ class Mapper(InspectionAttr): } .. versionchanged:: 0.7.4 - ``polymorphic_on`` may be specified as a SQL expression, + ``polymorphic_on`` may be specified as an SQL expression, or refer to any attribute configured with :func:`.column_property`, or to the string name of one. diff --git a/lib/sqlalchemy/orm/properties.py b/lib/sqlalchemy/orm/properties.py index f3dce7541..d4fc03160 100644 --- a/lib/sqlalchemy/orm/properties.py +++ b/lib/sqlalchemy/orm/properties.py @@ -88,7 +88,7 @@ class ColumnProperty(StrategizedProperty): :param expire_on_flush=True: Disable expiry on flush. A column_property() which refers - to a SQL expression (and not a single table-bound column) + to an SQL expression (and not a single table-bound column) is considered to be a "read only" property; populating it has no effect on the state of data, and it can only return database state. For this reason a column_property()'s value diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index 4606c2ffb..11cdc58f2 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -650,7 +650,7 @@ class Query(object): """A readonly attribute which returns the current WHERE criterion for this Query. - This returned value is a SQL expression construct, or ``None`` if no + This returned value is an SQL expression construct, or ``None`` if no criterion has been established. """ @@ -1688,7 +1688,7 @@ class Query(object): ) def join(self, *props, **kwargs): - """Create a SQL JOIN against this :class:`.Query` object's criterion + """Create an SQL JOIN against this :class:`.Query` object's criterion and apply generatively, returning the newly resulting :class:`.Query`. **Simple Relationship Joins** diff --git a/lib/sqlalchemy/orm/relationships.py b/lib/sqlalchemy/orm/relationships.py index 17f94d4af..46f6a8131 100644 --- a/lib/sqlalchemy/orm/relationships.py +++ b/lib/sqlalchemy/orm/relationships.py @@ -438,7 +438,7 @@ class RelationshipProperty(StrategizedProperty): construct a non-standard join condition, which makes use of columns or expressions that do not normally refer to their "parent" column, such as a join condition expressed by a - complex comparison using a SQL function. + complex comparison using an SQL function. The :func:`.relationship` construct will raise informative error messages that suggest the use of the @@ -672,7 +672,7 @@ class RelationshipProperty(StrategizedProperty): :ref:`post_update` - Introductory documentation and examples. :param primaryjoin: - a SQL expression that will be used as the primary + an SQL expression that will be used as the primary join of this child object against the parent object, or in a many-to-many relationship the join of the primary object to the association table. By default, this value is computed based on the @@ -727,7 +727,7 @@ class RelationshipProperty(StrategizedProperty): relationship loaders. :param secondaryjoin: - a SQL expression that will be used as the join of + an SQL expression that will be used as the join of an association table to the child object. By default, this value is computed based on the foreign key relationships of the association and child tables. diff --git a/lib/sqlalchemy/orm/session.py b/lib/sqlalchemy/orm/session.py index 1cf1bdb24..7a99a0e75 100644 --- a/lib/sqlalchemy/orm/session.py +++ b/lib/sqlalchemy/orm/session.py @@ -913,7 +913,7 @@ class Session(_SessionClassMethods): return conn def execute(self, clause, params=None, mapper=None, bind=None, **kw): - """Execute a SQL expression construct or string statement within + """Execute an SQL expression construct or string statement within the current transaction. Returns a :class:`.ResultProxy` representing @@ -2443,7 +2443,7 @@ class Session(_SessionClassMethods): cases, the attribute is assumed to have a change, even if there is ultimately no net change against its database value. SQLAlchemy in most cases does not need the "old" value when a set event occurs, so - it skips the expense of a SQL call if the old value isn't present, + it skips the expense of an SQL call if the old value isn't present, based on the assumption that an UPDATE of the scalar value is usually needed, and in those few cases where it isn't, is less expensive on average than issuing a defensive SELECT. diff --git a/lib/sqlalchemy/orm/strategies.py b/lib/sqlalchemy/orm/strategies.py index 370cb974b..27afe2a98 100644 --- a/lib/sqlalchemy/orm/strategies.py +++ b/lib/sqlalchemy/orm/strategies.py @@ -100,7 +100,7 @@ def _register_attribute( @properties.ColumnProperty.strategy_for(instrument=False, deferred=False) class UninstrumentedColumnLoader(LoaderStrategy): - """Represent the a non-instrumented MapperProperty. + """Represent a non-instrumented MapperProperty. The polymorphic_on argument of mapper() often results in this, if the argument is against the with_polymorphic selectable. diff --git a/lib/sqlalchemy/orm/util.py b/lib/sqlalchemy/orm/util.py index f76be0380..d7c21c726 100644 --- a/lib/sqlalchemy/orm/util.py +++ b/lib/sqlalchemy/orm/util.py @@ -895,7 +895,7 @@ def join( left and right selectables may be not only core selectable objects such as :class:`.Table`, but also mapped classes or :class:`.AliasedClass` instances. The "on" clause can - be a SQL expression, or an attribute or string name + be an SQL expression, or an attribute or string name referencing a configured :func:`.relationship`. :func:`.orm.join` is not commonly needed in modern usage, |