<!doctype html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>sqlobject.firebird.firebirdconnection — SQLObject 3.7.0 documentation</title>
<link rel="stylesheet" href="../../../_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript" src="../../../_static/documentation_options.js"></script>
<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>
<script type="text/javascript" src="../../../_static/bizstyle.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script type="text/javascript" src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SQLObject 3.7.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../firebird.html" accesskey="U">sqlobject.firebird</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for sqlobject.firebird.firebirdconnection</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="kn">from</span> <span class="nn">sqlobject</span> <span class="k">import</span> <span class="n">col</span>
<span class="kn">from</span> <span class="nn">sqlobject.dbconnection</span> <span class="k">import</span> <span class="n">DBAPI</span>
<div class="viewcode-block" id="FirebirdConnection"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection">[docs]</a><span class="k">class</span> <span class="nc">FirebirdConnection</span><span class="p">(</span><span class="n">DBAPI</span><span class="p">):</span>
<span class="n">supportTransactions</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">dbName</span> <span class="o">=</span> <span class="s1">'firebird'</span>
<span class="n">schemes</span> <span class="o">=</span> <span class="p">[</span><span class="n">dbName</span><span class="p">]</span>
<span class="n">limit_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s1">'^\s*(select )(.*)'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">db</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s1">'3050'</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s1">'sysdba'</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s1">'masterkey'</span><span class="p">,</span> <span class="n">autoCommit</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">dialect</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">role</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">charset</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="n">drivers</span> <span class="o">=</span> <span class="n">kw</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'driver'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">or</span> <span class="s1">'fdb,kinterbasdb'</span>
<span class="k">for</span> <span class="n">driver</span> <span class="ow">in</span> <span class="n">drivers</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">','</span><span class="p">):</span>
<span class="n">driver</span> <span class="o">=</span> <span class="n">driver</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">driver</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">driver</span> <span class="o">==</span> <span class="s1">'fdb'</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">fdb</span>
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">fdb</span>
<span class="k">elif</span> <span class="n">driver</span> <span class="o">==</span> <span class="s1">'kinterbasdb'</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">kinterbasdb</span>
<span class="c1"># See</span>
<span class="c1"># http://kinterbasdb.sourceforge.net/dist_docs/usage.html</span>
<span class="c1"># for an explanation; in short: use datetime, decimal and</span>
<span class="c1"># unicode.</span>
<span class="n">kinterbasdb</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">type_conv</span><span class="o">=</span><span class="mi">200</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">kinterbasdb</span>
<span class="k">elif</span> <span class="n">driver</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'firebirdsql'</span><span class="p">,</span> <span class="s1">'pyfirebirdsql'</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">firebirdsql</span>
<span class="bp">self</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">firebirdsql</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">'Unknown FireBird driver "</span><span class="si">%s</span><span class="s1">", '</span>
<span class="s1">'expected fdb, kinterbasdb or firebirdsql'</span> <span class="o">%</span> <span class="n">driver</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ImportError</span><span class="p">(</span>
<span class="s1">'Cannot find an FireBird driver, tried </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">drivers</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span>
<span class="bp">self</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="n">port</span>
<span class="bp">self</span><span class="o">.</span><span class="n">db</span> <span class="o">=</span> <span class="n">db</span>
<span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</span>
<span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">password</span>
<span class="k">if</span> <span class="n">dialect</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">dialect</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">role</span> <span class="o">=</span> <span class="n">role</span>
<span class="k">if</span> <span class="n">charset</span><span class="p">:</span>
<span class="c1"># Encoding defined by user in the connection string.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span> <span class="o">=</span> <span class="n">charset</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'-'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span> <span class="o">=</span> <span class="n">charset</span>
<span class="c1"># Encoding defined during database creation and stored in the database.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span> <span class="o">=</span> <span class="s1">''</span>
<span class="n">DBAPI</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">_connectionFromParams</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">auth</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">password</span><span class="p">:</span>
<span class="n">password</span> <span class="o">=</span> <span class="s1">'masterkey'</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">auth</span><span class="p">:</span>
<span class="n">auth</span> <span class="o">=</span> <span class="s1">'sysdba'</span>
<span class="c1"># check for alias using</span>
<span class="k">if</span> <span class="p">(</span><span class="n">path</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'/'</span><span class="p">)</span> <span class="ow">and</span> <span class="n">path</span><span class="p">[</span><span class="o">-</span><span class="mi">3</span><span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'fdb'</span><span class="p">,</span> <span class="s1">'gdb'</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'/'</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">sep</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="n">port</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="n">auth</span><span class="p">,</span> <span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
<span class="o">**</span><span class="n">args</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_runWithConnection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">meth</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">autoCommit</span><span class="p">:</span>
<span class="k">return</span> <span class="n">DBAPI</span><span class="o">.</span><span class="n">_runWithConnection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">meth</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">getConnection</span><span class="p">()</span>
<span class="c1"># @@: Horrible auto-commit implementation. Just horrible!</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">conn</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
<span class="k">except</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">ProgrammingError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">val</span> <span class="o">=</span> <span class="n">meth</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
<span class="k">except</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">ProgrammingError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">finally</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">releaseConnection</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span>
<span class="k">return</span> <span class="n">val</span>
<span class="k">def</span> <span class="nf">_setAutoCommit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">auto</span><span class="p">):</span>
<span class="c1"># Only _runWithConnection does "autocommit", so we don't</span>
<span class="c1"># need to worry about that.</span>
<span class="k">pass</span>
<div class="viewcode-block" id="FirebirdConnection.makeConnection"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.makeConnection">[docs]</a> <span class="k">def</span> <span class="nf">makeConnection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">extra</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dialect</span><span class="p">:</span>
<span class="n">extra</span><span class="p">[</span><span class="s1">'dialect'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dialect</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span>
<span class="n">host</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">host</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">port</span><span class="p">,</span>
<span class="n">database</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span>
<span class="n">role</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">role</span><span class="p">,</span>
<span class="n">charset</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">,</span>
<span class="o">**</span><span class="n">extra</span>
<span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_queryInsertID</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">soInstance</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> <span class="n">values</span><span class="p">):</span>
<span class="sd">"""Firebird uses 'generators' to create new ids for a table.</span>
<span class="sd"> The users needs to create a generator named GEN_<tablename></span>
<span class="sd"> for each table this method to work."""</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">soInstance</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span>
<span class="n">idName</span> <span class="o">=</span> <span class="n">soInstance</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">idName</span>
<span class="n">sequenceName</span> <span class="o">=</span> <span class="n">soInstance</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">idSequence</span> <span class="ow">or</span> <span class="s1">'GEN_</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">table</span>
<span class="n">c</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s1">'SELECT gen_id(</span><span class="si">%s</span><span class="s1">,1) FROM rdb$database'</span> <span class="o">%</span> <span class="n">sequenceName</span><span class="p">)</span>
<span class="nb">id</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">names</span> <span class="o">=</span> <span class="p">[</span><span class="n">idName</span><span class="p">]</span> <span class="o">+</span> <span class="n">names</span>
<span class="n">values</span> <span class="o">=</span> <span class="p">[</span><span class="nb">id</span><span class="p">]</span> <span class="o">+</span> <span class="n">values</span>
<span class="n">q</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_insertSQL</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> <span class="n">values</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debug</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">printDebug</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">q</span><span class="p">,</span> <span class="s1">'QueryIns'</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">debugOutput</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">printDebug</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="s1">'QueryIns'</span><span class="p">,</span> <span class="s1">'result'</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">id</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">_queryAddLimitOffset</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">query</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">):</span>
<span class="sd">"""Firebird slaps the limit and offset (actually 'first' and</span>
<span class="sd"> 'skip', respectively) statement right after the select."""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">start</span><span class="p">:</span>
<span class="n">limit_str</span> <span class="o">=</span> <span class="s2">"SELECT FIRST </span><span class="si">%i</span><span class="s2">"</span> <span class="o">%</span> <span class="n">end</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">end</span><span class="p">:</span>
<span class="n">limit_str</span> <span class="o">=</span> <span class="s2">"SELECT SKIP </span><span class="si">%i</span><span class="s2">"</span> <span class="o">%</span> <span class="n">start</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">limit_str</span> <span class="o">=</span> <span class="s2">"SELECT FIRST </span><span class="si">%i</span><span class="s2"> SKIP </span><span class="si">%i</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">end</span> <span class="o">-</span> <span class="n">start</span><span class="p">,</span> <span class="n">start</span><span class="p">)</span>
<span class="n">match</span> <span class="o">=</span> <span class="bp">cls</span><span class="o">.</span><span class="n">limit_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">())</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">limit_str</span><span class="p">,</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">)])</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">query</span>
<div class="viewcode-block" id="FirebirdConnection.createTable"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createTable">[docs]</a> <span class="k">def</span> <span class="nf">createTable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soClass</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s1">'CREATE TABLE </span><span class="si">%s</span><span class="s1"> (</span><span class="se">\n</span><span class="si">%s</span><span class="se">\n</span><span class="s1">)'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">createColumns</span><span class="p">(</span><span class="n">soClass</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"CREATE GENERATOR GEN_</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[]</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.createReferenceConstraint"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createReferenceConstraint">[docs]</a> <span class="k">def</span> <span class="nf">createReferenceConstraint</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soClass</span><span class="p">,</span> <span class="n">col</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">None</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.createColumn"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createColumn">[docs]</a> <span class="k">def</span> <span class="nf">createColumn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soClass</span><span class="p">,</span> <span class="n">col</span><span class="p">):</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">firebirdCreateSQL</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.createIDColumn"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createIDColumn">[docs]</a> <span class="k">def</span> <span class="nf">createIDColumn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soClass</span><span class="p">):</span>
<span class="n">key_type</span> <span class="o">=</span> <span class="p">{</span><span class="nb">int</span><span class="p">:</span> <span class="s2">"INT"</span><span class="p">,</span> <span class="nb">str</span><span class="p">:</span> <span class="s2">"VARCHAR(255)"</span><span class="p">}[</span><span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">idType</span><span class="p">]</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%s</span><span class="s1"> </span><span class="si">%s</span><span class="s1"> NOT NULL PRIMARY KEY'</span> <span class="o">%</span> <span class="p">(</span><span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">idName</span><span class="p">,</span>
<span class="n">key_type</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.createIndexSQL"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createIndexSQL">[docs]</a> <span class="k">def</span> <span class="nf">createIndexSQL</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">soClass</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="k">return</span> <span class="n">index</span><span class="o">.</span><span class="n">firebirdCreateIndexSQL</span><span class="p">(</span><span class="n">soClass</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.joinSQLType"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.joinSQLType">[docs]</a> <span class="k">def</span> <span class="nf">joinSQLType</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">join</span><span class="p">):</span>
<span class="k">return</span> <span class="s1">'INT NOT NULL'</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.tableExists"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.tableExists">[docs]</a> <span class="k">def</span> <span class="nf">tableExists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tableName</span><span class="p">):</span>
<span class="c1"># there's something in the database by this name...let's</span>
<span class="c1"># assume it's a table. By default, fb 1.0 stores EVERYTHING</span>
<span class="c1"># it cares about in uppercase.</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">queryOne</span><span class="p">(</span>
<span class="s2">"SELECT COUNT(rdb$relation_name) FROM rdb$relations "</span>
<span class="s2">"WHERE rdb$relation_name = '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span> <span class="n">tableName</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
<span class="k">return</span> <span class="n">result</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.addColumn"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.addColumn">[docs]</a> <span class="k">def</span> <span class="nf">addColumn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tableName</span><span class="p">,</span> <span class="n">column</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s1">'ALTER TABLE </span><span class="si">%s</span><span class="s1"> ADD </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span>
<span class="p">(</span><span class="n">tableName</span><span class="p">,</span>
<span class="n">column</span><span class="o">.</span><span class="n">firebirdCreateSQL</span><span class="p">()))</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.dropTable"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.dropTable">[docs]</a> <span class="k">def</span> <span class="nf">dropTable</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tableName</span><span class="p">,</span> <span class="n">cascade</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"DROP TABLE </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">tableName</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">"DROP GENERATOR GEN_</span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">tableName</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.delColumn"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.delColumn">[docs]</a> <span class="k">def</span> <span class="nf">delColumn</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sqlmeta</span><span class="p">,</span> <span class="n">column</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s1">'ALTER TABLE </span><span class="si">%s</span><span class="s1"> DROP </span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">table</span><span class="p">,</span> <span class="n">column</span><span class="o">.</span><span class="n">dbName</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.readDefaultEncodingFromDB"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.readDefaultEncodingFromDB">[docs]</a> <span class="k">def</span> <span class="nf">readDefaultEncodingFromDB</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Get out if encoding is known allready (can by None as well).</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span> <span class="o">==</span> <span class="s2">""</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">queryOne</span><span class="p">(</span>
<span class="s2">"SELECT rdb$character_set_name FROM rdb$database"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span>
<span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span> <span class="c1"># encoding defined during db creation</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span> <span class="o">==</span> <span class="s2">"none"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span><span class="p">:</span>
<span class="n">warningText</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\n</span><span class="s2"></span>
<span class="s2"> Database charset: </span><span class="si">%s</span><span class="s2"> is different """</span> \
<span class="sd">"""from connection charset: %s.\n"""</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">)</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">warningText</span><span class="p">)</span>
<span class="c1"># TODO: ??? print out the uri string,</span>
<span class="c1"># so user can see what is going on</span>
<span class="n">warningText</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\n</span><span class="s2"></span>
<span class="s2"> Every CHAR or VARCHAR field can (or, better: must) """</span> \
<span class="sd">"""have a character set defined in Firebird.</span>
<span class="sd"> In the case, field charset is not defined, """</span> \
<span class="sd">"""SQLObject try to use a db default encoding instead.</span>
<span class="sd"> Firebird is unable to transliterate between character sets.</span>
<span class="sd"> So you must set the correct values on the server """</span> \
<span class="s2">"and on the client if everything is to work smoothely.</span><span class="se">\n</span><span class="s2">"</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">warningText</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">:</span> <span class="c1"># defined by user in the connection string</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">defaultDbEncoding</span>
<span class="n">warningText</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\n</span><span class="s2"></span>
<span class="s2"> encoding: </span><span class="si">%s</span><span class="s2"> will be used as default """</span> \
<span class="sd">"""for this connection\n"""</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">warningText</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.columnsFromSchema"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.columnsFromSchema">[docs]</a> <span class="k">def</span> <span class="nf">columnsFromSchema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">tableName</span><span class="p">,</span> <span class="n">soClass</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Look at the given table and create Col instances (or</span>
<span class="sd"> subclasses of Col) for the fields it finds in that table.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">readDefaultEncodingFromDB</span><span class="p">()</span>
<span class="n">fieldQuery</span> <span class="o">=</span> <span class="s2">"""</span><span class="se">\</span>
<span class="s2"> SELECT r.RDB$FIELD_NAME AS field_name,</span>
<span class="s2"> CASE f.RDB$FIELD_TYPE</span>
<span class="s2"> when 7 then 'smallint'</span>
<span class="s2"> when 8 then 'integer'</span>
<span class="s2"> when 16 then 'int64'</span>
<span class="s2"> when 9 then 'quad'</span>
<span class="s2"> when 10 then 'float'</span>
<span class="s2"> when 11 then 'd_float'</span>
<span class="s2"> when 17 then 'boolean'</span>
<span class="s2"> when 27 then 'double'</span>
<span class="s2"> when 12 then 'date'</span>
<span class="s2"> when 13 then 'time'</span>
<span class="s2"> when 35 then 'timestamp'</span>
<span class="s2"> when 261 then 'blob'</span>
<span class="s2"> when 37 then 'varchar'</span>
<span class="s2"> when 14 then 'char'</span>
<span class="s2"> when 40 then 'cstring'</span>
<span class="s2"> when 45 then 'blob_id'</span>
<span class="s2"> ELSE 'UNKNOWN'</span>
<span class="s2"> END AS field_type,</span>
<span class="s2"> case f.rdb$field_type</span>
<span class="s2"> when 7 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 1 then 'numeric'</span>
<span class="s2"> when 2 then 'decimal'</span>
<span class="s2"> end</span>
<span class="s2"> when 8 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 1 then 'numeric'</span>
<span class="s2"> when 2 then 'decimal'</span>
<span class="s2"> end</span>
<span class="s2"> when 16 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 1 then 'numeric'</span>
<span class="s2"> when 2 then 'decimal'</span>
<span class="s2"> else 'bigint'</span>
<span class="s2"> end</span>
<span class="s2"> when 14 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 0 then 'unspecified'</span>
<span class="s2"> when 1 then 'binary'</span>
<span class="s2"> when 3 then 'acl'</span>
<span class="s2"> else</span>
<span class="s2"> case</span>
<span class="s2"> when f.rdb$field_sub_type is null then 'unspecified'</span>
<span class="s2"> end</span>
<span class="s2"> end</span>
<span class="s2"> when 37 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 0 then 'unspecified'</span>
<span class="s2"> when 1 then 'text'</span>
<span class="s2"> when 3 then 'acl'</span>
<span class="s2"> else</span>
<span class="s2"> case</span>
<span class="s2"> when f.rdb$field_sub_type is null then 'unspecified'</span>
<span class="s2"> end</span>
<span class="s2"> end</span>
<span class="s2"> when 261 then</span>
<span class="s2"> case f.rdb$field_sub_type</span>
<span class="s2"> when 0 then 'unspecified'</span>
<span class="s2"> when 1 then 'text'</span>
<span class="s2"> when 2 then 'blr'</span>
<span class="s2"> when 3 then 'acl'</span>
<span class="s2"> when 4 then 'reserved'</span>
<span class="s2"> when 5 then 'encoded-meta-data'</span>
<span class="s2"> when 6 then 'irregular-finished-multi-db-tx'</span>
<span class="s2"> when 7 then 'transactional_description'</span>
<span class="s2"> when 8 then 'external_file_description'</span>
<span class="s2"> end</span>
<span class="s2"> end as "ActualSubType",</span>
<span class="s2"> f.RDB$FIELD_LENGTH AS field_length,</span>
<span class="s2"> f.RDB$FIELD_PRECISION AS field_precision,</span>
<span class="s2"> f.RDB$FIELD_SCALE AS field_scale,</span>
<span class="s2"> cset.RDB$CHARACTER_SET_NAME AS field_charset,</span>
<span class="s2"> coll.RDB$COLLATION_NAME AS field_collation,</span>
<span class="s2"> r.rdb$default_source,</span>
<span class="s2"> r.RDB$NULL_FLAG AS field_not_null_constraint,</span>
<span class="s2"> r.RDB$DESCRIPTION AS field_description</span>
<span class="s2"> FROM RDB$RELATION_FIELDS r</span>
<span class="s2"> LEFT JOIN RDB$FIELDS f ON r.RDB$FIELD_SOURCE = f.RDB$FIELD_NAME</span>
<span class="s2"> LEFT JOIN RDB$COLLATIONS coll</span>
<span class="s2"> ON f.RDB$COLLATION_ID = coll.RDB$COLLATION_ID</span>
<span class="s2"> LEFT JOIN RDB$CHARACTER_SETS cset</span>
<span class="s2"> ON f.RDB$CHARACTER_SET_ID = cset.RDB$CHARACTER_SET_ID</span>
<span class="s2"> WHERE r.RDB$RELATION_NAME='</span><span class="si">%s</span><span class="s2">' -- table name</span>
<span class="s2"> ORDER BY r.RDB$FIELD_POSITION</span>
<span class="s2"> """</span>
<span class="n">colData</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">queryAll</span><span class="p">(</span><span class="n">fieldQuery</span> <span class="o">%</span> <span class="n">tableName</span><span class="o">.</span><span class="n">upper</span><span class="p">())</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">fieldType</span><span class="p">,</span> <span class="n">fieldSubtype</span><span class="p">,</span> <span class="n">fieldLength</span><span class="p">,</span> <span class="n">fieldPrecision</span><span class="p">,</span>
<span class="n">fieldScale</span><span class="p">,</span> <span class="n">fieldCharset</span><span class="p">,</span> <span class="n">collationName</span><span class="p">,</span> <span class="n">defaultSource</span><span class="p">,</span>
<span class="n">fieldNotNullConstraint</span><span class="p">,</span> <span class="n">fieldDescription</span><span class="p">)</span> <span class="ow">in</span> <span class="n">colData</span><span class="p">:</span>
<span class="n">field</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
<span class="n">fieldType</span> <span class="o">=</span> <span class="n">fieldType</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">fieldCharset</span><span class="p">:</span>
<span class="n">fieldCharset</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">fieldCharset</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="c1"># 'UNICODE_FSS' is less strict</span>
<span class="c1"># Firebird/Interbase UTF8 definition</span>
<span class="k">if</span> <span class="n">fieldCharset</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s1">'UNICODE_FSS'</span><span class="p">):</span>
<span class="n">fieldCharset</span> <span class="o">=</span> <span class="s2">"UTF8"</span>
<span class="k">if</span> <span class="n">fieldSubtype</span><span class="p">:</span>
<span class="n">fieldSubtype</span> <span class="o">=</span> <span class="n">fieldSubtype</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="n">fieldType</span> <span class="o">==</span> <span class="s2">"int64"</span><span class="p">:</span>
<span class="n">fieldType</span> <span class="o">=</span> <span class="n">fieldSubtype</span>
<span class="c1"># can look like: "DEFAULT 0", "DEFAULT 'default text'", None</span>
<span class="k">if</span> <span class="n">defaultSource</span><span class="p">:</span>
<span class="n">defaultSource</span> <span class="o">=</span> <span class="n">defaultSource</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">' '</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">if</span> <span class="n">defaultSource</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"'"</span><span class="p">)</span> <span class="ow">and</span> \
<span class="n">defaultSource</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"'"</span><span class="p">):</span>
<span class="n">defaultSource</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">defaultSource</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
<span class="k">elif</span> <span class="n">fieldType</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"integer"</span><span class="p">,</span> <span class="s2">"smallint"</span><span class="p">,</span> <span class="s2">"bigint"</span><span class="p">):</span>
<span class="n">defaultSource</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">defaultSource</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">fieldType</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">"float"</span><span class="p">,</span> <span class="s2">"double"</span><span class="p">):</span>
<span class="n">defaultSource</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">defaultSource</span><span class="p">)</span>
<span class="c1"># TODO: other types for defaultSource</span>
<span class="c1"># elif fieldType == "datetime":</span>
<span class="n">idName</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">idName</span> <span class="ow">or</span> <span class="s1">'id'</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="n">idName</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">fieldScale</span><span class="p">:</span>
<span class="c1"># PRECISION refers to the total number of digits,</span>
<span class="c1"># and SCALE refers to the number of digits</span>
<span class="c1"># to the right of the decimal point.</span>
<span class="c1"># Both numbers can be from 1 to 18 (SQL dialect 1: 1-15),</span>
<span class="c1"># but SCALE mustbe less than or equal to PRECISION.</span>
<span class="k">if</span> <span class="n">fieldScale</span> <span class="o">></span> <span class="n">fieldLength</span><span class="p">:</span>
<span class="n">fieldScale</span> <span class="o">=</span> <span class="n">fieldLength</span>
<span class="n">colClass</span><span class="p">,</span> <span class="n">kw</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">guessClass</span><span class="p">(</span><span class="n">fieldType</span><span class="p">,</span> <span class="n">fieldLength</span><span class="p">,</span>
<span class="n">fieldCharset</span><span class="p">,</span> <span class="n">fieldScale</span><span class="p">)</span>
<span class="n">kw</span><span class="p">[</span><span class="s1">'name'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span>
<span class="n">soClass</span><span class="o">.</span><span class="n">sqlmeta</span><span class="o">.</span><span class="n">style</span><span class="o">.</span><span class="n">dbColumnToPythonAttr</span><span class="p">(</span><span class="n">field</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span>
<span class="n">kw</span><span class="p">[</span><span class="s1">'dbName'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">field</span><span class="p">)</span>
<span class="n">kw</span><span class="p">[</span><span class="s1">'notNone'</span><span class="p">]</span> <span class="o">=</span> <span class="ow">not</span> <span class="n">fieldNotNullConstraint</span>
<span class="n">kw</span><span class="p">[</span><span class="s1">'default'</span><span class="p">]</span> <span class="o">=</span> <span class="n">defaultSource</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">colClass</span><span class="p">(</span><span class="o">**</span><span class="n">kw</span><span class="p">))</span>
<span class="k">return</span> <span class="n">results</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.guessClass"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.guessClass">[docs]</a> <span class="k">def</span> <span class="nf">guessClass</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">t</span><span class="p">,</span> <span class="n">flength</span><span class="p">,</span> <span class="n">fCharset</span><span class="p">,</span> <span class="n">fscale</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An internal method that tries to figure out what Col subclass</span>
<span class="sd"> is appropriate given whatever introspective information is</span>
<span class="sd"> available -- both very database-specific.</span>
<span class="sd"> """</span>
<span class="c1"># TODO: check if negative values are allowed for fscale</span>
<span class="k">if</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'smallint'</span><span class="p">:</span> <span class="c1"># -32,768 to +32,767, 16 bits</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">IntCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'integer'</span><span class="p">:</span> <span class="c1"># -2,147,483,648 to +2,147,483,647, 32 bits</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">IntCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'bigint'</span><span class="p">:</span>
<span class="c1"># -2^63 to 2^63-1 or</span>
<span class="c1"># -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807, 64 bits</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">IntCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'float'</span><span class="p">:</span>
<span class="c1"># 32 bits, 3.4x10^-38 to 3.4x10^38, 7 digit precision</span>
<span class="c1"># (7 significant decimals)</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">FloatCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'double'</span><span class="p">:</span>
<span class="c1"># 64 bits, 1.7x10^-308 to 1.7x10^308, 15 digit precision</span>
<span class="c1"># (15 significant decimals)</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">FloatCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'numeric'</span><span class="p">:</span>
<span class="c1"># Numeric and Decimal are internally stored as smallint,</span>
<span class="c1"># integer or bigint depending on the size.</span>
<span class="c1"># They can handle up to 18 digits.</span>
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="n">flength</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">fscale</span><span class="p">):</span>
<span class="c1"># If neither PRECISION nor SCALE are specified,</span>
<span class="c1"># Firebird/InterBase defines the column as INTEGER</span>
<span class="c1"># instead of NUMERIC and stores only the integer portion</span>
<span class="c1"># of the value</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">IntCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="c1"># check if negative values are allowed for fscale</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">DecimalCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'precision'</span><span class="p">:</span> <span class="n">fscale</span><span class="p">}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'decimal'</span><span class="p">:</span>
<span class="c1"># Check if negative values are allowed for fscale</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">DecimalCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'size'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'precision'</span><span class="p">:</span> <span class="n">fscale</span><span class="p">}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'date'</span><span class="p">:</span> <span class="c1"># 32 bits, 1 Jan 100. to 29 Feb 32768.</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">DateCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'time'</span><span class="p">:</span> <span class="c1"># 32 bits, 00:00 to 23:59.9999</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">TimeCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'timestamp'</span><span class="p">:</span> <span class="c1"># 64 bits, 1 Jan 100 to 28 Feb 32768.</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">DateTimeCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'char'</span><span class="p">:</span> <span class="c1"># 32767 bytes</span>
<span class="k">if</span> <span class="n">fCharset</span> <span class="ow">and</span> <span class="p">(</span><span class="n">fCharset</span> <span class="o">!=</span> <span class="s2">"NONE"</span><span class="p">):</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">UnicodeCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s1">'dbEncoding'</span><span class="p">:</span> <span class="n">fCharset</span><span class="p">}</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">:</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">UnicodeCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
<span class="s1">'dbEncoding'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">StringCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="c1"># 32767 bytes</span>
<span class="k">if</span> <span class="n">fCharset</span> <span class="ow">and</span> <span class="p">(</span><span class="n">fCharset</span> <span class="o">!=</span> <span class="s2">"NONE"</span><span class="p">):</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">UnicodeCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">'dbEncoding'</span><span class="p">:</span> <span class="n">fCharset</span><span class="p">}</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">:</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">UnicodeCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
<span class="s1">'dbEncoding'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">dbEncoding</span><span class="p">}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">StringCol</span><span class="p">,</span> <span class="p">{</span><span class="s1">'length'</span><span class="p">:</span> <span class="n">flength</span><span class="p">,</span> <span class="s1">'varchar'</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
<span class="k">elif</span> <span class="n">t</span> <span class="o">==</span> <span class="s1">'blob'</span><span class="p">:</span> <span class="c1"># 32GB</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">BLOBCol</span><span class="p">,</span> <span class="p">{}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">col</span><span class="o">.</span><span class="n">Col</span><span class="p">,</span> <span class="p">{}</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.createEmptyDatabase"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.createEmptyDatabase">[docs]</a> <span class="k">def</span> <span class="nf">createEmptyDatabase</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">create_database</span><span class="p">(</span>
<span class="s2">"CREATE DATABASE '</span><span class="si">%s</span><span class="s2">' user '</span><span class="si">%s</span><span class="s2">' password '</span><span class="si">%s</span><span class="s2">'"</span> <span class="o">%</span>
<span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="FirebirdConnection.dropDatabase"><a class="viewcode-back" href="../../../api/sqlobject.firebird.firebirdconnection.html#sqlobject.firebird.firebirdconnection.FirebirdConnection.dropDatabase">[docs]</a> <span class="k">def</span> <span class="nf">dropDatabase</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">module</span><span class="o">.</span><span class="n">drop_database</span><span class="p">()</span>
</pre></div></div></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SQLObject 3.7.0 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../firebird.html" >sqlobject.firebird</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2004-2018, Ian Bicking and contributors.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.4.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f1af5ac4c8d0f3f6ef0bca84cf516f3e
>
files
>
680
