Commits

Mike Bayer committed 3251e30

update docs for generic associations

Comments (0)

Files changed (2)

doc/build/orm/examples.rst

 
 .. automodule:: dynamic_dict
 
+.. _examples_generic_associations:
+
+Generic Associations
+--------------------
+
+Location: /examples/generic_associations
+
+.. automodule:: generic_associations
+
 .. _examples_sharding:
 
 Horizontal Sharding
 Polymorphic Associations
 ------------------------
 
-Location: /examples/poly_assoc/
-
-.. automodule:: poly_assoc
+See :ref:`examples_generic_associations` for a modern version of polymorphic associations.
 
 PostGIS Integration
 -------------------

examples/generic_associations/__init__.py

 
 The examples all use the declarative extension along with 
 declarative mixins.   Each one presents the identical use
-case at the end - two clases, ``Customer`` and ``Supplier``, both
+case at the end - two classes, ``Customer`` and ``Supplier``, both
 subclassing the ``HasAddresses`` mixin, which ensures that the
 parent class is provided with an ``addresses`` collection
 which contains ``Address`` objects.
 
+The configurations include:
+
+* ``table_per_related.py`` - illustrates a distinct table per related collection.
+* ``table_per_association.py`` - illustrates a shared collection table, using a
+  table per association.
+* ``discriminator_on_association.py`` - shared collection table and shared
+  association table, including a discriminator column.
+
 The ``discriminator_on_association.py`` script in particular is a modernized
 version of the "polymorphic associations" example present in older versions of
-SQLAlchemy.
-
+SQLAlchemy, originally from the blog post at http://techspot.zzzeek.org/2007/05/29/polymorphic-associations-with-sqlalchemy/.
 
 """
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.