PageRenderTime 27ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/packages/sqlalchemy/doc/intro.html

https://github.com/mozilla/kuma-lib
HTML | 206 lines | 165 code | 41 blank | 0 comment | 0 complexity | 0d5b9b60959b893389f2fc4d17c18d6a MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. <html>
    5. 

  5.     <head>
    6. 

  6.         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    7. 

  7.         
    8. 

  8.         <title>
    9. 

  9.     Overview / Installation
    10. 

  10.  &mdash; SQLAlchemy 0.6.4 Documentation</title>
    11. 

  11.         
    12. 

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    13. 

  13.     <link rel="stylesheet" href="_static/docs.css" type="text/css" />
    14. 

  14. 

  15.     <script type="text/javascript">
    16. 

  16.       var DOCUMENTATION_OPTIONS = {
    17. 

  17.           URL_ROOT:    '#',
    18. 

  18.           VERSION:     '0.6.4',
    19. 

  19.           COLLAPSE_MODINDEX: false,
    20. 

  20.           FILE_SUFFIX: '.html'
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.         <script type="text/javascript" src="_static/jquery.js"></script>
    24. 

  24.         <script type="text/javascript" src="_static/underscore.js"></script>
    25. 

  25.         <script type="text/javascript" src="_static/doctools.js"></script>
    26. 

  26.     <script type="text/javascript" src="_static/init.js"></script>
    27. 

  27.     <link rel="index" title="Index" href="genindex.html" />
    28. 

  28.     <link rel="search" title="Search" href="search.html" />
    29. 

  29.         <link rel="copyright" title="Copyright" href="copyright.html" />
    30. 

  30.     <link rel="top" title="SQLAlchemy 0.6.4 Documentation" href="index.html" />
    31. 

  31.         <link rel="next" title="SQLAlchemy ORM" href="orm/index.html" />
    32. 

  32.         <link rel="prev" title="Table of Contents" href="index.html" />
    33. 

  33.     
    34. 

  34. 

  35.     </head>
    36. 

  36.     <body>
    37. 

  37.         
    38. 

  38. 

  39. 

  40. 

  41. 

  42.         <h1>SQLAlchemy 0.6.4 Documentation</h1>
    43. 

  43. 

  44.         <div id="search">
    45. 

  45.         Search:
    46. 

  46.         <form class="search" action="search.html" method="get">
    47. 

  47.           <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
    48. 

  48.           <input type="hidden" name="check_keywords" value="yes" />
    49. 

  49.           <input type="hidden" name="area" value="default" />
    50. 

  50.         </form>
    51. 

  51.         </div>
    52. 

  52. 

  53.         <div class="versionheader">
    54. 

  54.             Version: <span class="versionnum">0.6.4</span> Last Updated: 09/07/2010 13:07:48
    55. 

  55.         </div>
    56. 

  56.         <div class="clearboth"></div>
    57. 

  57. 

  58.         <div class="topnav">
    59. 

  59.             <div id="pagecontrol">
    60. 

  60.                 <a href="genindex.html">Index</a>
    61. 

  61.             
    62. 

  62.                 <div class="sourcelink">(<a href="_sources/intro.txt">view source)</div>
    63. 

  63.             </div>
    64. 

  64.             
    65. 

  65.             <div class="navbanner">
    66. 

  66.                 <a class="totoc" href="index.html">Table of Contents</a>
    67. 

  67.                 » 
    68. 

  68.     Overview / Installation
    69. 

  69.  
    70. 

  70.                 
    71. 

  71.                 
    72. 

  72. <div class="prevnext">
    73. 

  73.         Previous:
    74. 

  74.         <a href="index.html" title="previous chapter">Table of Contents</a>
    75. 

  75.         Next:
    76. 

  76.         <a href="orm/index.html" title="next chapter">SQLAlchemy ORM</a>
    77. 

  77. </div>
    78. 

  78. 

  79.                 <h2>
    80. 

  80.                     
    81. 

  81.     Overview / Installation
    82. 

  82.  
    83. 

  83.                 </h2>
    84. 

  84.             </div>
    85. 

  85.                 <ul>
    86. 

  86. <li><a class="reference internal" href="#">Overview / Installation</a><ul>
    87. 

  87. <li><a class="reference internal" href="#overview">Overview</a></li>
    88. 

  88. <li><a class="reference internal" href="#documentation-overview">Documentation Overview</a></li>
    89. 

  89. <li><a class="reference internal" href="#code-examples">Code Examples</a></li>
    90. 

  90. <li><a class="reference internal" href="#installing-sqlalchemy">Installing SQLAlchemy</a></li>
    91. 

  91. <li><a class="reference internal" href="#installing-a-database-api">Installing a Database API</a></li>
    92. 

  92. <li><a class="reference internal" href="#checking-the-installed-sqlalchemy-version">Checking the Installed SQLAlchemy Version</a></li>
    93. 

  93. <li><a class="reference internal" href="#to-0-6-migration">0.5 to 0.6 Migration</a></li>
    94. 

  94. </ul>
    95. 

  95. </li>
    96. 

  96. </ul>
    97. 

  97. 

  98.             <div class="clearboth"></div>
    99. 

  99.         </div>
    100. 

  100.         
    101. 

  101.         <div class="document">
    102. 

  102.             <div class="body">
    103. 

  103.                 
    104. 

  104. <div class="section" id="overview-installation">
    105. 

  105. <span id="overview-toplevel"></span><h1>Overview / Installation<a class="headerlink" href="#overview-installation" title="Permalink to this headline"></a></h1>
    106. 

  106. <div class="section" id="overview">
    107. 

  107. <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h2>
    108. 

  108. <p>The SQLAlchemy SQL Toolkit and Object Relational Mapper is a comprehensive set of tools for working with databases and Python.  It has several distinct areas of functionality which can be used individually or combined together.  Its major components are illustrated below.  The arrows represent the general dependencies of components:</p>
    109. 

  109. <img alt="_images/sqla_arch_small.jpg" src="_images/sqla_arch_small.jpg" />
    110. 

  110. <p>Above, the two most significant front-facing portions of SQLAlchemy are the <strong>Object Relational Mapper</strong> and the <strong>SQL Expression Language</strong>.  SQL Expressions can be used independently of the ORM.  When using the ORM, the SQL Expression language remains part of the public facing API as it is used within object-relational configurations and queries.</p>
    111. 

  111. </div>
    112. 

  112. <div class="section" id="documentation-overview">
    113. 

  113. <h2>Documentation Overview<a class="headerlink" href="#documentation-overview" title="Permalink to this headline"></a></h2>
    114. 

  114. <p>The documentation is separated into three sections: <a class="reference internal" href="orm/index.html"><em>SQLAlchemy ORM</em></a>, <a class="reference internal" href="core/index.html"><em>SQLAlchemy Core</em></a>, and <a class="reference internal" href="dialects/index.html"><em>Dialects</em></a>.</p>
    115. 

  115. <p>In <a class="reference internal" href="orm/index.html"><em>SQLAlchemy ORM</em></a>, the Object Relational Mapper is introduced and fully
    116. 

  116. described. New users should begin with the <a class="reference internal" href="orm/tutorial.html"><em>Object Relational Tutorial</em></a>. If you
    117. 

  117. want to work with higher-level SQL which is constructed automatically for you,
    118. 

  118. as well as management of Python objects, proceed to this tutorial.</p>
    119. 

  119. <p>In <a class="reference internal" href="core/index.html"><em>SQLAlchemy Core</em></a>, the breadth of SQLAlchemy&#8217;s SQL and database
    120. 

  120. integration and description services are documented, the core of which is the
    121. 

  121. SQL Expression language.  The SQL Expression Language is a toolkit all its own,
    122. 

  122. independent of the ORM package, which can be used to construct manipulable SQL
    123. 

  123. expressions which can be programmatically constructed, modified, and executed,
    124. 

  124. returning cursor-like result sets.  In contrast to the ORM&#8217;s domain-centric
    125. 

  125. mode of usage, the expression language provides a schema-centric usage
    126. 

  126. paradigm.  New users should begin here with <a class="reference internal" href="core/tutorial.html"><em>SQL Expression Language Tutorial</em></a>.
    127. 

  127. SQLAlchemy engine, connection, and pooling services are also described in
    128. 

  128. <a class="reference internal" href="core/index.html"><em>SQLAlchemy Core</em></a>.</p>
    129. 

  129. <p>In <a class="reference internal" href="dialects/index.html"><em>Dialects</em></a>, reference documentation for all provided
    130. 

  130. database and DBAPI backends is provided.</p>
    131. 

  131. </div>
    132. 

  132. <div class="section" id="code-examples">
    133. 

  133. <h2>Code Examples<a class="headerlink" href="#code-examples" title="Permalink to this headline"></a></h2>
    134. 

  134. <p>Working code examples, mostly regarding the ORM, are included in the
    135. 

  135. SQLAlchemy distribution. A description of all the included example
    136. 

  136. applications is at <a class="reference internal" href="orm/examples.html"><em>Examples</em></a>.</p>
    137. 

  137. <p>There is also a wide variety of examples involving both core SQLAlchemy
    138. 

  138. constructs as well as the ORM on the wiki.  See
    139. 

  139. <a class="reference external" href="http://www.sqlalchemy.org/trac/wiki/UsageRecipes">http://www.sqlalchemy.org/trac/wiki/UsageRecipes</a>.</p>
    140. 

  140. </div>
    141. 

  141. <div class="section" id="installing-sqlalchemy">
    142. 

  142. <h2>Installing SQLAlchemy<a class="headerlink" href="#installing-sqlalchemy" title="Permalink to this headline"></a></h2>
    143. 

  143. <p>Installing SQLAlchemy from scratch is most easily achieved with <a class="reference external" href="http://pypi.python.org/pypi/setuptools/">setuptools</a>, or alternatively
    144. 

  144. <a class="reference external" href="http://pypi.python.org/pypi/pip/">pip</a>. Assuming it&#8217;s installed, just run
    145. 

  145. this from the command-line:</p>
    146. 

  146. <div class="highlight-none"><div class="highlight"><pre># easy_install SQLAlchemy</pre></div>
    147. 

  147. </div>
    148. 

  148. <p>Or with pip:</p>
    149. 

  149. <div class="highlight-none"><div class="highlight"><pre># pip install SQLAlchemy</pre></div>
    150. 

  150. </div>
    151. 

  151. <p>This command will download the latest version of SQLAlchemy from the <a class="reference external" href="http://pypi.python.org/pypi/SQLAlchemy">Python
    152. 

  152. Cheese Shop</a> and install it to your
    153. 

  153. system.</p>
    154. 

  154. <p>Otherwise, you can install from the distribution using the <tt class="docutils literal"><span class="pre">setup.py</span></tt> script:</p>
    155. 

  155. <div class="highlight-none"><div class="highlight"><pre># python setup.py install</pre></div>
    156. 

  156. </div>
    157. 

  157. </div>
    158. 

  158. <div class="section" id="installing-a-database-api">
    159. 

  159. <h2>Installing a Database API<a class="headerlink" href="#installing-a-database-api" title="Permalink to this headline"></a></h2>
    160. 

  160. <p>SQLAlchemy is designed to operate with a <a class="reference external" href="http://www.python.org/doc/peps/pep-0249/">DB-API</a> implementation built for a particular database, and includes support for the most popular databases.  The current list is at <a class="reference internal" href="core/engines.html#supported-dbapis"><em>Supported Databases</em></a>.</p>
    161. 

  161. </div>
    162. 

  162. <div class="section" id="checking-the-installed-sqlalchemy-version">
    163. 

  163. <h2>Checking the Installed SQLAlchemy Version<a class="headerlink" href="#checking-the-installed-sqlalchemy-version" title="Permalink to this headline"></a></h2>
    164. 

  164. <p>This documentation covers SQLAlchemy version 0.6.  If you&#8217;re working on a system that already has SQLAlchemy installed, check the version from your Python prompt like this:</p>
    165. 

  165. <div class="highlight-python+sql"><div class="highlight"><pre><span class="o">&gt;&gt;&gt;</span> <span class="kn">import</span> <span class="nn">sqlalchemy</span>
    166. 

  166. <span class="o">&gt;&gt;&gt;</span> <span class="n">sqlalchemy</span><span class="o">.</span><span class="n">__version__</span> 
    167. 

  167. <span class="mf">0.6</span><span class="o">.</span><span class="mi">0</span></pre></div>
    168. 

  168. </div>
    169. 

  169. </div>
    170. 

  170. <div class="section" id="to-0-6-migration">
    171. 

  171. <h2>0.5 to 0.6 Migration<a class="headerlink" href="#to-0-6-migration" title="Permalink to this headline"></a></h2>
    172. 

  172. <p>Notes on what&#8217;s changed from 0.5 to 0.6 is available on the SQLAlchemy wiki at <a class="reference external" href="http://www.sqlalchemy.org/trac/wiki/06Migration">06Migration</a>.</p>
    173. 

  173. </div>
    174. 

  174. </div>
    175. 

  175. 

  176.             </div>
    177. 

  177.         </div>
    178. 

  178. 

  179.         
    180. 

  180.         
    181. 

  181.             <div class="bottomnav">
    182. 

  182.                 
    183. 

  183. <div class="prevnext">
    184. 

  184.         Previous:
    185. 

  185.         <a href="index.html" title="previous chapter">Table of Contents</a>
    186. 

  186.         Next:
    187. 

  187.         <a href="orm/index.html" title="next chapter">SQLAlchemy ORM</a>
    188. 

  188. </div>
    189. 

  189. 

  190.                 <div class="doc_copyright">
    191. 

  191.                     &copy; <a href="copyright.html">Copyright</a> 2007, 2008, 2009, 2010, the SQLAlchemy authors and contributors.
    192. 

  192.                     Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    193. 

  193.                 </div>
    194. 

  194.             </div>
    195. 

  195.         
    196. 

  196. 

  197. 

  198. 

  199. 

  200. 

  201. 

  202.     </body>
    203. 

  203. </html>
    204. 

  204. 

  205. 

  206. 

  207.