index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  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. SQLAlchemy Documentation
  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="#" />
  22. <!-- end layout.mako headers -->
  23. </head>
  24. <body>
  25. <div id="docs-container">
  26. <div id="docs-top-navigation-container" class="body-background">
  27. <div id="docs-header">
  28. <div id="docs-version-header">
  29. Release: <span class="version-num">1.3.17</span>
  30. | Release Date: May 13, 2020
  31. </div>
  32. <h1>SQLAlchemy 1.3 Documentation</h1>
  33. </div>
  34. </div>
  35. <div id="docs-body-container">
  36. <div id="fixed-sidebar" class="">
  37. <div id="index-nav">
  38. <form class="search" action="search.html" method="get">
  39. <label>
  40. Search terms:
  41. <input type="text" placeholder="search..." name="q" size="12" />
  42. </label>
  43. <input type="submit" value="Search" />
  44. <input type="hidden" name="check_keywords" value="yes" />
  45. <input type="hidden" name="area" value="default" />
  46. </form>
  47. <p>
  48. <a href="contents.html">Contents</a> |
  49. <a href="genindex.html">Index</a>
  50. </p>
  51. </div>
  52. </div>
  53. <div id="docs-body" class="" >
  54. <div class="section" id="sqlalchemy-documentation">
  55. <span id="index-toplevel"></span><h1>SQLAlchemy Documentation<a class="headerlink" href="#sqlalchemy-documentation" title="Permalink to this headline">¶</a></h1>
  56. <div class="section" id="getting-started">
  57. <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
  58. <p>A high level view and getting set up.</p>
  59. <p><a class="reference internal" href="intro.html"><span class="doc">Overview</span></a> |
  60. <a class="reference internal" href="intro.html#installation"><span class="std std-ref">Installation Guide</span></a> |
  61. <a class="reference internal" href="faq/index.html"><span class="doc">Frequently Asked Questions</span></a> |
  62. <a class="reference internal" href="changelog/migration_13.html"><span class="doc">Migration from 1.2</span></a> |
  63. <a class="reference internal" href="glossary.html"><span class="doc">Glossary</span></a> |
  64. <a class="reference internal" href="errors.html"><span class="doc">Error Messages</span></a> |
  65. <a class="reference internal" href="changelog/index.html"><span class="doc">Changelog catalog</span></a></p>
  66. </div>
  67. <div class="section" id="sqlalchemy-orm">
  68. <h2>SQLAlchemy ORM<a class="headerlink" href="#sqlalchemy-orm" title="Permalink to this headline">¶</a></h2>
  69. <p>Here, the Object Relational Mapper is introduced and
  70. fully described. If you want to work with higher-level SQL which is
  71. constructed automatically for you, as well as automated persistence
  72. of Python objects, proceed first to the tutorial.</p>
  73. <ul class="simple">
  74. <li><p><strong>Read this first:</strong>
  75. <a class="reference internal" href="orm/tutorial.html"><span class="doc">Object Relational Tutorial</span></a></p></li>
  76. <li><p><strong>ORM Configuration:</strong>
  77. <a class="reference internal" href="orm/mapper_config.html"><span class="doc">Mapper Configuration</span></a> |
  78. <a class="reference internal" href="orm/relationships.html"><span class="doc">Relationship Configuration</span></a></p></li>
  79. <li><p><strong>Configuration Extensions:</strong>
  80. <a class="reference internal" href="orm/extensions/declarative/index.html"><span class="doc">Declarative Extension</span></a> |
  81. <a class="reference internal" href="orm/extensions/associationproxy.html"><span class="doc">Association Proxy</span></a> |
  82. <a class="reference internal" href="orm/extensions/hybrid.html"><span class="doc">Hybrid Attributes</span></a> |
  83. <a class="reference internal" href="orm/extensions/automap.html"><span class="doc">Automap</span></a> |
  84. <a class="reference internal" href="orm/extensions/mutable.html"><span class="doc">Mutable Scalars</span></a> |
  85. <a class="reference internal" href="orm/extensions/indexable.html"><span class="doc">Indexable</span></a></p></li>
  86. <li><p><strong>ORM Usage:</strong>
  87. <a class="reference internal" href="orm/session.html"><span class="doc">Session Usage and Guidelines</span></a> |
  88. <a class="reference internal" href="orm/loading_objects.html"><span class="doc">Loading Objects</span></a> |
  89. <a class="reference internal" href="orm/extensions/baked.html"><span class="doc">Cached Query Extension</span></a></p></li>
  90. <li><p><strong>Extending the ORM:</strong>
  91. <a class="reference internal" href="orm/extending.html"><span class="doc">ORM Events and Internals</span></a></p></li>
  92. <li><p><strong>Other:</strong>
  93. <a class="reference internal" href="orm/examples.html"><span class="doc">Introduction to Examples</span></a></p></li>
  94. </ul>
  95. </div>
  96. <div class="section" id="sqlalchemy-core">
  97. <h2>SQLAlchemy Core<a class="headerlink" href="#sqlalchemy-core" title="Permalink to this headline">¶</a></h2>
  98. <p>The breadth of SQLAlchemy’s SQL rendering engine, DBAPI
  99. integration, transaction integration, and schema description services
  100. are documented here. In contrast to the ORM’s domain-centric mode of usage, the SQL Expression Language provides a schema-centric usage paradigm.</p>
  101. <ul class="simple">
  102. <li><p><strong>Read this first:</strong>
  103. <a class="reference internal" href="core/tutorial.html"><span class="doc">SQL Expression Language Tutorial</span></a></p></li>
  104. <li><p><strong>All the Built In SQL:</strong>
  105. <a class="reference internal" href="core/expression_api.html"><span class="doc">SQL Expression API</span></a></p></li>
  106. <li><p><strong>Engines, Connections, Pools:</strong>
  107. <a class="reference internal" href="core/engines.html"><span class="doc">Engine Configuration</span></a> |
  108. <a class="reference internal" href="core/connections.html"><span class="doc">Connections, Transactions</span></a> |
  109. <a class="reference internal" href="core/pooling.html"><span class="doc">Connection Pooling</span></a></p></li>
  110. <li><p><strong>Schema Definition:</strong>
  111. <a class="reference internal" href="core/schema.html"><span class="doc">Overview</span></a> |
  112. <a class="reference internal" href="core/metadata.html"><span class="std std-ref">Tables and Columns</span></a> |
  113. <a class="reference internal" href="core/reflection.html"><span class="std std-ref">Database Introspection (Reflection)</span></a> |
  114. <a class="reference internal" href="core/defaults.html"><span class="std std-ref">Insert/Update Defaults</span></a> |
  115. <a class="reference internal" href="core/constraints.html"><span class="std std-ref">Constraints and Indexes</span></a> |
  116. <a class="reference internal" href="core/ddl.html"><span class="std std-ref">Using Data Definition Language (DDL)</span></a></p></li>
  117. <li><p><strong>Datatypes:</strong>
  118. <a class="reference internal" href="core/types.html"><span class="std std-ref">Overview</span></a> |
  119. <a class="reference internal" href="core/custom_types.html#types-custom"><span class="std std-ref">Building Custom Types</span></a> |
  120. <a class="reference internal" href="core/type_api.html#types-api"><span class="std std-ref">API</span></a></p></li>
  121. <li><p><strong>Core Basics:</strong>
  122. <a class="reference internal" href="core/api_basics.html"><span class="doc">Overview</span></a> |
  123. <a class="reference internal" href="core/inspection.html"><span class="doc">Runtime Inspection API</span></a> |
  124. <a class="reference internal" href="core/event.html"><span class="doc">Event System</span></a> |
  125. <a class="reference internal" href="core/events.html"><span class="doc">Core Event Interfaces</span></a> |
  126. <a class="reference internal" href="core/compiler.html"><span class="doc">Creating Custom SQL Constructs</span></a> |</p></li>
  127. </ul>
  128. </div>
  129. <div class="section" id="dialect-documentation">
  130. <h2>Dialect Documentation<a class="headerlink" href="#dialect-documentation" title="Permalink to this headline">¶</a></h2>
  131. <p>The <strong>dialect</strong> is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
  132. This section describes notes, options, and usage patterns regarding individual dialects.</p>
  133. <p><a class="reference internal" href="dialects/postgresql.html"><span class="doc">PostgreSQL</span></a> |
  134. <a class="reference internal" href="dialects/mysql.html"><span class="doc">MySQL</span></a> |
  135. <a class="reference internal" href="dialects/sqlite.html"><span class="doc">SQLite</span></a> |
  136. <a class="reference internal" href="dialects/oracle.html"><span class="doc">Oracle</span></a> |
  137. <a class="reference internal" href="dialects/mssql.html"><span class="doc">Microsoft SQL Server</span></a></p>
  138. <p><a class="reference internal" href="dialects/index.html"><span class="doc">More Dialects …</span></a></p>
  139. </div>
  140. </div>
  141. </div>
  142. </div>
  143. <div id="docs-bottom-navigation" class="docs-navigation-links">
  144. <div id="docs-copyright">
  145. &copy; <a href="copyright.html">Copyright</a> 2007-2020, the SQLAlchemy authors and contributors.
  146. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.0.3.
  147. </div>
  148. </div>
  149. </div>
  150. <script type="text/javascript">
  151. var DOCUMENTATION_OPTIONS = {
  152. URL_ROOT: './',
  153. VERSION: '1.3.17',
  154. COLLAPSE_MODINDEX: false,
  155. FILE_SUFFIX: '.html'
  156. };
  157. </script>
  158. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  159. <!-- begin iterate through sphinx environment script_files -->
  160. <script type="text/javascript" src="_static/jquery.js"></script>
  161. <script type="text/javascript" src="_static/underscore.js"></script>
  162. <script type="text/javascript" src="_static/doctools.js"></script>
  163. <script type="text/javascript" src="_static/language_data.js"></script>
  164. <!-- end iterate through sphinx environment script_files -->
  165. <script type="text/javascript" src="_static/detectmobile.js"></script>
  166. <script type="text/javascript" src="_static/init.js"></script>
  167. </body>
  168. </html>