/SQLAlchemy-0.7.8/doc/core/index.html
HTML | 365 lines | 312 code | 53 blank | 0 comment | 0 complexity | e67b1507311504316ad44205153acbd8 MD5 | raw file
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<html>
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
8 <title>
9
10
11 SQLAlchemy Core
12 —
13 SQLAlchemy 0.7 Documentation
14
15 </title>
16
17 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
18 <link rel="stylesheet" href="../_static/docs.css" type="text/css" />
19
20 <script type="text/javascript">
21 var DOCUMENTATION_OPTIONS = {
22 URL_ROOT: '../',
23 VERSION: '0.7.8',
24 COLLAPSE_MODINDEX: false,
25 FILE_SUFFIX: '.html'
26 };
27 </script>
28 <script type="text/javascript" src="../_static/jquery.js"></script>
29 <script type="text/javascript" src="../_static/underscore.js"></script>
30 <script type="text/javascript" src="../_static/doctools.js"></script>
31 <script type="text/javascript" src="../_static/init.js"></script>
32 <link rel="index" title="Index" href="../genindex.html" />
33 <link rel="search" title="Search" href="../search.html" />
34 <link rel="copyright" title="Copyright" href="../copyright.html" />
35 <link rel="top" title="SQLAlchemy 0.7 Documentation" href="../index.html" />
36 <link rel="next" title="SQL Expression Language Tutorial" href="tutorial.html" />
37 <link rel="prev" title="ORM Internals" href="../orm/internals.html" />
38
39 </head>
40 <body>
41
42
43
44
45
46
47
48
49
50
51
52<div id="docs-container">
53
54
55
56<div id="docs-header">
57 <h1>SQLAlchemy 0.7 Documentation</h1>
58
59 <div id="docs-search">
60 Search:
61 <form class="search" action="../search.html" method="get">
62 <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
63 <input type="hidden" name="check_keywords" value="yes" />
64 <input type="hidden" name="area" value="default" />
65 </form>
66 </div>
67
68 <div id="docs-version-header">
69 Release: <span class="version-num">0.7.8</span> | Release Date: June 16, 2012
70
71
72 </div>
73
74</div>
75
76<div id="docs-top-navigation">
77 <div id="docs-top-page-control" class="docs-navigation-links">
78 <ul>
79 <li>Prev:
80 <a href="../orm/internals.html" title="previous chapter">ORM Internals</a>
81 </li>
82 <li>Next:
83 <a href="tutorial.html" title="next chapter">SQL Expression Language Tutorial</a>
84 </li>
85
86 <li>
87 <a href="../contents.html">Table of Contents</a> |
88 <a href="../genindex.html">Index</a>
89 | <a href="../_sources/core/index.txt">view source
90 </li>
91 </ul>
92 </div>
93
94 <div id="docs-navigation-banner">
95 <a href="../index.html">SQLAlchemy 0.7 Documentation</a>
96 ť
97 SQLAlchemy Core
98
99
100 <h2>
101
102 SQLAlchemy Core
103
104 </h2>
105 </div>
106
107</div>
108
109<div id="docs-body-container">
110
111 <div id="docs-sidebar">
112 <h3><a href="../index.html">Table of Contents</a></h3>
113 <ul>
114<li><a class="reference internal" href="#">SQLAlchemy Core</a><ul>
115</ul>
116</li>
117</ul>
118
119
120 <h4>Previous Topic</h4>
121 <p>
122 <a href="../orm/internals.html" title="previous chapter">ORM Internals</a>
123 </p>
124 <h4>Next Topic</h4>
125 <p>
126 <a href="tutorial.html" title="next chapter">SQL Expression Language Tutorial</a>
127 </p>
128
129
130 <h4>Quick Search</h4>
131 <p>
132 <form class="search" action="../search.html" method="get">
133 <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
134 <input type="hidden" name="check_keywords" value="yes" />
135 <input type="hidden" name="area" value="default" />
136 </form>
137 </p>
138
139 </div>
140
141 <div id="docs-body" class="withsidebar" >
142
143<div class="section" id="sqlalchemy-core">
144<span id="core-toplevel"></span><h1>SQLAlchemy Core<a class="headerlink" href="#sqlalchemy-core" title="Permalink to this headline">ś</a></h1>
145<p>The breadth of SQLAlchemys SQL rendering engine, DBAPI integration,
146transaction integration, and schema description services are documented here.
147In contrast to the ORMs domain-centric mode of usage, the SQL Expression
148Language provides a schema-centric usage paradigm.</p>
149<div class="toctree-wrapper compound">
150<ul>
151<li class="toctree-l1"><a class="reference internal" href="tutorial.html">SQL Expression Language Tutorial</a><ul>
152<li class="toctree-l2"><a class="reference internal" href="tutorial.html#version-check">Version Check</a></li>
153<li class="toctree-l2"><a class="reference internal" href="tutorial.html#connecting">Connecting</a></li>
154<li class="toctree-l2"><a class="reference internal" href="tutorial.html#define-and-create-tables">Define and Create Tables</a></li>
155<li class="toctree-l2"><a class="reference internal" href="tutorial.html#insert-expressions">Insert Expressions</a></li>
156<li class="toctree-l2"><a class="reference internal" href="tutorial.html#executing">Executing</a></li>
157<li class="toctree-l2"><a class="reference internal" href="tutorial.html#executing-multiple-statements">Executing Multiple Statements</a></li>
158<li class="toctree-l2"><a class="reference internal" href="tutorial.html#connectionless-implicit-execution">Connectionless / Implicit Execution</a></li>
159<li class="toctree-l2"><a class="reference internal" href="tutorial.html#selecting">Selecting</a></li>
160<li class="toctree-l2"><a class="reference internal" href="tutorial.html#operators">Operators</a></li>
161<li class="toctree-l2"><a class="reference internal" href="tutorial.html#conjunctions">Conjunctions</a></li>
162<li class="toctree-l2"><a class="reference internal" href="tutorial.html#using-text">Using Text</a></li>
163<li class="toctree-l2"><a class="reference internal" href="tutorial.html#using-aliases">Using Aliases</a></li>
164<li class="toctree-l2"><a class="reference internal" href="tutorial.html#using-joins">Using Joins</a></li>
165<li class="toctree-l2"><a class="reference internal" href="tutorial.html#intro-to-generative-selects">Intro to Generative Selects</a><ul>
166<li class="toctree-l3"><a class="reference internal" href="tutorial.html#transforming-a-statement">Transforming a Statement</a></li>
167</ul>
168</li>
169<li class="toctree-l2"><a class="reference internal" href="tutorial.html#everything-else">Everything Else</a><ul>
170<li class="toctree-l3"><a class="reference internal" href="tutorial.html#bind-parameter-objects">Bind Parameter Objects</a></li>
171<li class="toctree-l3"><a class="reference internal" href="tutorial.html#functions">Functions</a></li>
172<li class="toctree-l3"><a class="reference internal" href="tutorial.html#window-functions">Window Functions</a></li>
173<li class="toctree-l3"><a class="reference internal" href="tutorial.html#unions-and-other-set-operations">Unions and Other Set Operations</a></li>
174<li class="toctree-l3"><a class="reference internal" href="tutorial.html#scalar-selects">Scalar Selects</a></li>
175<li class="toctree-l3"><a class="reference internal" href="tutorial.html#correlated-subqueries">Correlated Subqueries</a></li>
176<li class="toctree-l3"><a class="reference internal" href="tutorial.html#ordering-grouping-limiting-offset-ing">Ordering, Grouping, Limiting, Offset...ing...</a></li>
177</ul>
178</li>
179<li class="toctree-l2"><a class="reference internal" href="tutorial.html#inserts-and-updates">Inserts and Updates</a><ul>
180<li class="toctree-l3"><a class="reference internal" href="tutorial.html#correlated-updates">Correlated Updates</a></li>
181<li class="toctree-l3"><a class="reference internal" href="tutorial.html#multiple-table-updates">Multiple Table Updates</a></li>
182</ul>
183</li>
184<li class="toctree-l2"><a class="reference internal" href="tutorial.html#deletes">Deletes</a></li>
185<li class="toctree-l2"><a class="reference internal" href="tutorial.html#further-reference">Further Reference</a></li>
186</ul>
187</li>
188<li class="toctree-l1"><a class="reference internal" href="expression_api.html">SQL Statements and Expressions API</a><ul>
189<li class="toctree-l2"><a class="reference internal" href="expression_api.html#functions">Functions</a></li>
190<li class="toctree-l2"><a class="reference internal" href="expression_api.html#classes">Classes</a></li>
191<li class="toctree-l2"><a class="reference internal" href="expression_api.html#generic-functions">Generic Functions</a></li>
192</ul>
193</li>
194<li class="toctree-l1"><a class="reference internal" href="engines.html">Engine Configuration</a><ul>
195<li class="toctree-l2"><a class="reference internal" href="engines.html#supported-databases">Supported Databases</a></li>
196<li class="toctree-l2"><a class="reference internal" href="engines.html#engine-creation-api">Engine Creation API</a></li>
197<li class="toctree-l2"><a class="reference internal" href="engines.html#database-urls">Database Urls</a><ul>
198<li class="toctree-l3"><a class="reference internal" href="engines.html#postgresql">Postgresql</a></li>
199<li class="toctree-l3"><a class="reference internal" href="engines.html#mysql">MySQL</a></li>
200<li class="toctree-l3"><a class="reference internal" href="engines.html#oracle">Oracle</a></li>
201<li class="toctree-l3"><a class="reference internal" href="engines.html#microsoft-sql-server">Microsoft SQL Server</a></li>
202<li class="toctree-l3"><a class="reference internal" href="engines.html#sqlite">SQLite</a></li>
203<li class="toctree-l3"><a class="reference internal" href="engines.html#others">Others</a></li>
204<li class="toctree-l3"><a class="reference internal" href="engines.html#url-api">URL API</a></li>
205</ul>
206</li>
207<li class="toctree-l2"><a class="reference internal" href="engines.html#pooling">Pooling</a></li>
208<li class="toctree-l2"><a class="reference internal" href="engines.html#custom-dbapi-connect-arguments">Custom DBAPI connect() arguments</a></li>
209<li class="toctree-l2"><a class="reference internal" href="engines.html#configuring-logging">Configuring Logging</a></li>
210</ul>
211</li>
212<li class="toctree-l1"><a class="reference internal" href="connections.html">Working with Engines and Connections</a><ul>
213<li class="toctree-l2"><a class="reference internal" href="connections.html#basic-usage">Basic Usage</a></li>
214<li class="toctree-l2"><a class="reference internal" href="connections.html#using-transactions">Using Transactions</a><ul>
215<li class="toctree-l3"><a class="reference internal" href="connections.html#nesting-of-transaction-blocks">Nesting of Transaction Blocks</a></li>
216</ul>
217</li>
218<li class="toctree-l2"><a class="reference internal" href="connections.html#understanding-autocommit">Understanding Autocommit</a></li>
219<li class="toctree-l2"><a class="reference internal" href="connections.html#connectionless-execution-implicit-execution">Connectionless Execution, Implicit Execution</a></li>
220<li class="toctree-l2"><a class="reference internal" href="connections.html#using-the-threadlocal-execution-strategy">Using the Threadlocal Execution Strategy</a></li>
221<li class="toctree-l2"><a class="reference internal" href="connections.html#connection-engine-api">Connection / Engine API</a></li>
222</ul>
223</li>
224<li class="toctree-l1"><a class="reference internal" href="pooling.html">Connection Pooling</a><ul>
225<li class="toctree-l2"><a class="reference internal" href="pooling.html#connection-pool-configuration">Connection Pool Configuration</a></li>
226<li class="toctree-l2"><a class="reference internal" href="pooling.html#switching-pool-implementations">Switching Pool Implementations</a></li>
227<li class="toctree-l2"><a class="reference internal" href="pooling.html#using-a-custom-connection-function">Using a Custom Connection Function</a></li>
228<li class="toctree-l2"><a class="reference internal" href="pooling.html#constructing-a-pool">Constructing a Pool</a></li>
229<li class="toctree-l2"><a class="reference internal" href="pooling.html#pool-events">Pool Events</a></li>
230<li class="toctree-l2"><a class="reference internal" href="pooling.html#dealing-with-disconnects">Dealing with Disconnects</a><ul>
231<li class="toctree-l3"><a class="reference internal" href="pooling.html#disconnect-handling-optimistic">Disconnect Handling - Optimistic</a></li>
232<li class="toctree-l3"><a class="reference internal" href="pooling.html#disconnect-handling-pessimistic">Disconnect Handling - Pessimistic</a></li>
233</ul>
234</li>
235<li class="toctree-l2"><a class="reference internal" href="pooling.html#api-documentation-available-pool-implementations">API Documentation - Available Pool Implementations</a></li>
236<li class="toctree-l2"><a class="reference internal" href="pooling.html#pooling-plain-db-api-connections">Pooling Plain DB-API Connections</a></li>
237</ul>
238</li>
239<li class="toctree-l1"><a class="reference internal" href="schema.html">Schema Definition Language</a><ul>
240<li class="toctree-l2"><a class="reference internal" href="schema.html#describing-databases-with-metadata">Describing Databases with MetaData</a><ul>
241<li class="toctree-l3"><a class="reference internal" href="schema.html#accessing-tables-and-columns">Accessing Tables and Columns</a></li>
242<li class="toctree-l3"><a class="reference internal" href="schema.html#creating-and-dropping-database-tables">Creating and Dropping Database Tables</a></li>
243<li class="toctree-l3"><a class="reference internal" href="schema.html#altering-schemas-through-migrations">Altering Schemas through Migrations</a></li>
244<li class="toctree-l3"><a class="reference internal" href="schema.html#binding-metadata-to-an-engine-or-connection">Binding MetaData to an Engine or Connection</a></li>
245<li class="toctree-l3"><a class="reference internal" href="schema.html#specifying-the-schema-name">Specifying the Schema Name</a></li>
246<li class="toctree-l3"><a class="reference internal" href="schema.html#backend-specific-options">Backend-Specific Options</a></li>
247<li class="toctree-l3"><a class="reference internal" href="schema.html#column-table-metadata-api">Column, Table, MetaData API</a></li>
248</ul>
249</li>
250<li class="toctree-l2"><a class="reference internal" href="schema.html#reflecting-database-objects">Reflecting Database Objects</a><ul>
251<li class="toctree-l3"><a class="reference internal" href="schema.html#overriding-reflected-columns">Overriding Reflected Columns</a></li>
252<li class="toctree-l3"><a class="reference internal" href="schema.html#reflecting-views">Reflecting Views</a></li>
253<li class="toctree-l3"><a class="reference internal" href="schema.html#reflecting-all-tables-at-once">Reflecting All Tables at Once</a></li>
254<li class="toctree-l3"><a class="reference internal" href="schema.html#fine-grained-reflection-with-inspector">Fine Grained Reflection with Inspector</a></li>
255</ul>
256</li>
257<li class="toctree-l2"><a class="reference internal" href="schema.html#column-insert-update-defaults">Column Insert/Update Defaults</a><ul>
258<li class="toctree-l3"><a class="reference internal" href="schema.html#scalar-defaults">Scalar Defaults</a></li>
259<li class="toctree-l3"><a class="reference internal" href="schema.html#python-executed-functions">Python-Executed Functions</a></li>
260<li class="toctree-l3"><a class="reference internal" href="schema.html#sql-expressions">SQL Expressions</a></li>
261<li class="toctree-l3"><a class="reference internal" href="schema.html#server-side-defaults">Server Side Defaults</a></li>
262<li class="toctree-l3"><a class="reference internal" href="schema.html#triggered-columns">Triggered Columns</a></li>
263<li class="toctree-l3"><a class="reference internal" href="schema.html#defining-sequences">Defining Sequences</a></li>
264<li class="toctree-l3"><a class="reference internal" href="schema.html#default-objects-api">Default Objects API</a></li>
265</ul>
266</li>
267<li class="toctree-l2"><a class="reference internal" href="schema.html#defining-constraints-and-indexes">Defining Constraints and Indexes</a><ul>
268<li class="toctree-l3"><a class="reference internal" href="schema.html#defining-foreign-keys">Defining Foreign Keys</a></li>
269<li class="toctree-l3"><a class="reference internal" href="schema.html#unique-constraint">UNIQUE Constraint</a></li>
270<li class="toctree-l3"><a class="reference internal" href="schema.html#check-constraint">CHECK Constraint</a></li>
271<li class="toctree-l3"><a class="reference internal" href="schema.html#setting-up-constraints-when-using-the-declarative-orm-extension">Setting up Constraints when using the Declarative ORM Extension</a></li>
272<li class="toctree-l3"><a class="reference internal" href="schema.html#constraints-api">Constraints API</a></li>
273<li class="toctree-l3"><a class="reference internal" href="schema.html#indexes">Indexes</a></li>
274</ul>
275</li>
276<li class="toctree-l2"><a class="reference internal" href="schema.html#customizing-ddl">Customizing DDL</a><ul>
277<li class="toctree-l3"><a class="reference internal" href="schema.html#controlling-ddl-sequences">Controlling DDL Sequences</a></li>
278<li class="toctree-l3"><a class="reference internal" href="schema.html#custom-ddl">Custom DDL</a></li>
279<li class="toctree-l3"><a class="reference internal" href="schema.html#ddl-expression-constructs-api">DDL Expression Constructs API</a></li>
280</ul>
281</li>
282</ul>
283</li>
284<li class="toctree-l1"><a class="reference internal" href="types.html">Column and Data Types</a><ul>
285<li class="toctree-l2"><a class="reference internal" href="types.html#generic-types">Generic Types</a></li>
286<li class="toctree-l2"><a class="reference internal" href="types.html#sql-standard-types">SQL Standard Types</a></li>
287<li class="toctree-l2"><a class="reference internal" href="types.html#vendor-specific-types">Vendor-Specific Types</a></li>
288<li class="toctree-l2"><a class="reference internal" href="types.html#custom-types">Custom Types</a><ul>
289<li class="toctree-l3"><a class="reference internal" href="types.html#overriding-type-compilation">Overriding Type Compilation</a></li>
290<li class="toctree-l3"><a class="reference internal" href="types.html#augmenting-existing-types">Augmenting Existing Types</a></li>
291<li class="toctree-l3"><a class="reference internal" href="types.html#typedecorator-recipes">TypeDecorator Recipes</a></li>
292<li class="toctree-l3"><a class="reference internal" href="types.html#creating-new-types">Creating New Types</a></li>
293</ul>
294</li>
295<li class="toctree-l2"><a class="reference internal" href="types.html#base-type-api">Base Type API</a></li>
296</ul>
297</li>
298<li class="toctree-l1"><a class="reference internal" href="event.html">Events</a><ul>
299<li class="toctree-l2"><a class="reference internal" href="event.html#event-registration">Event Registration</a></li>
300<li class="toctree-l2"><a class="reference internal" href="event.html#targets">Targets</a></li>
301<li class="toctree-l2"><a class="reference internal" href="event.html#modifiers">Modifiers</a></li>
302<li class="toctree-l2"><a class="reference internal" href="event.html#event-reference">Event Reference</a></li>
303<li class="toctree-l2"><a class="reference internal" href="event.html#api-reference">API Reference</a></li>
304</ul>
305</li>
306<li class="toctree-l1"><a class="reference internal" href="events.html">Core Events</a><ul>
307<li class="toctree-l2"><a class="reference internal" href="events.html#connection-pool-events">Connection Pool Events</a></li>
308<li class="toctree-l2"><a class="reference internal" href="events.html#connection-events">Connection Events</a></li>
309<li class="toctree-l2"><a class="reference internal" href="events.html#schema-events">Schema Events</a></li>
310</ul>
311</li>
312<li class="toctree-l1"><a class="reference internal" href="compiler.html">Custom SQL Constructs and Compilation Extension</a><ul>
313<li class="toctree-l2"><a class="reference internal" href="compiler.html#synopsis">Synopsis</a></li>
314<li class="toctree-l2"><a class="reference internal" href="compiler.html#dialect-specific-compilation-rules">Dialect-specific compilation rules</a></li>
315<li class="toctree-l2"><a class="reference internal" href="compiler.html#compiling-sub-elements-of-a-custom-expression-construct">Compiling sub-elements of a custom expression construct</a><ul>
316<li class="toctree-l3"><a class="reference internal" href="compiler.html#cross-compiling-between-sql-and-ddl-compilers">Cross Compiling between SQL and DDL compilers</a></li>
317</ul>
318</li>
319<li class="toctree-l2"><a class="reference internal" href="compiler.html#enabling-autocommit-on-a-construct">Enabling Autocommit on a Construct</a></li>
320<li class="toctree-l2"><a class="reference internal" href="compiler.html#changing-the-default-compilation-of-existing-constructs">Changing the default compilation of existing constructs</a></li>
321<li class="toctree-l2"><a class="reference internal" href="compiler.html#changing-compilation-of-types">Changing Compilation of Types</a></li>
322<li class="toctree-l2"><a class="reference internal" href="compiler.html#subclassing-guidelines">Subclassing Guidelines</a></li>
323<li class="toctree-l2"><a class="reference internal" href="compiler.html#further-examples">Further Examples</a><ul>
324<li class="toctree-l3"><a class="reference internal" href="compiler.html#utc-timestamp-function">“UTC timestamp” function</a></li>
325<li class="toctree-l3"><a class="reference internal" href="compiler.html#greatest-function">“GREATEST” function</a></li>
326<li class="toctree-l3"><a class="reference internal" href="compiler.html#false-expression">“false” expression</a></li>
327</ul>
328</li>
329</ul>
330</li>
331<li class="toctree-l1"><a class="reference internal" href="serializer.html">Expression Serializer Extension</a></li>
332<li class="toctree-l1"><a class="reference internal" href="interfaces.html">Deprecated Event Interfaces</a><ul>
333<li class="toctree-l2"><a class="reference internal" href="interfaces.html#execution-connection-and-cursor-events">Execution, Connection and Cursor Events</a></li>
334<li class="toctree-l2"><a class="reference internal" href="interfaces.html#connection-pool-events">Connection Pool Events</a></li>
335</ul>
336</li>
337<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Core Exceptions</a></li>
338<li class="toctree-l1"><a class="reference internal" href="internals.html">Core Internals</a></li>
339</ul>
340</div>
341</div>
342
343 </div>
344
345</div>
346
347<div id="docs-bottom-navigation" class="docs-navigation-links">
348 Previous:
349 <a href="../orm/internals.html" title="previous chapter">ORM Internals</a>
350 Next:
351 <a href="tutorial.html" title="next chapter">SQL Expression Language Tutorial</a>
352
353 <div id="docs-copyright">
354 © <a href="../copyright.html">Copyright</a> 2007-2012, the SQLAlchemy authors and contributors.
355 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
356 </div>
357</div>
358
359</div>
360
361
362 </body>
363</html>
364
365