summaryrefslogtreecommitdiff
path: root/doc/build/orm/examples.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/build/orm/examples.rst')
-rw-r--r--doc/build/orm/examples.rst144
1 files changed, 69 insertions, 75 deletions
diff --git a/doc/build/orm/examples.rst b/doc/build/orm/examples.rst
index e0c87dadf..99ca4bb8d 100644
--- a/doc/build/orm/examples.rst
+++ b/doc/build/orm/examples.rst
@@ -1,140 +1,134 @@
.. _examples_toplevel:
-Examples
-========
+============
+ORM Examples
+============
The SQLAlchemy distribution includes a variety of code examples illustrating
a select set of patterns, some typical and some not so typical. All are
runnable and can be found in the ``/examples`` directory of the
-distribution. Each example contains a README in its ``__init__.py`` file,
-each of which are listed below.
+distribution. Descriptions and source code for all can be found here.
Additional SQLAlchemy examples, some user contributed, are available on the
wiki at `<http://www.sqlalchemy.org/trac/wiki/UsageRecipes>`_.
+
+Mapping Recipes
+===============
+
.. _examples_adjacencylist:
Adjacency List
--------------
-Location: /examples/adjacency_list/
-
-.. automodule:: adjacency_list
+.. automodule:: examples.adjacency_list
.. _examples_associations:
Associations
------------
-Location: /examples/association/
+.. automodule:: examples.association
-.. automodule:: association
+Directed Graphs
+---------------
+.. automodule:: examples.graphs
-.. _examples_instrumentation:
+Dynamic Relations as Dictionaries
+------------------------------------
-Attribute Instrumentation
--------------------------
+.. automodule:: examples.dynamic_dict
-Location: /examples/custom_attributes/
+.. _examples_generic_associations:
-.. automodule:: custom_attributes
+Generic Associations
+------------------------
-.. _examples_caching:
+.. automodule:: examples.generic_associations
-Dogpile Caching
----------------
+Large Collections
+------------------------
-Location: /examples/dogpile_caching/
+.. automodule:: examples.large_collection
-.. automodule:: dogpile_caching
+Nested Sets
+------------
-Directed Graphs
----------------
+.. automodule:: examples.nested_sets
-Location: /examples/graphs/
+.. _examples_relationships:
-.. automodule:: graphs
+Relationship Join Conditions
+----------------------------
-Dynamic Relations as Dictionaries
-----------------------------------
+.. automodule:: examples.join_conditions
-Location: /examples/dynamic_dict/
+.. _examples_xmlpersistence:
-.. automodule:: dynamic_dict
+XML Persistence
+------------------------
-.. _examples_generic_associations:
+.. automodule:: examples.elementtree
-Generic Associations
---------------------
+Versioning Objects
+------------------------
-Location: /examples/generic_associations
+Versioning with a History Table
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. automodule:: generic_associations
+.. automodule:: examples.versioned_history
-.. _examples_sharding:
+Versioning using Temporal Rows
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Horizontal Sharding
--------------------
+.. automodule:: examples.versioned_rows
-Location: /examples/sharding
+Vertical Attribute Mapping
+------------------------------------
-.. automodule:: sharding
+.. automodule:: examples.vertical
-Inheritance Mappings
---------------------
-Location: /examples/inheritance/
+Inheritance Mapping Recipes
+============================
-.. automodule:: inheritance
+Basic Inheritance Mappings
+----------------------------------
-Large Collections
------------------
+.. automodule:: examples.inheritance
-Location: /examples/large_collection/
+Special APIs
+============
-.. automodule:: large_collection
+.. _examples_instrumentation:
-Nested Sets
------------
+Attribute Instrumentation
+------------------------------------
-Location: /examples/nested_sets/
+.. automodule:: examples.custom_attributes
-.. automodule:: nested_sets
+.. _examples_sharding:
-Polymorphic Associations
+Horizontal Sharding
------------------------
-See :ref:`examples_generic_associations` for a modern version of polymorphic associations.
-
-.. _examples_postgis:
-
-PostGIS Integration
--------------------
-
-Location: /examples/postgis
-
-.. automodule:: postgis
-
-Versioned Objects
------------------
-
-Location: /examples/versioning
+.. automodule:: examples.sharding
-.. automodule:: versioning
+Extending the ORM
+=================
-Vertical Attribute Mapping
---------------------------
+.. _examples_caching:
-Location: /examples/vertical
+Dogpile Caching
+------------------------
-.. automodule:: vertical
+.. automodule:: examples.dogpile_caching
-.. _examples_xmlpersistence:
+.. _examples_postgis:
-XML Persistence
----------------
+PostGIS Integration
+------------------------
-Location: /examples/elementtree/
+.. automodule:: examples.postgis
-.. automodule:: elementtree