PageRenderTime 63ms CodeModel.GetById 29ms RepoModel.GetById 1ms app.codeStats 0ms

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