contents.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7. Table of Contents
  8. &mdash;
  9. SQLAlchemy 1.3 Documentation
  10. </title>
  11. <!-- begin iterate through site-imported + sphinx environment css_files -->
  12. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  13. <link rel="stylesheet" href="_static/docs.css" type="text/css" />
  14. <link rel="stylesheet" href="_static/changelog.css" type="text/css" />
  15. <link rel="stylesheet" href="_static/sphinx_paramlinks.css" type="text/css" />
  16. <!-- end iterate through site-imported + sphinx environment css_files -->
  17. <!-- begin layout.mako headers -->
  18. <link rel="index" title="Index" href="genindex.html" />
  19. <link rel="search" title="Search" href="search.html" />
  20. <link rel="copyright" title="Copyright" href="copyright.html" />
  21. <link rel="top" title="SQLAlchemy 1.3 Documentation" href="index.html" />
  22. <link rel="next" title="Overview" href="intro.html" />
  23. <!-- end layout.mako headers -->
  24. </head>
  25. <body>
  26. <div id="docs-container">
  27. <div id="docs-top-navigation-container" class="body-background">
  28. <div id="docs-header">
  29. <div id="docs-version-header">
  30. Release: <span class="version-num">1.3.17</span>
  31. | Release Date: May 13, 2020
  32. </div>
  33. <h1>SQLAlchemy 1.3 Documentation</h1>
  34. </div>
  35. </div>
  36. <div id="docs-body-container">
  37. <div id="fixed-sidebar" class="withsidebar">
  38. <div id="docs-sidebar-popout">
  39. <h3><a href="index.html">SQLAlchemy 1.3 Documentation</a></h3>
  40. <p id="sidebar-topnav">
  41. <a href="#">Contents</a> |
  42. <a href="genindex.html">Index</a>
  43. </p>
  44. <div id="sidebar-search">
  45. <form class="search" action="search.html" method="get">
  46. <label>
  47. Search terms:
  48. <input type="text" placeholder="search..." name="q" size="12" />
  49. </label>
  50. <input type="hidden" name="check_keywords" value="yes" />
  51. <input type="hidden" name="area" value="default" />
  52. </form>
  53. </div>
  54. </div>
  55. <div id="docs-sidebar">
  56. <div id="sidebar-banner">
  57. </div>
  58. <div id="docs-sidebar-inner">
  59. <h3>
  60. <a href="index.html" title="SQLAlchemy 1.3 Documentation">SQLAlchemy 1.3 Documentation</a>
  61. </h3>
  62. <ul>
  63. <li><span class="link-container"><a class="reference external" href="intro.html">Overview</a></span></li>
  64. <li><span class="link-container"><a class="reference external" href="orm/index.html">SQLAlchemy ORM</a></span></li>
  65. <li><span class="link-container"><a class="reference external" href="core/index.html">SQLAlchemy Core</a></span></li>
  66. <li><span class="link-container"><a class="reference external" href="dialects/index.html">Dialects</a></span></li>
  67. <li><span class="link-container"><a class="reference external" href="faq/index.html">Frequently Asked Questions</a></span></li>
  68. <li><span class="link-container"><a class="reference external" href="errors.html">Error Messages</a></span></li>
  69. <li><span class="link-container"><a class="reference external" href="changelog/index.html">Changes and Migration</a></span></li>
  70. </ul>
  71. </div>
  72. </div>
  73. </div>
  74. <div id="docs-body" class="withsidebar" >
  75. <div class="section" id="table-of-contents">
  76. <span id="contents"></span><h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
  77. <p>Full table of contents. For a high level overview of all
  78. documentation, see <a class="reference internal" href="index.html"><span class="std std-ref">SQLAlchemy Documentation</span></a>.</p>
  79. <div class="toctree-wrapper compound">
  80. <ul>
  81. <li class="toctree-l1"><a class="reference internal" href="intro.html">Overview</a></li>
  82. <li class="toctree-l1"><a class="reference internal" href="orm/index.html">SQLAlchemy ORM</a><ul>
  83. <li class="toctree-l2"><a class="reference internal" href="orm/tutorial.html">Object Relational Tutorial</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="orm/mapper_config.html">Mapper Configuration</a><ul>
  85. <li class="toctree-l3"><a class="reference internal" href="orm/mapping_styles.html">Types of Mappings</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="orm/scalar_mapping.html">Mapping Columns and Expressions</a><ul>
  87. <li class="toctree-l4"><a class="reference internal" href="orm/mapping_columns.html">Mapping Table Columns</a></li>
  88. <li class="toctree-l4"><a class="reference internal" href="orm/mapped_sql_expr.html">SQL Expressions as Mapped Attributes</a></li>
  89. <li class="toctree-l4"><a class="reference internal" href="orm/mapped_attributes.html">Changing Attribute Behavior</a></li>
  90. <li class="toctree-l4"><a class="reference internal" href="orm/composites.html">Composite Column Types</a></li>
  91. </ul>
  92. </li>
  93. <li class="toctree-l3"><a class="reference internal" href="orm/inheritance.html">Mapping Class Inheritance Hierarchies</a></li>
  94. <li class="toctree-l3"><a class="reference internal" href="orm/nonstandard_mappings.html">Non-Traditional Mappings</a></li>
  95. <li class="toctree-l3"><a class="reference internal" href="orm/versioning.html">Configuring a Version Counter</a></li>
  96. <li class="toctree-l3"><a class="reference internal" href="orm/mapping_api.html">Class Mapping API</a></li>
  97. </ul>
  98. </li>
  99. <li class="toctree-l2"><a class="reference internal" href="orm/relationships.html">Relationship Configuration</a><ul>
  100. <li class="toctree-l3"><a class="reference internal" href="orm/basic_relationships.html">Basic Relationship Patterns</a></li>
  101. <li class="toctree-l3"><a class="reference internal" href="orm/self_referential.html">Adjacency List Relationships</a></li>
  102. <li class="toctree-l3"><a class="reference internal" href="orm/backref.html">Linking Relationships with Backref</a></li>
  103. <li class="toctree-l3"><a class="reference internal" href="orm/join_conditions.html">Configuring how Relationship Joins</a></li>
  104. <li class="toctree-l3"><a class="reference internal" href="orm/collections.html">Collection Configuration and Techniques</a></li>
  105. <li class="toctree-l3"><a class="reference internal" href="orm/relationship_persistence.html">Special Relationship Persistence Patterns</a></li>
  106. <li class="toctree-l3"><a class="reference internal" href="orm/relationship_api.html">Relationships API</a></li>
  107. </ul>
  108. </li>
  109. <li class="toctree-l2"><a class="reference internal" href="orm/loading_objects.html">Loading Objects</a><ul>
  110. <li class="toctree-l3"><a class="reference internal" href="orm/loading_columns.html">Loading Columns</a></li>
  111. <li class="toctree-l3"><a class="reference internal" href="orm/loading_relationships.html">Relationship Loading Techniques</a></li>
  112. <li class="toctree-l3"><a class="reference internal" href="orm/inheritance_loading.html">Loading Inheritance Hierarchies</a></li>
  113. <li class="toctree-l3"><a class="reference internal" href="orm/constructors.html">Constructors and Object Initialization</a></li>
  114. <li class="toctree-l3"><a class="reference internal" href="orm/query.html">Query API</a></li>
  115. </ul>
  116. </li>
  117. <li class="toctree-l2"><a class="reference internal" href="orm/session.html">Using the Session</a><ul>
  118. <li class="toctree-l3"><a class="reference internal" href="orm/session_basics.html">Session Basics</a></li>
  119. <li class="toctree-l3"><a class="reference internal" href="orm/session_state_management.html">State Management</a></li>
  120. <li class="toctree-l3"><a class="reference internal" href="orm/cascades.html">Cascades</a></li>
  121. <li class="toctree-l3"><a class="reference internal" href="orm/session_transaction.html">Transactions and Connection Management</a></li>
  122. <li class="toctree-l3"><a class="reference internal" href="orm/persistence_techniques.html">Additional Persistence Techniques</a></li>
  123. <li class="toctree-l3"><a class="reference internal" href="orm/contextual.html">Contextual/Thread-local Sessions</a></li>
  124. <li class="toctree-l3"><a class="reference internal" href="orm/session_events.html">Tracking Object and Session Changes with Events</a></li>
  125. <li class="toctree-l3"><a class="reference internal" href="orm/session_api.html">Session API</a></li>
  126. </ul>
  127. </li>
  128. <li class="toctree-l2"><a class="reference internal" href="orm/extending.html">Events and Internals</a><ul>
  129. <li class="toctree-l3"><a class="reference internal" href="orm/events.html">ORM Events</a></li>
  130. <li class="toctree-l3"><a class="reference internal" href="orm/internals.html">ORM Internals</a></li>
  131. <li class="toctree-l3"><a class="reference internal" href="orm/exceptions.html">ORM Exceptions</a></li>
  132. <li class="toctree-l3"><a class="reference internal" href="orm/deprecated.html">Deprecated ORM Event Interfaces</a></li>
  133. </ul>
  134. </li>
  135. <li class="toctree-l2"><a class="reference internal" href="orm/extensions/index.html">ORM Extensions</a><ul>
  136. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/associationproxy.html">Association Proxy</a></li>
  137. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/automap.html">Automap</a></li>
  138. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/baked.html">Baked Queries</a></li>
  139. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/declarative/index.html">Declarative</a><ul>
  140. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/basic_use.html">Basic Use</a></li>
  141. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/relationships.html">Configuring Relationships</a></li>
  142. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/table_config.html">Table Configuration</a></li>
  143. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/inheritance.html">Inheritance Configuration</a></li>
  144. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/mixins.html">Mixin and Custom Base Classes</a></li>
  145. <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/api.html">Declarative API</a></li>
  146. </ul>
  147. </li>
  148. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/mutable.html">Mutation Tracking</a></li>
  149. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/orderinglist.html">Ordering List</a></li>
  150. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/horizontal_shard.html">Horizontal Sharding</a></li>
  151. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/hybrid.html">Hybrid Attributes</a></li>
  152. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/indexable.html">Indexable</a></li>
  153. <li class="toctree-l3"><a class="reference internal" href="orm/extensions/instrumentation.html">Alternate Class Instrumentation</a></li>
  154. </ul>
  155. </li>
  156. <li class="toctree-l2"><a class="reference internal" href="orm/examples.html">ORM Examples</a></li>
  157. </ul>
  158. </li>
  159. <li class="toctree-l1"><a class="reference internal" href="core/index.html">SQLAlchemy Core</a><ul>
  160. <li class="toctree-l2"><a class="reference internal" href="core/tutorial.html">SQL Expression Language Tutorial</a></li>
  161. <li class="toctree-l2"><a class="reference internal" href="core/expression_api.html">SQL Statements and Expressions API</a><ul>
  162. <li class="toctree-l3"><a class="reference internal" href="core/sqlelement.html">Column Elements and Expressions</a></li>
  163. <li class="toctree-l3"><a class="reference internal" href="core/selectable.html">Selectables, Tables, FROM objects</a></li>
  164. <li class="toctree-l3"><a class="reference internal" href="core/dml.html">Insert, Updates, Deletes</a></li>
  165. <li class="toctree-l3"><a class="reference internal" href="core/functions.html">SQL and Generic Functions</a></li>
  166. <li class="toctree-l3"><a class="reference internal" href="core/compiler.html">Custom SQL Constructs and Compilation Extension</a></li>
  167. <li class="toctree-l3"><a class="reference internal" href="core/serializer.html">Expression Serializer Extension</a></li>
  168. <li class="toctree-l3"><a class="reference internal" href="core/visitors.html">Visitor and Traversal Utilities</a></li>
  169. </ul>
  170. </li>
  171. <li class="toctree-l2"><a class="reference internal" href="core/schema.html">Schema Definition Language</a><ul>
  172. <li class="toctree-l3"><a class="reference internal" href="core/metadata.html">Describing Databases with MetaData</a></li>
  173. <li class="toctree-l3"><a class="reference internal" href="core/reflection.html">Reflecting Database Objects</a></li>
  174. <li class="toctree-l3"><a class="reference internal" href="core/defaults.html">Column INSERT/UPDATE Defaults</a></li>
  175. <li class="toctree-l3"><a class="reference internal" href="core/constraints.html">Defining Constraints and Indexes</a></li>
  176. <li class="toctree-l3"><a class="reference internal" href="core/ddl.html">Customizing DDL</a></li>
  177. </ul>
  178. </li>
  179. <li class="toctree-l2"><a class="reference internal" href="core/types.html">Column and Data Types</a><ul>
  180. <li class="toctree-l3"><a class="reference internal" href="core/type_basics.html">Column and Data Types</a></li>
  181. <li class="toctree-l3"><a class="reference internal" href="core/custom_types.html">Custom Types</a></li>
  182. <li class="toctree-l3"><a class="reference internal" href="core/type_api.html">Base Type API</a></li>
  183. </ul>
  184. </li>
  185. <li class="toctree-l2"><a class="reference internal" href="core/engines_connections.html">Engine and Connection Use</a><ul>
  186. <li class="toctree-l3"><a class="reference internal" href="core/engines.html">Engine Configuration</a></li>
  187. <li class="toctree-l3"><a class="reference internal" href="core/connections.html">Working with Engines and Connections</a></li>
  188. <li class="toctree-l3"><a class="reference internal" href="core/pooling.html">Connection Pooling</a></li>
  189. <li class="toctree-l3"><a class="reference internal" href="core/events.html">Core Events</a></li>
  190. </ul>
  191. </li>
  192. <li class="toctree-l2"><a class="reference internal" href="core/api_basics.html">Core API Basics</a><ul>
  193. <li class="toctree-l3"><a class="reference internal" href="core/event.html">Events</a></li>
  194. <li class="toctree-l3"><a class="reference internal" href="core/inspection.html">Runtime Inspection API</a></li>
  195. <li class="toctree-l3"><a class="reference internal" href="core/interfaces.html">Deprecated Event Interfaces</a></li>
  196. <li class="toctree-l3"><a class="reference internal" href="core/exceptions.html">Core Exceptions</a></li>
  197. <li class="toctree-l3"><a class="reference internal" href="core/internals.html">Core Internals</a></li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </li>
  202. <li class="toctree-l1"><a class="reference internal" href="dialects/index.html">Dialects</a><ul>
  203. <li class="toctree-l2"><a class="reference internal" href="dialects/postgresql.html">PostgreSQL</a></li>
  204. <li class="toctree-l2"><a class="reference internal" href="dialects/mysql.html">MySQL</a></li>
  205. <li class="toctree-l2"><a class="reference internal" href="dialects/sqlite.html">SQLite</a></li>
  206. <li class="toctree-l2"><a class="reference internal" href="dialects/oracle.html">Oracle</a></li>
  207. <li class="toctree-l2"><a class="reference internal" href="dialects/mssql.html">Microsoft SQL Server</a></li>
  208. <li class="toctree-l2"><a class="reference internal" href="dialects/firebird.html">Firebird</a></li>
  209. <li class="toctree-l2"><a class="reference internal" href="dialects/sybase.html">Sybase</a></li>
  210. </ul>
  211. </li>
  212. <li class="toctree-l1"><a class="reference internal" href="faq/index.html">Frequently Asked Questions</a><ul>
  213. <li class="toctree-l2"><a class="reference internal" href="faq/connections.html">Connections / Engines</a></li>
  214. <li class="toctree-l2"><a class="reference internal" href="faq/metadata_schema.html">MetaData / Schema</a></li>
  215. <li class="toctree-l2"><a class="reference internal" href="faq/sqlexpressions.html">SQL Expressions</a></li>
  216. <li class="toctree-l2"><a class="reference internal" href="faq/ormconfiguration.html">ORM Configuration</a></li>
  217. <li class="toctree-l2"><a class="reference internal" href="faq/performance.html">Performance</a></li>
  218. <li class="toctree-l2"><a class="reference internal" href="faq/sessions.html">Sessions / Queries</a></li>
  219. </ul>
  220. </li>
  221. <li class="toctree-l1"><a class="reference internal" href="errors.html">Error Messages</a></li>
  222. <li class="toctree-l1"><a class="reference internal" href="changelog/index.html">Changes and Migration</a><ul>
  223. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_13.html">What’s New in SQLAlchemy 1.3?</a></li>
  224. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_13.html">1.3 Changelog</a></li>
  225. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_12.html">1.2 Changelog</a></li>
  226. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_11.html">1.1 Changelog</a></li>
  227. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_10.html">1.0 Changelog</a></li>
  228. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_09.html">0.9 Changelog</a></li>
  229. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_08.html">0.8 Changelog</a></li>
  230. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_07.html">0.7 Changelog</a></li>
  231. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_06.html">0.6 Changelog</a></li>
  232. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_05.html">0.5 Changelog</a></li>
  233. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_04.html">0.4 Changelog</a></li>
  234. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_03.html">0.3 Changelog</a></li>
  235. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_02.html">0.2 Changelog</a></li>
  236. <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_01.html">0.1 Changelog</a></li>
  237. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_12.html">What’s New in SQLAlchemy 1.2?</a></li>
  238. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_11.html">What’s New in SQLAlchemy 1.1?</a></li>
  239. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_10.html">What’s New in SQLAlchemy 1.0?</a></li>
  240. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_09.html">What’s New in SQLAlchemy 0.9?</a></li>
  241. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_08.html">What’s New in SQLAlchemy 0.8?</a></li>
  242. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_07.html">What’s New in SQLAlchemy 0.7?</a></li>
  243. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_06.html">What’s New in SQLAlchemy 0.6?</a></li>
  244. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_05.html">What’s new in SQLAlchemy 0.5?</a></li>
  245. <li class="toctree-l2"><a class="reference internal" href="changelog/migration_04.html">What’s new in SQLAlchemy 0.4?</a></li>
  246. </ul>
  247. </li>
  248. </ul>
  249. </div>
  250. <div class="section" id="indices-and-tables">
  251. <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
  252. <ul class="simple">
  253. <li><p><a class="reference internal" href="glossary.html#glossary"><span class="std std-ref">Glossary</span></a></p></li>
  254. <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
  255. </ul>
  256. </div>
  257. </div>
  258. </div>
  259. </div>
  260. <div id="docs-bottom-navigation" class="docs-navigation-links, withsidebar">
  261. Next:
  262. <a href="intro.html" title="next chapter">Overview</a>
  263. <div id="docs-copyright">
  264. &copy; <a href="copyright.html">Copyright</a> 2007-2020, the SQLAlchemy authors and contributors.
  265. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.0.3.
  266. </div>
  267. </div>
  268. </div>
  269. <script type="text/javascript">
  270. var DOCUMENTATION_OPTIONS = {
  271. URL_ROOT: './',
  272. VERSION: '1.3.17',
  273. COLLAPSE_MODINDEX: false,
  274. FILE_SUFFIX: '.html'
  275. };
  276. </script>
  277. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  278. <!-- begin iterate through sphinx environment script_files -->
  279. <script type="text/javascript" src="_static/jquery.js"></script>
  280. <script type="text/javascript" src="_static/underscore.js"></script>
  281. <script type="text/javascript" src="_static/doctools.js"></script>
  282. <script type="text/javascript" src="_static/language_data.js"></script>
  283. <!-- end iterate through sphinx environment script_files -->
  284. <script type="text/javascript" src="_static/detectmobile.js"></script>
  285. <script type="text/javascript" src="_static/init.js"></script>
  286. </body>
  287. </html>