| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-
- <title>
-
-
- Table of Contents
- —
- SQLAlchemy 1.3 Documentation
- </title>
-
- <!-- begin iterate through site-imported + sphinx environment css_files -->
- <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
- <link rel="stylesheet" href="_static/docs.css" type="text/css" />
- <link rel="stylesheet" href="_static/changelog.css" type="text/css" />
- <link rel="stylesheet" href="_static/sphinx_paramlinks.css" type="text/css" />
- <!-- end iterate through site-imported + sphinx environment css_files -->
-
-
-
- <!-- begin layout.mako headers -->
- <link rel="index" title="Index" href="genindex.html" />
- <link rel="search" title="Search" href="search.html" />
- <link rel="copyright" title="Copyright" href="copyright.html" />
- <link rel="top" title="SQLAlchemy 1.3 Documentation" href="index.html" />
- <link rel="next" title="Overview" href="intro.html" />
- <!-- end layout.mako headers -->
- </head>
- <body>
-
- <div id="docs-container">
- <div id="docs-top-navigation-container" class="body-background">
- <div id="docs-header">
- <div id="docs-version-header">
- Release: <span class="version-num">1.3.17</span>
- | Release Date: May 13, 2020
- </div>
- <h1>SQLAlchemy 1.3 Documentation</h1>
- </div>
- </div>
- <div id="docs-body-container">
- <div id="fixed-sidebar" class="withsidebar">
- <div id="docs-sidebar-popout">
- <h3><a href="index.html">SQLAlchemy 1.3 Documentation</a></h3>
- <p id="sidebar-topnav">
- <a href="#">Contents</a> |
- <a href="genindex.html">Index</a>
- </p>
- <div id="sidebar-search">
- <form class="search" action="search.html" method="get">
- <label>
- Search terms:
- <input type="text" placeholder="search..." name="q" size="12" />
- </label>
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- </div>
- </div>
- <div id="docs-sidebar">
- <div id="sidebar-banner">
-
- </div>
- <div id="docs-sidebar-inner">
-
- <h3>
- <a href="index.html" title="SQLAlchemy 1.3 Documentation">SQLAlchemy 1.3 Documentation</a>
- </h3>
- <ul>
- <li><span class="link-container"><a class="reference external" href="intro.html">Overview</a></span></li>
- <li><span class="link-container"><a class="reference external" href="orm/index.html">SQLAlchemy ORM</a></span></li>
- <li><span class="link-container"><a class="reference external" href="core/index.html">SQLAlchemy Core</a></span></li>
- <li><span class="link-container"><a class="reference external" href="dialects/index.html">Dialects</a></span></li>
- <li><span class="link-container"><a class="reference external" href="faq/index.html">Frequently Asked Questions</a></span></li>
- <li><span class="link-container"><a class="reference external" href="errors.html">Error Messages</a></span></li>
- <li><span class="link-container"><a class="reference external" href="changelog/index.html">Changes and Migration</a></span></li>
- </ul>
- </div>
- </div>
- </div>
-
- <div id="docs-body" class="withsidebar" >
-
- <div class="section" id="table-of-contents">
- <span id="contents"></span><h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
- <p>Full table of contents. For a high level overview of all
- documentation, see <a class="reference internal" href="index.html"><span class="std std-ref">SQLAlchemy Documentation</span></a>.</p>
- <div class="toctree-wrapper compound">
- <ul>
- <li class="toctree-l1"><a class="reference internal" href="intro.html">Overview</a></li>
- <li class="toctree-l1"><a class="reference internal" href="orm/index.html">SQLAlchemy ORM</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="orm/tutorial.html">Object Relational Tutorial</a></li>
- <li class="toctree-l2"><a class="reference internal" href="orm/mapper_config.html">Mapper Configuration</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/mapping_styles.html">Types of Mappings</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/scalar_mapping.html">Mapping Columns and Expressions</a><ul>
- <li class="toctree-l4"><a class="reference internal" href="orm/mapping_columns.html">Mapping Table Columns</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/mapped_sql_expr.html">SQL Expressions as Mapped Attributes</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/mapped_attributes.html">Changing Attribute Behavior</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/composites.html">Composite Column Types</a></li>
- </ul>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="orm/inheritance.html">Mapping Class Inheritance Hierarchies</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/nonstandard_mappings.html">Non-Traditional Mappings</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/versioning.html">Configuring a Version Counter</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/mapping_api.html">Class Mapping API</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/relationships.html">Relationship Configuration</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/basic_relationships.html">Basic Relationship Patterns</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/self_referential.html">Adjacency List Relationships</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/backref.html">Linking Relationships with Backref</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/join_conditions.html">Configuring how Relationship Joins</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/collections.html">Collection Configuration and Techniques</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/relationship_persistence.html">Special Relationship Persistence Patterns</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/relationship_api.html">Relationships API</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/loading_objects.html">Loading Objects</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/loading_columns.html">Loading Columns</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/loading_relationships.html">Relationship Loading Techniques</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/inheritance_loading.html">Loading Inheritance Hierarchies</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/constructors.html">Constructors and Object Initialization</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/query.html">Query API</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/session.html">Using the Session</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/session_basics.html">Session Basics</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/session_state_management.html">State Management</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/cascades.html">Cascades</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/session_transaction.html">Transactions and Connection Management</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/persistence_techniques.html">Additional Persistence Techniques</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/contextual.html">Contextual/Thread-local Sessions</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/session_events.html">Tracking Object and Session Changes with Events</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/session_api.html">Session API</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/extending.html">Events and Internals</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/events.html">ORM Events</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/internals.html">ORM Internals</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/exceptions.html">ORM Exceptions</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/deprecated.html">Deprecated ORM Event Interfaces</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/extensions/index.html">ORM Extensions</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/associationproxy.html">Association Proxy</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/automap.html">Automap</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/baked.html">Baked Queries</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/declarative/index.html">Declarative</a><ul>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/basic_use.html">Basic Use</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/relationships.html">Configuring Relationships</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/table_config.html">Table Configuration</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/inheritance.html">Inheritance Configuration</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/mixins.html">Mixin and Custom Base Classes</a></li>
- <li class="toctree-l4"><a class="reference internal" href="orm/extensions/declarative/api.html">Declarative API</a></li>
- </ul>
- </li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/mutable.html">Mutation Tracking</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/orderinglist.html">Ordering List</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/horizontal_shard.html">Horizontal Sharding</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/hybrid.html">Hybrid Attributes</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/indexable.html">Indexable</a></li>
- <li class="toctree-l3"><a class="reference internal" href="orm/extensions/instrumentation.html">Alternate Class Instrumentation</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="orm/examples.html">ORM Examples</a></li>
- </ul>
- </li>
- <li class="toctree-l1"><a class="reference internal" href="core/index.html">SQLAlchemy Core</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="core/tutorial.html">SQL Expression Language Tutorial</a></li>
- <li class="toctree-l2"><a class="reference internal" href="core/expression_api.html">SQL Statements and Expressions API</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="core/sqlelement.html">Column Elements and Expressions</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/selectable.html">Selectables, Tables, FROM objects</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/dml.html">Insert, Updates, Deletes</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/functions.html">SQL and Generic Functions</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/compiler.html">Custom SQL Constructs and Compilation Extension</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/serializer.html">Expression Serializer Extension</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/visitors.html">Visitor and Traversal Utilities</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="core/schema.html">Schema Definition Language</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="core/metadata.html">Describing Databases with MetaData</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/reflection.html">Reflecting Database Objects</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/defaults.html">Column INSERT/UPDATE Defaults</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/constraints.html">Defining Constraints and Indexes</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/ddl.html">Customizing DDL</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="core/types.html">Column and Data Types</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="core/type_basics.html">Column and Data Types</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/custom_types.html">Custom Types</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/type_api.html">Base Type API</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="core/engines_connections.html">Engine and Connection Use</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="core/engines.html">Engine Configuration</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/connections.html">Working with Engines and Connections</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/pooling.html">Connection Pooling</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/events.html">Core Events</a></li>
- </ul>
- </li>
- <li class="toctree-l2"><a class="reference internal" href="core/api_basics.html">Core API Basics</a><ul>
- <li class="toctree-l3"><a class="reference internal" href="core/event.html">Events</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/inspection.html">Runtime Inspection API</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/interfaces.html">Deprecated Event Interfaces</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/exceptions.html">Core Exceptions</a></li>
- <li class="toctree-l3"><a class="reference internal" href="core/internals.html">Core Internals</a></li>
- </ul>
- </li>
- </ul>
- </li>
- <li class="toctree-l1"><a class="reference internal" href="dialects/index.html">Dialects</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="dialects/postgresql.html">PostgreSQL</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/mysql.html">MySQL</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/sqlite.html">SQLite</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/oracle.html">Oracle</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/mssql.html">Microsoft SQL Server</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/firebird.html">Firebird</a></li>
- <li class="toctree-l2"><a class="reference internal" href="dialects/sybase.html">Sybase</a></li>
- </ul>
- </li>
- <li class="toctree-l1"><a class="reference internal" href="faq/index.html">Frequently Asked Questions</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="faq/connections.html">Connections / Engines</a></li>
- <li class="toctree-l2"><a class="reference internal" href="faq/metadata_schema.html">MetaData / Schema</a></li>
- <li class="toctree-l2"><a class="reference internal" href="faq/sqlexpressions.html">SQL Expressions</a></li>
- <li class="toctree-l2"><a class="reference internal" href="faq/ormconfiguration.html">ORM Configuration</a></li>
- <li class="toctree-l2"><a class="reference internal" href="faq/performance.html">Performance</a></li>
- <li class="toctree-l2"><a class="reference internal" href="faq/sessions.html">Sessions / Queries</a></li>
- </ul>
- </li>
- <li class="toctree-l1"><a class="reference internal" href="errors.html">Error Messages</a></li>
- <li class="toctree-l1"><a class="reference internal" href="changelog/index.html">Changes and Migration</a><ul>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_13.html">What’s New in SQLAlchemy 1.3?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_13.html">1.3 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_12.html">1.2 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_11.html">1.1 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_10.html">1.0 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_09.html">0.9 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_08.html">0.8 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_07.html">0.7 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_06.html">0.6 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_05.html">0.5 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_04.html">0.4 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_03.html">0.3 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_02.html">0.2 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/changelog_01.html">0.1 Changelog</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_12.html">What’s New in SQLAlchemy 1.2?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_11.html">What’s New in SQLAlchemy 1.1?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_10.html">What’s New in SQLAlchemy 1.0?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_09.html">What’s New in SQLAlchemy 0.9?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_08.html">What’s New in SQLAlchemy 0.8?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_07.html">What’s New in SQLAlchemy 0.7?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_06.html">What’s New in SQLAlchemy 0.6?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_05.html">What’s new in SQLAlchemy 0.5?</a></li>
- <li class="toctree-l2"><a class="reference internal" href="changelog/migration_04.html">What’s new in SQLAlchemy 0.4?</a></li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="section" id="indices-and-tables">
- <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
- <ul class="simple">
- <li><p><a class="reference internal" href="glossary.html#glossary"><span class="std std-ref">Glossary</span></a></p></li>
- <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
- </ul>
- </div>
- </div>
- </div>
- </div>
- <div id="docs-bottom-navigation" class="docs-navigation-links, withsidebar">
- Next:
- <a href="intro.html" title="next chapter">Overview</a>
- <div id="docs-copyright">
- © <a href="copyright.html">Copyright</a> 2007-2020, the SQLAlchemy authors and contributors.
- Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 3.0.3.
- </div>
- </div>
- </div>
-
-
- <script type="text/javascript">
- var DOCUMENTATION_OPTIONS = {
- URL_ROOT: './',
- VERSION: '1.3.17',
- COLLAPSE_MODINDEX: false,
- FILE_SUFFIX: '.html'
- };
- </script>
- <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
- <!-- begin iterate through sphinx environment script_files -->
- <script type="text/javascript" src="_static/jquery.js"></script>
- <script type="text/javascript" src="_static/underscore.js"></script>
- <script type="text/javascript" src="_static/doctools.js"></script>
- <script type="text/javascript" src="_static/language_data.js"></script>
- <!-- end iterate through sphinx environment script_files -->
- <script type="text/javascript" src="_static/detectmobile.js"></script>
- <script type="text/javascript" src="_static/init.js"></script>
- </body>
- </html>
|