summaryrefslogtreecommitdiff
path: root/doc/build/orm/examples.rst
blob: 4db7c00dc694b2c566ce75b2c7dc6f03a6359aca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
.. _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

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