File: index.html

package info (click to toggle)
sqlalchemy 0.9.8%2Bdfsg-0.1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 23,952 kB
  • ctags: 24,534
  • sloc: python: 152,282; ansic: 1,346; makefile: 257; xml: 17
file content (226 lines) | stat: -rw-r--r-- 10,555 bytes parent folder | download
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<!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>
            
    SQLAlchemy 0.9 Documentation

        </title>

        
            <!-- begin iterate through SQLA + 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/sphinx_paramlinks.css" type="text/css" />
                <link rel="stylesheet" href="_static/changelog.css" type="text/css" />
            <!-- end iterate through SQLA + sphinx environment css_files -->
        

        

    

    <!-- begin layout.mako headers -->

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    './',
          VERSION:     '0.9.8',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: '.html'
      };
    </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>
    <!-- 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>
    <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.9 Documentation" href="#" />
    <!-- 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">0.9.8</span> | Release Date: October 13, 2014
    </div>

    <h1>SQLAlchemy 0.9 Documentation</h1>

</div>
</div>

<div id="docs-body-container">

    <div id="fixed-sidebar" class="">

        <div id="index-nav">
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="12" /> <input type="submit" value="Search" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>

            <p>
            <a href="#">Contents</a> |
            <a href="genindex.html">Index</a>
            </p>

        </div>


    </div>

    

    <div id="docs-body" class="" >
        
<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"><em>Overview</em></a> |
<a class="reference internal" href="intro.html#installation"><em>Installation Guide</em></a> |
<a class="reference internal" href="faq.html"><em>Frequently Asked Questions</em></a> |
<a class="reference internal" href="changelog/migration_09.html"><em>Migration from 0.8</em></a> |
<a class="reference internal" href="glossary.html"><em>Glossary</em></a> |
<a class="reference internal" href="changelog/index.html"><em>Changelog catalog</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/hybrid.html"><em>Hybrid Attributes</em></a> |
<a class="reference internal" href="orm/extensions/automap.html"><em>Automap</em></a> (<strong>new</strong>) |
<a class="reference internal" href="orm/extensions/mutable.html"><em>Mutable Scalars</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/events.html"><em>ORM Event Interfaces</em></a> |
<a class="reference internal" href="orm/internals.html"><em>Internals API</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/deprecated.html"><em>Deprecated Event Interfaces</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/instrumentation.html"><em>Alternate Instrumentation</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&#8217;s SQL rendering engine, DBAPI
integration, transaction integration, and schema description services
are documented here.  In contrast to the ORM&#8217;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/metadata.html"><em>Tables and Columns</em></a> |
<a class="reference internal" href="core/reflection.html"><em>Database Introspection (Reflection)</em></a> |
<a class="reference internal" href="core/defaults.html"><em>Insert/Update Defaults</em></a> |
<a class="reference internal" href="core/constraints.html"><em>Constraints and Indexes</em></a> |
<a class="reference internal" href="core/ddl.html"><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-operators"><em>Defining New Operators</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/event.html"><em>SQLAlchemy Events</em></a> |
<a class="reference internal" href="core/events.html"><em>Core Event Interfaces</em></a> |
<a class="reference internal" href="core/compiler.html"><em>Creating Custom SQL Constructs</em></a> |
<a class="reference internal" href="core/internals.html"><em>Internals API</em></a></li>
<li><strong>Other:</strong>
<a class="reference internal" href="core/inspection.html"><em>Runtime Inspection API</em></a> |
<a class="reference internal" href="core/interfaces.html"><em>Deprecated Event Interfaces</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/index.html"><em>Index of all Dialects</em></a></p>
</div>
</div>

    </div>

</div>

<div id="docs-bottom-navigation" class="docs-navigation-links">

    <div id="docs-copyright">
        &copy; <a href="copyright.html">Copyright</a> 2007-2014, the SQLAlchemy authors and contributors.
        Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.2b1.
    </div>
</div>

</div>

        
    </body>
</html>