doc/api/python/build.model.SessionCreator-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>build.model.SessionCreator</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="build-module.html">Package&nbsp;build</a> ::
       
    38         <a href="build.model-module.html">Module&nbsp;model</a> ::
       
    39         Class&nbsp;SessionCreator
       
    40       </span>
       
    41     </td>
       
    42     <td>
       
    43       <table cellpadding="0" cellspacing="0">
       
    44         <!-- hide/show private -->
       
    45         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    46     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="build.model.SessionCreator-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class SessionCreator</h1><span class="codelink"><a href="build.model-pysrc.html#SessionCreator">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">SessionCreator</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 Session Creator object.<br /><br />
       
    65 
       
    66 <!-- ==================== INSTANCE METHODS ==================== -->
       
    67 <a name="section-InstanceMethods"></a>
       
    68 <table class="summary" border="1" cellpadding="3"
       
    69        cellspacing="0" width="100%" bgcolor="white">
       
    70 <tr bgcolor="#70b0f0" class="table-header">
       
    71   <td colspan="2" class="table-header">
       
    72     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    73       <tr valign="top">
       
    74         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    75         <td align="right" valign="top"
       
    76          ><span class="options">[<a href="#section-InstanceMethods"
       
    77          class="privatelink" onclick="toggle_private();"
       
    78          >hide private</a>]</span></td>
       
    79       </tr>
       
    80     </table>
       
    81   </td>
       
    82 </tr>
       
    83 <tr>
       
    84     <td width="15%" align="right" valign="top" class="summary">
       
    85       <span class="summary-type">&nbsp;</span>
       
    86     </td><td class="summary">
       
    87       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    88         <tr>
       
    89           <td><span class="summary-sig"><a href="build.model.SessionCreator-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    90         <span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>,
       
    91         <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>,
       
    92         <span class="summary-sig-arg">provider</span>=<span class="summary-sig-default">None</span>)</span><br />
       
    93       Init the SessionCreator object.</td>
       
    94           <td align="right" valign="top">
       
    95             <span class="codelink"><a href="build.model-pysrc.html#SessionCreator.__init__">source&nbsp;code</a></span>
       
    96             
       
    97           </td>
       
    98         </tr>
       
    99       </table>
       
   100       
       
   101     </td>
       
   102   </tr>
       
   103 <tr>
       
   104     <td width="15%" align="right" valign="top" class="summary">
       
   105       <span class="summary-type">&nbsp;</span>
       
   106     </td><td class="summary">
       
   107       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   108         <tr>
       
   109           <td><span class="summary-sig"><a href="build.model.SessionCreator-class.html#session" class="summary-sig-name">session</a>(<span class="summary-sig-arg">self</span>,
       
   110         <span class="summary-sig-arg">database</span>)</span><br />
       
   111       Get a session for a database.</td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="build.model-pysrc.html#SessionCreator.session">source&nbsp;code</a></span>
       
   114             
       
   115           </td>
       
   116         </tr>
       
   117       </table>
       
   118       
       
   119     </td>
       
   120   </tr>
       
   121 <tr>
       
   122     <td width="15%" align="right" valign="top" class="summary">
       
   123       <span class="summary-type">&nbsp;</span>
       
   124     </td><td class="summary">
       
   125       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   126         <tr>
       
   127           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   128           <td align="right" valign="top">
       
   129             <span class="codelink"><a href="build.model-pysrc.html#SessionCreator.close">source&nbsp;code</a></span>
       
   130             
       
   131           </td>
       
   132         </tr>
       
   133       </table>
       
   134       
       
   135     </td>
       
   136   </tr>
       
   137   <tr>
       
   138     <td colspan="2" class="summary">
       
   139     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   140       <code>__delattr__</code>,
       
   141       <code>__getattribute__</code>,
       
   142       <code>__hash__</code>,
       
   143       <code>__new__</code>,
       
   144       <code>__reduce__</code>,
       
   145       <code>__reduce_ex__</code>,
       
   146       <code>__repr__</code>,
       
   147       <code>__setattr__</code>,
       
   148       <code>__str__</code>
       
   149       </p>
       
   150     </td>
       
   151   </tr>
       
   152 </table>
       
   153 <!-- ==================== PROPERTIES ==================== -->
       
   154 <a name="section-Properties"></a>
       
   155 <table class="summary" border="1" cellpadding="3"
       
   156        cellspacing="0" width="100%" bgcolor="white">
       
   157 <tr bgcolor="#70b0f0" class="table-header">
       
   158   <td colspan="2" class="table-header">
       
   159     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   160       <tr valign="top">
       
   161         <td align="left"><span class="table-header">Properties</span></td>
       
   162         <td align="right" valign="top"
       
   163          ><span class="options">[<a href="#section-Properties"
       
   164          class="privatelink" onclick="toggle_private();"
       
   165          >hide private</a>]</span></td>
       
   166       </tr>
       
   167     </table>
       
   168   </td>
       
   169 </tr>
       
   170   <tr>
       
   171     <td colspan="2" class="summary">
       
   172     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   173       <code>__class__</code>
       
   174       </p>
       
   175     </td>
       
   176   </tr>
       
   177 </table>
       
   178 <!-- ==================== METHOD DETAILS ==================== -->
       
   179 <a name="section-MethodDetails"></a>
       
   180 <table class="details" border="1" cellpadding="3"
       
   181        cellspacing="0" width="100%" bgcolor="white">
       
   182 <tr bgcolor="#70b0f0" class="table-header">
       
   183   <td colspan="2" class="table-header">
       
   184     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   185       <tr valign="top">
       
   186         <td align="left"><span class="table-header">Method Details</span></td>
       
   187         <td align="right" valign="top"
       
   188          ><span class="options">[<a href="#section-MethodDetails"
       
   189          class="privatelink" onclick="toggle_private();"
       
   190          >hide private</a>]</span></td>
       
   191       </tr>
       
   192     </table>
       
   193   </td>
       
   194 </tr>
       
   195 </table>
       
   196 <a name="__init__"></a>
       
   197 <div>
       
   198 <table class="details" border="1" cellpadding="3"
       
   199        cellspacing="0" width="100%" bgcolor="white">
       
   200 <tr><td>
       
   201   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   202   <tr valign="top"><td>
       
   203   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   204         <span class="sig-arg">username</span>=<span class="sig-default">None</span>,
       
   205         <span class="sig-arg">password</span>=<span class="sig-default">None</span>,
       
   206         <span class="sig-arg">provider</span>=<span class="sig-default">None</span>)</span>
       
   207     <br /><em class="fname">(Constructor)</em>
       
   208   </h3>
       
   209   </td><td align="right" valign="top"
       
   210     ><span class="codelink"><a href="build.model-pysrc.html#SessionCreator.__init__">source&nbsp;code</a></span>&nbsp;
       
   211     </td>
       
   212   </table>
       
   213   
       
   214   Init the SessionCreator object.
       
   215   <dl class="fields">
       
   216     <dt>Overrides:
       
   217       object.__init__
       
   218     </dt>
       
   219   </dl>
       
   220 </td></tr></table>
       
   221 </div>
       
   222 <a name="session"></a>
       
   223 <div>
       
   224 <table class="details" border="1" cellpadding="3"
       
   225        cellspacing="0" width="100%" bgcolor="white">
       
   226 <tr><td>
       
   227   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   228   <tr valign="top"><td>
       
   229   <h3 class="epydoc"><span class="sig"><span class="sig-name">session</span>(<span class="sig-arg">self</span>,
       
   230         <span class="sig-arg">database</span>)</span>
       
   231   </h3>
       
   232   </td><td align="right" valign="top"
       
   233     ><span class="codelink"><a href="build.model-pysrc.html#SessionCreator.session">source&nbsp;code</a></span>&nbsp;
       
   234     </td>
       
   235   </table>
       
   236   
       
   237   Get a session for a database. If no session exists just create a new one.
       
   238   <dl class="fields">
       
   239   </dl>
       
   240 </td></tr></table>
       
   241 </div>
       
   242 <br />
       
   243 <!-- ==================== NAVIGATION BAR ==================== -->
       
   244 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   245        bgcolor="#a0c0ff" cellspacing="0">
       
   246   <tr valign="middle">
       
   247 
       
   248   <!-- Tree link -->
       
   249       <th>&nbsp;&nbsp;&nbsp;<a
       
   250         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   251 
       
   252   <!-- Index link -->
       
   253       <th>&nbsp;&nbsp;&nbsp;<a
       
   254         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   255 
       
   256   <!-- Help link -->
       
   257       <th>&nbsp;&nbsp;&nbsp;<a
       
   258         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   259 
       
   260       <th class="navbar" width="100%"></th>
       
   261   </tr>
       
   262 </table>
       
   263 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   264   <tr>
       
   265     <td align="left" class="footer">
       
   266     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   267     </td>
       
   268     <td align="right" class="footer">
       
   269       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   270     </td>
       
   271   </tr>
       
   272 </table>
       
   273 
       
   274 <script type="text/javascript">
       
   275   <!--
       
   276   // Private objects are initially displayed (because if
       
   277   // javascript is turned off then we want them to be
       
   278   // visible); but by default, we want to hide them.  So hide
       
   279   // them unless we have a cookie that says to show them.
       
   280   checkCookie()
       
   281   // -->
       
   282 </script>
       
   283   
       
   284 </body>
       
   285 </html>