diff options
Diffstat (limited to 'doc/build')
25 files changed, 106 insertions, 106 deletions
diff --git a/doc/build/changelog/changelog_01.rst b/doc/build/changelog/changelog_01.rst index 0f66f99e4..a8ce578f5 100644 --- a/doc/build/changelog/changelog_01.rst +++ b/doc/build/changelog/changelog_01.rst @@ -48,7 +48,7 @@ :tags: :tickets: - types types types! still werent working....have to use TypeDecorator again :( + types types types! still weren't working....have to use TypeDecorator again :( .. change:: :tags: @@ -477,7 +477,7 @@ :tickets: fixed attributes bug where if an object is committed, its lazy-loaded list got - blown away if it hadnt been loaded + blown away if it hadn't been loaded .. change:: :tags: @@ -854,11 +854,11 @@ :tags: :tickets: - two issues related to postgres, which doesnt want to give you the "lastrowid" + two issues related to postgres, which doesn't want to give you the "lastrowid" since oids are deprecated: * postgres database-side defaults that are on primary key cols *do* execute - explicitly beforehand, even though thats not the idea of a PassiveDefault. this is + explicitly beforehand, even though that's not the idea of a PassiveDefault. this is because sequences on columns get reflected as PassiveDefaults, but need to be explicitly executed on a primary key col so we know what we just inserted. * if you did add a row that has a bunch of database-side defaults on it, diff --git a/doc/build/changelog/changelog_02.rst b/doc/build/changelog/changelog_02.rst index c3b91f1bd..44b77b664 100644 --- a/doc/build/changelog/changelog_02.rst +++ b/doc/build/changelog/changelog_02.rst @@ -81,7 +81,7 @@ unit-of-work does a better check for "orphaned" objects that are part of a "delete-orphan" cascade, for certain conditions where the - parent isnt available to cascade from. + parent isn't available to cascade from. .. change:: :tags: @@ -164,7 +164,7 @@ so far will convert this to "TIME[STAMP] (WITH|WITHOUT) TIME ZONE", so that control over timezone presence is more controllable (psycopg2 returns datetimes with tzinfo's if available, which can create confusion - against datetimes that dont). + against datetimes that don't). .. change:: :tags: @@ -229,8 +229,8 @@ with the session, and the INSERT statements are then sorted within the mapper save_obj. the INSERT ordering has basically been pushed all the way to the end of the flush cycle. that way the various sorts and - organizations occuring within UOWTask (particularly the circular task - sort) dont have to worry about maintaining order (which they werent anyway) + organizations occurring within UOWTask (particularly the circular task + sort) don't have to worry about maintaining order (which they weren't anyway) .. change:: :tags: @@ -392,7 +392,7 @@ :tags: :tickets: - overhaul to MapperExtension calling scheme, wasnt working very well + overhaul to MapperExtension calling scheme, wasn't working very well previously .. change:: @@ -432,7 +432,7 @@ :tags: :tickets: - select_table mappers *still* werent always compiling + select_table mappers *still* weren't always compiling .. change:: :tags: @@ -647,7 +647,7 @@ :tickets: 206 utterly remarkable: added a single space between 'CREATE TABLE' - and '(<the rest of it>' since *thats how MySQL indicates a non- + and '(<the rest of it>' since *that's how MySQL indicates a non- reserved word tablename.....* .. change:: @@ -743,7 +743,7 @@ of an attribute is no longer micromanaged with each change and is instead part of a "CommittedState" object created when the instance is first loaded. HistoryArraySet is gone, the behavior of - list attributes is now more open ended (i.e. theyre not sets anymore). + list attributes is now more open ended (i.e. they're not sets anymore). .. change:: :tags: @@ -757,7 +757,7 @@ :tickets: fix to transaction control, so that repeated rollback() calls - dont fail (was failing pretty badly when flush() would raise + don't fail (was failing pretty badly when flush() would raise an exception in a larger try/except transaction block) .. change:: @@ -771,14 +771,14 @@ :tags: :tickets: - fixed bug where tables with schema names werent getting indexed in + fixed bug where tables with schema names weren't getting indexed in the MetaData object properly .. change:: :tags: :tickets: 207 - fixed bug where Column with redefined "key" property wasnt getting + fixed bug where Column with redefined "key" property wasn't getting type conversion happening in the ResultProxy .. change:: @@ -792,7 +792,7 @@ :tickets: fixed old bug where if a many-to-many table mapped as "secondary" - had extra columns, delete operations didnt work + had extra columns, delete operations didn't work .. change:: :tags: @@ -811,7 +811,7 @@ :tickets: 138 added NonExistentTable exception thrown when reflecting a table - that doesnt exist + that doesn't exist .. change:: :tags: @@ -1010,7 +1010,7 @@ :tags: :tickets: - placeholder dispose() method added to SingletonThreadPool, doesnt + placeholder dispose() method added to SingletonThreadPool, doesn't do anything yet .. change:: @@ -1018,7 +1018,7 @@ :tickets: rollback() is automatically called when an exception is raised, - but only if theres no transaction in process (i.e. works more like + but only if there's no transaction in process (i.e. works more like autocommit). .. change:: @@ -1114,7 +1114,7 @@ "oid" system has been totally moved into compile-time behavior; if they are used in an order_by where they are not available, the order_by - doesnt get compiled, fixes + doesn't get compiled, fixes .. change:: :tags: diff --git a/doc/build/changelog/changelog_03.rst b/doc/build/changelog/changelog_03.rst index 05e10e664..7c0a1af26 100644 --- a/doc/build/changelog/changelog_03.rst +++ b/doc/build/changelog/changelog_03.rst @@ -25,7 +25,7 @@ :tags: sql :tickets: 768 - dont assume join criterion consists only of column objects + don't assume join criterion consists only of column objects .. change:: :tags: sql @@ -305,7 +305,7 @@ :tags: sql :tickets: - ForeignKey to a table in a schema thats not the default schema + ForeignKey to a table in a schema that's not the default schema requires the schema to be explicit; i.e. ForeignKey('alt_schema.users.id') .. change:: @@ -558,7 +558,7 @@ :tags: sqlite :tickets: 603 - string PK column inserts dont get overwritten with OID + string PK column inserts don't get overwritten with OID .. change:: :tags: mssql @@ -634,7 +634,7 @@ parenthesis are applied to clauses via a new _Grouping construct. uses operator precedence to more intelligently apply parenthesis to clauses, provides cleaner nesting of clauses - (doesnt mutate clauses placed in other clauses, i.e. no 'parens' + (doesn't mutate clauses placed in other clauses, i.e. no 'parens' flag) .. change:: @@ -648,7 +648,7 @@ :tags: sql :tickets: 578 - removed "no group by's in a select thats part of a UNION" + removed "no group by's in a select that's part of a UNION" restriction .. change:: @@ -666,7 +666,7 @@ :tags: orm :tickets: - fixed bug in query.instances() that wouldnt handle more than + fixed bug in query.instances() that wouldn't handle more than on additional mapper or one additional column. .. change:: @@ -923,7 +923,7 @@ means their lengths are dialect-dependent. So on oracle a label that gets truncated to 30 chars will go out to 63 characters on postgres. Also, the true labelname is always attached as the - accessor on the parent Selectable so theres no need to be aware + accessor on the parent Selectable so there's no need to be aware of the "truncated" label names. .. change:: @@ -941,7 +941,7 @@ :tickets: 513 the "mini" column labels generated when using subqueries, which - are to work around glitchy SQLite behavior that doesnt understand + are to work around glitchy SQLite behavior that doesn't understand "foo.id" as equivalent to "id", are now only generated in the case that those named columns are selected from (part of) @@ -1120,7 +1120,7 @@ :tickets: mysql uses "DESCRIBE.<tablename>", catching exceptions - if table doesnt exist, in order to determine if a table exists. + if table doesn't exist, in order to determine if a table exists. this supports unicode table names as well as schema names. tested with MySQL5 but should work with 4.1 series as well. (#557) @@ -1372,7 +1372,7 @@ more fixes to polymorphic relations, involving proper lazy-clause generation on many-to-one relationships to polymorphic mappers. also fixes to detection of "direction", more specific targeting of columns that belong to the polymorphic union vs. those - that dont. + that don't. .. change:: :tags: orm @@ -1468,7 +1468,7 @@ got binary working for any size input ! cx_oracle works fine, it was my fault as BINARY was being passed and not BLOB for - setinputsizes (also unit tests werent even setting input sizes). + setinputsizes (also unit tests weren't even setting input sizes). .. change:: :tags: oracle @@ -1798,7 +1798,7 @@ :tags: orm, bugs :tickets: - fix to deferred so that load operation doesnt mistakenly occur when only + fix to deferred so that load operation doesn't mistakenly occur when only PK col attributes are set .. change:: @@ -1948,7 +1948,7 @@ :tickets: type system slightly modified to support TypeDecorators that can be - overridden by the dialect (ok, thats not very clear, it allows the mssql + overridden by the dialect (ok, that's not very clear, it allows the mssql tweak below to be possible) .. change:: @@ -1998,7 +1998,7 @@ :tickets: 420 mysql is inconsistent with what kinds of quotes it uses in foreign keys - during a SHOW CREATE TABLE, reflection updated to accomodate for all three + during a SHOW CREATE TABLE, reflection updated to accommodate for all three styles .. change:: @@ -2133,7 +2133,7 @@ :tags: orm :tickets: 407 - fixed bug in mapper refresh/expire whereby eager loaders didnt properly + fixed bug in mapper refresh/expire whereby eager loaders didn't properly re-populate item lists .. change:: @@ -2265,7 +2265,7 @@ :tickets: MySQL detects errors 2006 (server has gone away) and 2014 - (commands out of sync) and invalidates the connection on which it occured. + (commands out of sync) and invalidates the connection on which it occurred. .. change:: :tags: @@ -2304,7 +2304,7 @@ :tickets: added onupdate and ondelete keyword arguments to ForeignKey; propagate - to underlying ForeignKeyConstraint if present. (dont propagate in the + to underlying ForeignKeyConstraint if present. (don't propagate in the other direction, however) .. change:: @@ -2415,9 +2415,9 @@ fixed bug in circular dependency sorting at flush time; if object A contained a cyclical many-to-one relationship to object B, and object B - was just attached to object A, *but* object B itself wasnt changed, + was just attached to object A, *but* object B itself wasn't changed, the many-to-one synchronize of B's primary key attribute to A's foreign key - attribute wouldnt occur. + attribute wouldn't occur. .. change:: :tags: orm @@ -2572,7 +2572,7 @@ a fair amount of cleanup to the schema package, removal of ambiguous methods, methods that are no longer needed. slightly more constrained - useage, greater emphasis on explicitness + usage, greater emphasis on explicitness .. change:: :tags: schema @@ -2671,7 +2671,7 @@ :tags: connections/pooling/execution :tickets: - fixed bug where Connection wouldnt lose its Transaction + fixed bug where Connection wouldn't lose its Transaction after commit/rollback .. change:: @@ -2744,7 +2744,7 @@ including the addition of a MutableType mixin which is implemented by PickleType. unit-of-work now tracks the "dirty" list as an expression of all persistent objects where the attribute manager detects changes. - The basic issue thats fixed is detecting changes on PickleType + The basic issue that's fixed is detecting changes on PickleType objects, but also generalizes type handling and "modified" object checking to be more complete and extensible. @@ -2850,7 +2850,7 @@ implemented "version check" logic in Query/Mapper, used when version_id_col is in effect and query.with_lockmode() - is used to get() an instance thats already loaded + is used to get() an instance that's already loaded .. change:: :tags: orm diff --git a/doc/build/changelog/changelog_04.rst b/doc/build/changelog/changelog_04.rst index 61ea28c11..1bd49871c 100644 --- a/doc/build/changelog/changelog_04.rst +++ b/doc/build/changelog/changelog_04.rst @@ -1524,7 +1524,7 @@ transaction directly to the parent of the transaction that could be rolled back to. Now it rolls back the next transaction up that can handle it, but sets the current - transaction to it's parent and inactivates the + transaction to its parent and inactivates the transactions in between. Inactive transactions can only be rolled back or closed, any other call results in an error. @@ -1533,7 +1533,7 @@ subtransactions. - unitofwork flush didn't close the failed transaction - when the session was not in a transaction and commiting + when the session was not in a transaction and committing the transaction failed. .. change:: @@ -1562,7 +1562,7 @@ Better support for schemas in SQLite (linked in by ATTACH DATABASE ... AS name). In some cases in the past, schema - names were ommitted from generated SQL for SQLite. This is + names were omitted from generated SQL for SQLite. This is no longer the case. .. change:: @@ -3267,7 +3267,7 @@ :tags: :tickets: - The 'Smallinteger' compatiblity name (small i!) is no longer imported, + The 'Smallinteger' compatibility name (small i!) is no longer imported, but remains in schema.py for now. SmallInteger (big I!) is still imported. @@ -3628,7 +3628,7 @@ :tickets: 643 Class-level properties are now usable as query elements... no more - '.c.'! "Class.c.propname" is now superceded by "Class.propname". All + '.c.'! "Class.c.propname" is now superseded by "Class.propname". All clause operators are supported, as well as higher level operators such as Class.prop==<some instance> for scalar attributes, Class.prop.contains(<some instance>) and Class.prop.any(<some @@ -3816,7 +3816,7 @@ query.get() clauses, etc. and act as though they are regular single-column scalars... except they're not! Use the function composite(cls, \*columns) inside of the mapper's "properties" dict, and instances of cls will be - created/mapped to a single attribute, comprised of the values correponding + created/mapped to a single attribute, comprised of the values corresponding to \*columns. .. change:: @@ -3844,7 +3844,7 @@ Joined-table inheritance will now generate the primary key columns of all inherited classes against the root table of the join only. This implies that each row in the root table is distinct to a single instance. If for - some rare reason this is not desireable, explicit primary_key settings on + some rare reason this is not desirable, explicit primary_key settings on individual mappers will override it. .. change:: @@ -3902,7 +3902,7 @@ :tickets: Speed! Clause compilation as well as the mechanics of SQL constructs have - been streamlined and simplified to a signficant degree, for a 20-30% + been streamlined and simplified to a significant degree, for a 20-30% improvement of the statement construction/compilation overhead of 0.3. .. change:: @@ -3920,7 +3920,7 @@ case_sensitive=(True|False) setting removed from schema items, since checking this state added a lot of method call overhead and there was no decent reason to ever set it to False. Table and column names which are - all lower case will be treated as case-insenstive (yes we adjust for + all lower case will be treated as case-insensitive (yes we adjust for Oracle's UPPERCASE style too). .. change:: @@ -4193,4 +4193,4 @@ Very rudimental support for OUT parameters added; use sql.outparam(name, type) to set up an OUT parameter, just like bindparam(); after execution, - values are avaiable via result.out_parameters dictionary. + values are available via result.out_parameters dictionary. diff --git a/doc/build/changelog/changelog_05.rst b/doc/build/changelog/changelog_05.rst index debcc29fd..96a0fb19f 100644 --- a/doc/build/changelog/changelog_05.rst +++ b/doc/build/changelog/changelog_05.rst @@ -51,7 +51,7 @@ correspondence for cloned selectables which contain free-standing column expressions. This bug is generally only noticeable when exercising newer - ORM behavior only availble in 0.6 via, + ORM behavior only available in 0.6 via, but is more correct at the SQL expression level as well. @@ -437,7 +437,7 @@ :tags: orm :tickets: 1501 - Fixed recursion issue which occured if a mapped object's + Fixed recursion issue which occurred if a mapped object's `__len__()` or `__nonzero__()` method resulted in state changes. @@ -567,7 +567,7 @@ and secondaryjoin do. For the extremely rare use case where the backref of a relation() has intentionally different "foreign_keys" configured, both sides now need to be - configured explicity (if they do in fact require this setting, + configured explicitly (if they do in fact require this setting, see the next note...). .. change:: @@ -794,7 +794,7 @@ graph of mappers. - Cached a wasteful "table sort" operation that previously - occured multiple times per flush, also removing significant + occurred multiple times per flush, also removing significant method call count from flush(). - Other redundant behaviors have been simplified in @@ -1325,7 +1325,7 @@ when determining "orphan" status - for a persistent object it only detects an in-python de-association event to establish the object as an "orphan". Next, the good news: to support - one-to-one via a foreign key or assocation table, or to + one-to-one via a foreign key or association table, or to support one-to-many via an association table, a new flag single_parent=True may be set which indicates objects linked to the relation are only meant to have a single parent. diff --git a/doc/build/changelog/changelog_06.rst b/doc/build/changelog/changelog_06.rst index 18d61019a..67fd0f1e9 100644 --- a/doc/build/changelog/changelog_06.rst +++ b/doc/build/changelog/changelog_06.rst @@ -837,7 +837,7 @@ The "unicode warning" against non-unicode bind data is now raised only when the - Unicode type is used explictly; not when + Unicode type is used explicitly; not when convert_unicode=True is used on the engine or String type. @@ -1517,7 +1517,7 @@ A warning is now emitted if a mapper is created against a join or other single selectable that includes multiple columns with the same name in its .c. collection, - and those columns aren't explictly named as part of + and those columns aren't explicitly named as part of the same or separate attributes (or excluded). In 0.7 this warning will be an exception. Note that this warning is not emitted when the combination occurs @@ -1813,7 +1813,7 @@ the _Label construct, i.e. the one that is produced whenever you say somecol.label(), now counts itself - in its "proxy_set" unioned with that of it's + in its "proxy_set" unioned with that of its contained column's proxy set, instead of directly returning that of the contained column. This allows column correspondence @@ -1966,7 +1966,7 @@ :tags: examples :tickets: - The beaker_caching example has been reorgnized + The beaker_caching example has been reorganized such that the Session, cache manager, declarative_base are part of environment, and custom cache code is portable and now within @@ -2948,7 +2948,7 @@ :tags: orm :tickets: - To accomodate the fact that there are now two kinds of eager + To accommodate the fact that there are now two kinds of eager loading available, the new names for eagerload() and eagerload_all() are joinedload() and joinedload_all(). The old names will remain as synonyms for the foreseeable future. @@ -3052,7 +3052,7 @@ :tags: postgresql :tickets: 997 - the TIME and TIMESTAMP types are now availble from the + the TIME and TIMESTAMP types are now available from the postgresql dialect directly, which add the PG-specific argument 'precision' to both. 'precision' and 'timezone' are correctly reflected for both TIME and @@ -3165,7 +3165,7 @@ Fixed bug in session.rollback() which involved not removing formerly "pending" objects from the session before - re-integrating "deleted" objects, typically occured with + re-integrating "deleted" objects, typically occurred with natural primary keys. If there was a primary key conflict between them, the attach of the deleted would fail internally. The formerly "pending" objects are now expunged @@ -3465,7 +3465,7 @@ the date/time/interval system created for Postgresql EXTRACT in has now been generalized into the type system. The previous behavior which often - occured of an expression "column + literal" forcing + occurred of an expression "column + literal" forcing the type of "literal" to be the same as that of "column" will now usually not occur - the type of "literal" is first derived from the Python type of the @@ -4828,7 +4828,7 @@ postgresql://scott:tiger@localhost/test postgresql+pg8000://scott:tiger@localhost/test - The "postgres" name remains for backwards compatiblity + The "postgres" name remains for backwards compatibility in the following ways: - There is a "postgres.py" dummy dialect which @@ -5000,7 +5000,7 @@ a column of type TIMESTAMP now defaults to NULL if "nullable=False" is not passed to Column(), and no default is present. This is now consistent with all other types, - and in the case of TIMESTAMP explictly renders "NULL" + and in the case of TIMESTAMP explicitly renders "NULL" due to MySQL's "switching" of default nullability for TIMESTAMP columns. diff --git a/doc/build/changelog/changelog_07.rst b/doc/build/changelog/changelog_07.rst index da89bbde3..d6fe4af90 100644 --- a/doc/build/changelog/changelog_07.rst +++ b/doc/build/changelog/changelog_07.rst @@ -499,7 +499,7 @@ :tickets: 2529 Added gaerdbms import to mysql/__init__.py, - the absense of which was preventing the new + the absence of which was preventing the new GAE dialect from being loaded. .. change:: @@ -3126,7 +3126,7 @@ :tickets: Streamlined the process by which a Select - determines what's in it's '.c' collection. + determines what's in its '.c' collection. Behaves identically, except that a raw ClauseList() passed to select([]) (which is not a documented case anyway) will @@ -3681,7 +3681,7 @@ :tags: schema :tickets: 2109 - The 'useexisting' flag on Table has been superceded + The 'useexisting' flag on Table has been superseded by a new pair of flags 'keep_existing' and 'extend_existing'. 'extend_existing' is equivalent to 'useexisting' - the existing Table is returned, @@ -4131,7 +4131,7 @@ :tags: general :tickets: 1902 - New event system, supercedes all extensions, listeners, + New event system, supersedes all extensions, listeners, etc. .. change:: @@ -4167,7 +4167,7 @@ :tags: orm :tickets: 1903 - Hybrid Attributes, implements/supercedes synonym() + Hybrid Attributes, implements/supersedes synonym() .. change:: :tags: orm @@ -4179,7 +4179,7 @@ :tags: orm :tickets: - Mutation Event Extension, supercedes "mutable=True" + Mutation Event Extension, supersedes "mutable=True" .. seealso:: @@ -4530,7 +4530,7 @@ execution_options() on Connection accepts "isolation_level" argument, sets transaction isolation level for that connection only until returned to the - connection pool, for thsoe backends which support it + connection pool, for those backends which support it (SQLite, Postgresql) .. change:: diff --git a/doc/build/changelog/changelog_08.rst b/doc/build/changelog/changelog_08.rst index cc16cd435..19f99bbde 100644 --- a/doc/build/changelog/changelog_08.rst +++ b/doc/build/changelog/changelog_08.rst @@ -389,7 +389,7 @@ attempts when an existing connection attempt is blocking. Previously, the production of new connections was serialized within the block that monitored overflow; the overflow counter is now altered within - it's own critical section outside of the connection process itself. + its own critical section outside of the connection process itself. .. change:: :tags: bug, engine, pool diff --git a/doc/build/changelog/changelog_09.rst b/doc/build/changelog/changelog_09.rst index 054e41efb..f51244815 100644 --- a/doc/build/changelog/changelog_09.rst +++ b/doc/build/changelog/changelog_09.rst @@ -121,7 +121,7 @@ that the cursor rowcount matches the number of primary keys that should have matched; this behavior had been taken off in most cases (except when version_id is used) to support the unusual edge case of - self-referential ON DELETE CASCADE; to accomodate this, the message + self-referential ON DELETE CASCADE; to accommodate this, the message is now just a warning, not an exception, and the flag can be used to indicate a mapping that expects self-refererntial cascaded deletes of this nature. See also :ticket:`2403` for background on the @@ -1270,7 +1270,7 @@ :tags: feature, orm The :class:`.exc.StatementError` or DBAPI-related subclass - now can accomodate additional information about the "reason" for + now can accommodate additional information about the "reason" for the exception; the :class:`.Session` now adds some detail to it when the exception occurs within an autoflush. This approach is taken as opposed to combining :class:`.FlushError` with @@ -1888,7 +1888,7 @@ operations. End user code which emulates the behavior of backrefs must now ensure that recursive event propagation schemes are halted, if the scheme does not use the backref handlers. Using this new system, - backref handlers can now peform a + backref handlers can now perform a "two-hop" operation when an object is appended to a collection, associated with a new many-to-one, de-associated with the previous many-to-one, and then removed from a previous collection. Before this @@ -2096,7 +2096,7 @@ The "auto-aliasing" behavior of the :meth:`.Query.select_from` method has been turned off. The specific behavior is now - availble via a new method :meth:`.Query.select_entity_from`. + available via a new method :meth:`.Query.select_entity_from`. The auto-aliasing behavior here was never well documented and is generally not what's desired, as :meth:`.Query.select_from` has become more oriented towards controlling how a JOIN is diff --git a/doc/build/changelog/migration_04.rst b/doc/build/changelog/migration_04.rst index cb53534af..068b002ad 100644 --- a/doc/build/changelog/migration_04.rst +++ b/doc/build/changelog/migration_04.rst @@ -305,7 +305,7 @@ So what happens when we say: Notice the nice clean alias names too. The joining doesn't care if it's against the same immediate table or some other -object which then cycles back to the beginining. Any kind +object which then cycles back to the beginning. Any kind of chain of eager loads can cycle back onto itself when ``join_depth`` is specified. When not present, eager loading automatically stops when it hits a cycle. diff --git a/doc/build/changelog/migration_06.rst b/doc/build/changelog/migration_06.rst index 8a55c0373..21eba3d8c 100644 --- a/doc/build/changelog/migration_06.rst +++ b/doc/build/changelog/migration_06.rst @@ -935,7 +935,7 @@ parent rows. To make room for the new subquery load feature, the existing ```eagerload()````/````eagerload_all()```` options are now -superceded by ````joinedload()```` and +superseded by ````joinedload()```` and ````joinedload_all()````. The old names will hang around for the foreseeable future just like ````relation()```. diff --git a/doc/build/changelog/migration_08.rst b/doc/build/changelog/migration_08.rst index 9f1715e28..ab43e22ee 100644 --- a/doc/build/changelog/migration_08.rst +++ b/doc/build/changelog/migration_08.rst @@ -1176,7 +1176,7 @@ Prior to this change, the above would return:: which is invalid SQL as "t1" is not referred to in any FROM clause. -Now, in the absense of an enclosing SELECT, it returns:: +Now, in the absence of an enclosing SELECT, it returns:: SELECT t1.x, t2.y FROM t1, t2 diff --git a/doc/build/changelog/migration_09.rst b/doc/build/changelog/migration_09.rst index 069715654..72ef80c12 100644 --- a/doc/build/changelog/migration_09.rst +++ b/doc/build/changelog/migration_09.rst @@ -1373,7 +1373,7 @@ End-user code which a. makes use of the :meth:`.AttributeEvents.set`, :meth:`.AttributeEvents.append`, or :meth:`.AttributeEvents.remove` events, and b. initiates further attribute modification operations as a result of these events may need to be modified to prevent recursive loops, as the attribute system -no longer stops a chain of events from propagating endlessly in the absense of the backref +no longer stops a chain of events from propagating endlessly in the absence of the backref event handlers. Additionally, code which depends upon the value of the ``initiator`` will need to be adjusted to the new API, and furthermore must be ready for the value of ``initiator`` to change from its original value within a string of @@ -1605,7 +1605,7 @@ statements without needing to explicitly specify those types within every :func:`.bindparam` expression. The potentially backwards-compatible changes involve two unlikely -scenarios. Since the the bound parameter is +scenarios. Since the bound parameter is **cloned**, users should not be relying upon making in-place changes to a :func:`.bindparam` construct once created. Additionally, code which uses :func:`.bindparam` within an :class:`.Insert` or :class:`.Update` statement diff --git a/doc/build/core/constraints.rst b/doc/build/core/constraints.rst index 1f2761125..554d003bb 100644 --- a/doc/build/core/constraints.rst +++ b/doc/build/core/constraints.rst @@ -101,7 +101,7 @@ within a "CREATE TABLE" statement when :func:`~sqlalchemy.schema.MetaData.create_all` is issued, and :class:`~sqlalchemy.schema.ForeignKeyConstraint` invokes the "CONSTRAINT" keyword inline with "CREATE TABLE". There are some cases where this is -undesireable, particularly when two tables reference each other mutually, each +undesirable, particularly when two tables reference each other mutually, each with a foreign key referencing the other. In such a situation at least one of the foreign key constraints must be generated after both tables have been built. To support such a scheme, :class:`~sqlalchemy.schema.ForeignKey` and @@ -424,7 +424,7 @@ name as follows:: .. seealso:: :paramref:`.MetaData.naming_convention` - for additional usage details - as well as a listing of all avaiable naming components. + as well as a listing of all available naming components. :ref:`alembic:tutorial_constraint_names` - in the Alembic documentation. diff --git a/doc/build/core/event.rst b/doc/build/core/event.rst index 1b873972a..e6f6c9e06 100644 --- a/doc/build/core/event.rst +++ b/doc/build/core/event.rst @@ -7,7 +7,7 @@ SQLAlchemy includes an event API which publishes a wide variety of hooks into the internals of both SQLAlchemy Core and ORM. .. versionadded:: 0.7 - The system supercedes the previous system of "extension", "proxy", + The system supersedes the previous system of "extension", "proxy", and "listener" classes. Event Registration diff --git a/doc/build/core/events.rst b/doc/build/core/events.rst index 55dbc7bc4..d19b910b1 100644 --- a/doc/build/core/events.rst +++ b/doc/build/core/events.rst @@ -12,7 +12,7 @@ ORM events are described in :ref:`orm_event_toplevel`. :members: .. versionadded:: 0.7 - The event system supercedes the previous system of "extension", "listener", + The event system supersedes the previous system of "extension", "listener", and "proxy" classes. Connection Pool Events diff --git a/doc/build/core/reflection.rst b/doc/build/core/reflection.rst index 952f48f74..57389cbec 100644 --- a/doc/build/core/reflection.rst +++ b/doc/build/core/reflection.rst @@ -149,7 +149,7 @@ includes but is not limited to: * The value of the ``.quote`` setting for :class:`.Column` or :class:`.Table` -* The assocation of a particular :class:`.Sequence` with a given :class:`.Column` +* The association of a particular :class:`.Sequence` with a given :class:`.Column` The relational database also in many cases reports on table metadata in a different format than what was specified in SQLAlchemy. The :class:`.Table` diff --git a/doc/build/core/tutorial.rst b/doc/build/core/tutorial.rst index 585d9ceb2..22b903d28 100644 --- a/doc/build/core/tutorial.rst +++ b/doc/build/core/tutorial.rst @@ -119,7 +119,7 @@ We define our tables all within a catalog called :class:`~sqlalchemy.schema.Table` construct, which resembles regular SQL CREATE TABLE statements. We'll make two tables, one of which represents "users" in an application, and another which represents zero or more "email -addreses" for each row in the "users" table: +addresses" for each row in the "users" table: .. sourcecode:: pycon+sql @@ -1510,7 +1510,7 @@ method: (4,) {stop}[(u'wendy', 2)] -A common system of dealing with duplicates in composed SELECT statments +A common system of dealing with duplicates in composed SELECT statements is the DISTINCT modifier. A simple DISTINCT clause can be added using the :meth:`.Select.distinct` method: diff --git a/doc/build/core/types.rst b/doc/build/core/types.rst index b4781ee51..14e30e46d 100644 --- a/doc/build/core/types.rst +++ b/doc/build/core/types.rst @@ -426,7 +426,7 @@ meaning, in-place changes to values will not be detected and will not be flushed. Without further steps, you instead would need to replace the existing value with a new one on each parent object to detect changes. Note that there's nothing wrong with this, as many applications may not require that the -values are ever mutated once created. For those which do have this requirment, +values are ever mutated once created. For those which do have this requirement, support for mutability is best applied using the ``sqlalchemy.ext.mutable`` extension - see the example in :ref:`mutable_toplevel`. diff --git a/doc/build/faq.rst b/doc/build/faq.rst index dd7347b0b..b92a1c744 100644 --- a/doc/build/faq.rst +++ b/doc/build/faq.rst @@ -823,7 +823,7 @@ I'm calling ``Session.delete(myobject)`` and it isn't removed from the parent co See :ref:`session_deleting_from_collections` for a description of this behavior. -why isnt my ``__init__()`` called when I load objects? +why isn't my ``__init__()`` called when I load objects? ------------------------------------------------------ See :ref:`mapping_constructors` for a description of this behavior. @@ -923,7 +923,7 @@ have meaning until the row is inserted; otherwise there is no row yet:: many-to-one relationships load as according to foreign key attributes regardless of the object being in any particular state. Both techniques are **not recommended for general use**; they were added to suit - specfic programming scenarios encountered by users which involve the repurposing + specific programming scenarios encountered by users which involve the repurposing of the ORM's usual object states. The recipe `ExpireRelationshipOnFKChange <http://www.sqlalchemy.org/trac/wiki/UsageRecipes/ExpireRelationshipOnFKChange>`_ features an example using SQLAlchemy events diff --git a/doc/build/glossary.rst b/doc/build/glossary.rst index cd6f87f29..ab9e92d26 100644 --- a/doc/build/glossary.rst +++ b/doc/build/glossary.rst @@ -387,7 +387,7 @@ Glossary A subquery comes in two general flavors, one known as a "scalar select" which specifically must return exactly one row and one column, and the other form which acts as a "derived table" and serves as a source of - rows for the FROM clause of another select. A scalar select is eligble + rows for the FROM clause of another select. A scalar select is eligible to be placed in the :term:`WHERE clause`, :term:`columns clause`, ORDER BY clause or HAVING clause of the enclosing select, whereas the derived table form is eligible to be placed in the FROM clause of the @@ -447,7 +447,7 @@ Glossary The above subquery refers to the ``user_account`` table, which is not itself in the ``FROM`` clause of this nested query. Instead, the ``user_account`` - table is recieved from the enclosing query, where each row selected from + table is received from the enclosing query, where each row selected from ``user_account`` results in a distinct execution of the subquery. A correlated subquery is in most cases present in the :term:`WHERE clause` diff --git a/doc/build/orm/events.rst b/doc/build/orm/events.rst index 2be74bf57..6f2e0cb29 100644 --- a/doc/build/orm/events.rst +++ b/doc/build/orm/events.rst @@ -6,7 +6,7 @@ ORM Events The ORM includes a wide variety of hooks available for subscription. .. versionadded:: 0.7 - The event supercedes the previous system of "extension" classes. + The event supersedes the previous system of "extension" classes. For an introduction to the event API, see :ref:`event_toplevel`. Non-ORM events such as those regarding connections and low-level statement execution are described in diff --git a/doc/build/orm/loading.rst b/doc/build/orm/loading.rst index 816052340..6c2fac004 100644 --- a/doc/build/orm/loading.rst +++ b/doc/build/orm/loading.rst @@ -168,7 +168,7 @@ the string ``'*'`` as the argument to any of these options:: session.query(MyClass).options(lazyload('*')) -Above, the ``lazyload('*')`` option will supercede the ``lazy`` setting +Above, the ``lazyload('*')`` option will supersede the ``lazy`` setting of all :func:`.relationship` constructs in use for that query, except for those which use the ``'dynamic'`` style of loading. If some relationships specify @@ -177,7 +177,7 @@ using ``lazyload('*')`` will unilaterally cause all those relationships to use ``'select'`` loading, e.g. emit a SELECT statement when each attribute is accessed. -The option does not supercede loader options stated in the +The option does not supersede loader options stated in the query, such as :func:`.eagerload`, :func:`.subqueryload`, etc. The query below will still use joined loading for the ``widget`` relationship:: diff --git a/doc/build/orm/mapper_config.rst b/doc/build/orm/mapper_config.rst index 2cf61d06c..9139b53f0 100644 --- a/doc/build/orm/mapper_config.rst +++ b/doc/build/orm/mapper_config.rst @@ -942,7 +942,7 @@ using the :func:`.synonym_for` decorator:: While the :func:`.synonym` is useful for simple mirroring, the use case of augmenting attribute behavior with descriptors is better handled in modern usage using the :ref:`hybrid attribute <mapper_hybrids>` feature, which -is more oriented towards Python descriptors. Techically, a :func:`.synonym` +is more oriented towards Python descriptors. Technically, a :func:`.synonym` can do everything that a :class:`.hybrid_property` can do, as it also supports injection of custom SQL capabilities, but the hybrid is more straightforward to use in more complex situations. @@ -1464,7 +1464,7 @@ following:: The above UPDATE statement is updating the row that not only matches ``user.id = 1``, it also is requiring that ``user.version_id = 1``, where "1" is the last version identifier we've been known to use on this object. -If a transaction elsewhere has modifed the row independently, this version id +If a transaction elsewhere has modified the row independently, this version id will no longer match, and the UPDATE statement will report that no rows matched; this is the condition that SQLAlchemy tests, that exactly one row matched our UPDATE (or DELETE) statement. If zero rows match, that indicates our version diff --git a/doc/build/orm/session.rst b/doc/build/orm/session.rst index ec96324d5..657d8e4b5 100644 --- a/doc/build/orm/session.rst +++ b/doc/build/orm/session.rst @@ -634,7 +634,7 @@ When given an instance, it follows these steps: * The new instance is returned. With :meth:`~.Session.merge`, the given "source" -instance is not modifed nor is it associated with the target :class:`.Session`, +instance is not modified nor is it associated with the target :class:`.Session`, and remains available to be merged with any number of other :class:`.Session` objects. :meth:`~.Session.merge` is useful for taking the state of any kind of object structure without regard for its @@ -686,7 +686,7 @@ Merge Tips :meth:`~.Session.merge` is an extremely useful method for many purposes. However, it deals with the intricate border between objects that are transient/detached and -those that are persistent, as well as the automated transferrence of state. +those that are persistent, as well as the automated transference of state. The wide variety of scenarios that can present themselves here often require a more careful approach to the state of objects. Common problems with merge usually involve some unexpected state regarding the object being passed to :meth:`~.Session.merge`. @@ -1523,7 +1523,7 @@ deleting the row entirely. relationship, SQLAlchemy's default behavior of setting a foreign key to ``NULL`` can be caught in one of two ways: - * The easiest and most common is just to to set the + * The easiest and most common is just to set the foreign-key-holding column to ``NOT NULL`` at the database schema level. An attempt by SQLAlchemy to set the column to NULL will fail with a simple NOT NULL constraint exception. @@ -1823,7 +1823,7 @@ is closed out after the :meth:`.Session.flush` operation completes. of usage, and can in some cases lead to concurrent connection checkouts. - In the absense of a demarcated transaction, the :class:`.Session` + In the absence of a demarcated transaction, the :class:`.Session` cannot make appropriate decisions as to when autoflush should occur nor when auto-expiration should occur, so these features should be disabled with ``autoflush=False, expire_on_commit=False``. |