Files
sqlalchemy/doc/build/orm/examples.rst
T
Mike Bayer 8be93c23ee - add new documentation that applies to all modern SQLA versions,
detailing ORM event recipes across the board.
2015-09-02 11:58:59 -04:00

151 lines
2.6 KiB
ReStructuredText

.. _examples_toplevel:
============
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. 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
--------------
.. automodule:: examples.adjacency_list
.. _examples_associations:
Associations
------------
.. automodule:: examples.association
Directed Graphs
---------------
.. automodule:: examples.graphs
Dynamic Relations as Dictionaries
------------------------------------
.. automodule:: examples.dynamic_dict
.. _examples_generic_associations:
Generic Associations
------------------------
.. automodule:: examples.generic_associations
Large Collections
------------------------
.. automodule:: examples.large_collection
Materialized Paths
------------------
.. automodule:: examples.materialized_paths
Nested Sets
------------
.. automodule:: examples.nested_sets
.. _examples_performance:
Performance
-----------
.. automodule:: examples.performance
.. _examples_relationships:
Relationship Join Conditions
----------------------------
.. automodule:: examples.join_conditions
.. _examples_xmlpersistence:
XML Persistence
------------------------
.. automodule:: examples.elementtree
Versioning Objects
------------------------
.. _examples_versioned_history:
Versioning with a History Table
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: examples.versioned_history
.. _examples_versioned_rows:
Versioning using Temporal Rows
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: examples.versioned_rows
Vertical Attribute Mapping
------------------------------------
.. automodule:: examples.vertical
Inheritance Mapping Recipes
============================
Basic Inheritance Mappings
----------------------------------
.. automodule:: examples.inheritance
Special APIs
============
.. _examples_instrumentation:
Attribute Instrumentation
------------------------------------
.. automodule:: examples.custom_attributes
.. _examples_sharding:
Horizontal Sharding
------------------------
.. automodule:: examples.sharding
Extending the ORM
=================
.. _examples_caching:
Dogpile Caching
------------------------
.. automodule:: examples.dogpile_caching
.. _examples_postgis:
PostGIS Integration
------------------------
.. automodule:: examples.postgis