<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> SQLAlchemy Documentation — SQLAlchemy 0.6.8 Documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/docs.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '#', VERSION: '0.6.8', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html' }; </script> <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/init.js"></script> <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 0.6.8 Documentation" href="#" /> </head> <body> <h1>SQLAlchemy 0.6.8 Documentation</h1> <div id="search"> Search: <form class="search" action="search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Search" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <div class="versionheader"> Version: <span class="versionnum">0.6.8</span> Last Updated: 06/05/2011 13:10:26 </div> <div class="clearboth"></div> <div id="topnav"> <div id="pagecontrol"> <ul> <li> <a href="contents.html">Table of Contents</a> | <a href="genindex.html">Index</a> | <a href="_sources/index.txt">view source </li> </ul> </div> <div id="navbanner"> <a class="totoc" href="#">SQLAlchemy 0.6.8 Documentation</a> <h2> SQLAlchemy Documentation </h2> </div> <div class="clearboth"></div> </div> <div class="document"> <div class="body"> <div class="section" id="sqlalchemy-documentation"> <span id="index-toplevel"></span><h1>SQLAlchemy Documentation<a class="headerlink" href="#sqlalchemy-documentation" title="Permalink to this headline">¶</a></h1> <div class="section" id="getting-started"> <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2> <p>A high level view and getting set up.</p> <p><a class="reference internal" href="intro.html#id1"><em>Overview</em></a> | <a class="reference internal" href="intro.html#installation"><em>Installation Guide</em></a> | <a class="reference internal" href="intro.html#migration"><em>Migration from 0.5</em></a></p> </div> <div class="section" id="sqlalchemy-orm"> <h2>SQLAlchemy ORM<a class="headerlink" href="#sqlalchemy-orm" title="Permalink to this headline">¶</a></h2> <p>Here, the Object Relational Mapper is introduced and fully described. If you want to work with higher-level SQL which is constructed automatically for you, as well as automated persistence of Python objects, proceed first to the tutorial.</p> <ul class="simple"> <li><strong>Read this first:</strong> <a class="reference internal" href="orm/tutorial.html"><em>Object Relational Tutorial</em></a></li> <li><strong>ORM Configuration:</strong> <a class="reference internal" href="orm/mapper_config.html"><em>Mapper Configuration</em></a> | <a class="reference internal" href="orm/relationships.html"><em>Relationship Configuration</em></a> | <a class="reference internal" href="orm/inheritance.html"><em>Inheritance Mapping</em></a> | <a class="reference internal" href="orm/collections.html"><em>Advanced Collection Configuration</em></a></li> <li><strong>Configuration Extensions:</strong> <a class="reference internal" href="orm/extensions/declarative.html"><em>Declarative Extension</em></a> | <a class="reference internal" href="orm/extensions/associationproxy.html"><em>Association Proxy</em></a> | <a class="reference internal" href="orm/extensions/orderinglist.html"><em>Ordered List</em></a></li> <li><strong>ORM Usage:</strong> <a class="reference internal" href="orm/session.html"><em>Session Usage and Guidelines</em></a> | <a class="reference internal" href="orm/query.html"><em>Query API reference</em></a> | <a class="reference internal" href="orm/loading.html"><em>Relationship Loading Techniques</em></a></li> <li><strong>Extending the ORM:</strong> <a class="reference internal" href="orm/interfaces.html"><em>ORM Event Interfaces</em></a></li> <li><strong>Other:</strong> <a class="reference internal" href="orm/examples.html"><em>Introduction to Examples</em></a> | <a class="reference internal" href="orm/exceptions.html"><em>ORM Exceptions</em></a> | <a class="reference internal" href="orm/extensions/horizontal_shard.html"><em>Horizontal Sharding</em></a> | <a class="reference internal" href="orm/extensions/sqlsoup.html"><em>SQLSoup</em></a></li> </ul> </div> <div class="section" id="sqlalchemy-core"> <h2>SQLAlchemy Core<a class="headerlink" href="#sqlalchemy-core" title="Permalink to this headline">¶</a></h2> <p>The breadth of SQLAlchemy’s SQL rendering engine, DBAPI integration, transaction integration, and schema description services 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> <ul class="simple"> <li><strong>Read this first:</strong> <a class="reference internal" href="core/tutorial.html"><em>SQL Expression Language Tutorial</em></a></li> <li><strong>All the Built In SQL:</strong> <a class="reference internal" href="core/expression_api.html"><em>SQL Expression API</em></a></li> <li><strong>Engines, Connections, Pools:</strong> <a class="reference internal" href="core/engines.html"><em>Engine Configuration</em></a> | <a class="reference internal" href="core/connections.html"><em>Connections, Transactions</em></a> | <a class="reference internal" href="core/pooling.html"><em>Connection Pooling</em></a></li> <li><strong>Schema Definition:</strong> <a class="reference internal" href="core/schema.html#metadata-describing"><em>Tables and Columns</em></a> | <a class="reference internal" href="core/schema.html#metadata-reflection"><em>Database Introspection (Reflection)</em></a> | <a class="reference internal" href="core/schema.html#metadata-defaults"><em>Insert/Update Defaults</em></a> | <a class="reference internal" href="core/schema.html#metadata-constraints"><em>Constraints and Indexes</em></a> | <a class="reference internal" href="core/schema.html#metadata-ddl"><em>Using Data Definition Language (DDL)</em></a></li> <li><strong>Datatypes:</strong> <a class="reference internal" href="core/types.html"><em>Overview</em></a> | <a class="reference internal" href="core/types.html#types-generic"><em>Generic Types</em></a> | <a class="reference internal" href="core/types.html#types-sqlstandard"><em>SQL Standard Types</em></a> | <a class="reference internal" href="core/types.html#types-vendor"><em>Vendor Specific Types</em></a> | <a class="reference internal" href="core/types.html#types-custom"><em>Building Custom Types</em></a> | <a class="reference internal" href="core/types.html#types-api"><em>API</em></a></li> <li><strong>Extending the Core:</strong> <a class="reference internal" href="core/interfaces.html"><em>Core Event Interfaces</em></a> | <a class="reference internal" href="core/compiler.html"><em>Creating Custom SQL Constructs</em></a></li> <li><strong>Other:</strong> <a class="reference internal" href="core/serializer.html"><em>Serializing Expressions</em></a> | <a class="reference internal" href="core/exceptions.html"><em>Core Exceptions</em></a></li> </ul> </div> <div class="section" id="dialect-documentation"> <h2>Dialect Documentation<a class="headerlink" href="#dialect-documentation" title="Permalink to this headline">¶</a></h2> <p>The <strong>dialect</strong> is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases. This section describes notes, options, and usage patterns regarding individual dialects.</p> <p><a class="reference internal" href="dialects/firebird.html"><em>Firebird</em></a> | <a class="reference internal" href="dialects/informix.html"><em>Informix</em></a> | <a class="reference internal" href="dialects/maxdb.html"><em>MaxDB</em></a> | <a class="reference internal" href="dialects/access.html"><em>Microsoft Access</em></a> | <a class="reference internal" href="dialects/mssql.html"><em>Microsoft SQL Server</em></a> | <a class="reference internal" href="dialects/mysql.html"><em>MySQL</em></a> | <a class="reference internal" href="dialects/oracle.html"><em>Oracle</em></a> | <a class="reference internal" href="dialects/postgresql.html"><em>PostgreSQL</em></a> | <a class="reference internal" href="dialects/sqlite.html"><em>SQLite</em></a> | <a class="reference internal" href="dialects/sybase.html"><em>Sybase</em></a></p> </div> </div> </div> </div> <div class="bottomnav"> <div class="doc_copyright"> © <a href="copyright.html">Copyright</a> 2007-2011, the SQLAlchemy authors and contributors. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. </div> </div> </body> </html>