<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>12.13. sqlite3 — DB-API 2.0 interface for SQLite databases — Python v2.6.5 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.6.5',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Python v2.6.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="top" title="Python v2.6.5 documentation" href="../index.html" />
<link rel="up" title="12. Data Persistence" href="persistence.html" />
<link rel="next" title="13. Data Compression and Archiving" href="archiving.html" />
<link rel="prev" title="12.12. dumbdbm — Portable DBM implementation" href="dumbdbm.html" />
<link rel="shortcut icon" type="image/png" href="../_static/py.png" />
</head>
<body>
<div class="related">
<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="../modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="archiving.html" title="13. Data Compression and Archiving"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dumbdbm.html" title="12.12. dumbdbm — Portable DBM implementation"
accesskey="P">previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="persistence.html" accesskey="U">12. Data Persistence</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sqlite3">
<h1>12.13. <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> — DB-API 2.0 interface for SQLite databases<a class="headerlink" href="#module-sqlite3" title="Permalink to this headline">¶</a></h1>
<p class="versionadded">
<span class="versionmodified">New in version 2.5.</span></p>
<p>SQLite is a C library that provides a lightweight disk-based database that
doesn’t require a separate server process and allows accessing the database
using a nonstandard variant of the SQL query language. Some applications can use
SQLite for internal data storage. It’s also possible to prototype an
application using SQLite and then port the code to a larger database such as
PostgreSQL or Oracle.</p>
<p>sqlite3 was written by Gerhard Häring and provides a SQL interface compliant
with the DB-API 2.0 specification described by <span class="target" id="index-567"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0249"><strong>PEP 249</strong></a>.</p>
<p>To use the module, you must first create a <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> object that
represents the database. Here the data will be stored in the
<tt class="docutils literal"><span class="pre">/tmp/example</span></tt> file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'/tmp/example'</span><span class="p">)</span>
</pre></div>
</div>
<p>You can also supply the special name <tt class="docutils literal"><span class="pre">:memory:</span></tt> to create a database in RAM.</p>
<p>Once you have a <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a>, you can create a <a title="sqlite3.Cursor" class="reference internal" href="#sqlite3.Cursor"><tt class="xref docutils literal"><span class="pre">Cursor</span></tt></a> object
and call its <a title="sqlite3.Cursor.execute" class="reference internal" href="#sqlite3.Cursor.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a> method to perform SQL commands:</p>
<div class="highlight-python"><div class="highlight"><pre><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="c"># Create table</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'''create table stocks</span>
<span class="s">(date text, trans text, symbol text,</span>
<span class="s"> qty real, price real)'''</span><span class="p">)</span>
<span class="c"># Insert a row of data</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"""insert into stocks</span>
<span class="s"> values ('2006-01-05','BUY','RHAT',100,35.14)"""</span><span class="p">)</span>
<span class="c"># Save (commit) the changes</span>
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
<span class="c"># We can also close the cursor if we are done with it</span>
<span class="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>Usually your SQL operations will need to use values from Python variables. You
shouldn’t assemble your query using Python’s string operations because doing so
is insecure; it makes your program vulnerable to an SQL injection attack.</p>
<p>Instead, use the DB-API’s parameter substitution. Put <tt class="docutils literal"><span class="pre">?</span></tt> as a placeholder
wherever you want to use a value, and then provide a tuple of values as the
second argument to the cursor’s <a title="sqlite3.Cursor.execute" class="reference internal" href="#sqlite3.Cursor.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a> method. (Other database
modules may use a different placeholder, such as <tt class="docutils literal"><span class="pre">%s</span></tt> or <tt class="docutils literal"><span class="pre">:1</span></tt>.) For
example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Never do this -- insecure!</span>
<span class="n">symbol</span> <span class="o">=</span> <span class="s">'IBM'</span>
<span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"... where symbol = '</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="n">symbol</span><span class="p">)</span>
<span class="c"># Do this instead</span>
<span class="n">t</span> <span class="o">=</span> <span class="p">(</span><span class="n">symbol</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="s">'select * from stocks where symbol=?'</span><span class="p">,</span> <span class="n">t</span><span class="p">)</span>
<span class="c"># Larger example</span>
<span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="p">[(</span><span class="s">'2006-03-28'</span><span class="p">,</span> <span class="s">'BUY'</span><span class="p">,</span> <span class="s">'IBM'</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="mf">45.00</span><span class="p">),</span>
<span class="p">(</span><span class="s">'2006-04-05'</span><span class="p">,</span> <span class="s">'BUY'</span><span class="p">,</span> <span class="s">'MSOFT'</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="mf">72.00</span><span class="p">),</span>
<span class="p">(</span><span class="s">'2006-04-06'</span><span class="p">,</span> <span class="s">'SELL'</span><span class="p">,</span> <span class="s">'IBM'</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span> <span class="mf">53.00</span><span class="p">),</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="s">'insert into stocks values (?,?,?,?,?)'</span><span class="p">,</span> <span class="n">t</span><span class="p">)</span>
</pre></div>
</div>
<p>To retrieve data after executing a SELECT statement, you can either treat the
cursor as an <a class="reference external" href="../glossary.html#term-iterator"><em class="xref">iterator</em></a>, call the cursor’s <a title="sqlite3.Cursor.fetchone" class="reference internal" href="#sqlite3.Cursor.fetchone"><tt class="xref docutils literal"><span class="pre">fetchone()</span></tt></a> method to
retrieve a single matching row, or call <a title="sqlite3.Cursor.fetchall" class="reference internal" href="#sqlite3.Cursor.fetchall"><tt class="xref docutils literal"><span class="pre">fetchall()</span></tt></a> to get a list of the
matching rows.</p>
<p>This example uses the iterator form:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </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="gp">>>> </span><span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'select * from stocks order by price'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">c</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">print</span> <span class="n">row</span>
<span class="gp">...</span>
<span class="go">(u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)</span>
<span class="go">(u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)</span>
<span class="go">(u'2006-04-06', u'SELL', u'IBM', 500, 53.0)</span>
<span class="go">(u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)</span>
<span class="go">>>></span>
</pre></div>
</div>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt><a class="reference external" href="http://www.pysqlite.org">http://www.pysqlite.org</a></dt>
<dd>The pysqlite web page – sqlite3 is developed externally under the name
“pysqlite”.</dd>
<dt><a class="reference external" href="http://www.sqlite.org">http://www.sqlite.org</a></dt>
<dd>The SQLite web page; the documentation describes the syntax and the
available data types for the supported SQL dialect.</dd>
<dt><span class="target" id="index-568"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0249"><strong>PEP 249</strong></a> - Database API Specification 2.0</dt>
<dd>PEP written by Marc-André Lemburg.</dd>
</dl>
</div>
<div class="section" id="module-functions-and-constants">
<span id="sqlite3-module-contents"></span><h2>12.13.1. Module functions and constants<a class="headerlink" href="#module-functions-and-constants" title="Permalink to this headline">¶</a></h2>
<dl class="data">
<dt id="sqlite3.PARSE_DECLTYPES">
<tt class="descclassname">sqlite3.</tt><tt class="descname">PARSE_DECLTYPES</tt><a class="headerlink" href="#sqlite3.PARSE_DECLTYPES" title="Permalink to this definition">¶</a></dt>
<dd><p>This constant is meant to be used with the <em>detect_types</em> parameter of the
<a title="sqlite3.connect" class="reference internal" href="#sqlite3.connect"><tt class="xref docutils literal"><span class="pre">connect()</span></tt></a> function.</p>
<p>Setting it makes the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module parse the declared type for each
column it returns. It will parse out the first word of the declared type,
i. e. for “integer primary key”, it will parse out “integer”, or for
“number(10)” it will parse out “number”. Then for that column, it will look
into the converters dictionary and use the converter function registered for
that type there.</p>
</dd></dl>
<dl class="data">
<dt id="sqlite3.PARSE_COLNAMES">
<tt class="descclassname">sqlite3.</tt><tt class="descname">PARSE_COLNAMES</tt><a class="headerlink" href="#sqlite3.PARSE_COLNAMES" title="Permalink to this definition">¶</a></dt>
<dd><p>This constant is meant to be used with the <em>detect_types</em> parameter of the
<a title="sqlite3.connect" class="reference internal" href="#sqlite3.connect"><tt class="xref docutils literal"><span class="pre">connect()</span></tt></a> function.</p>
<p>Setting this makes the SQLite interface parse the column name for each column it
returns. It will look for a string formed [mytype] in there, and then decide
that ‘mytype’ is the type of the column. It will try to find an entry of
‘mytype’ in the converters dictionary and then use the converter function found
there to return the value. The column name found in <a title="sqlite3.Cursor.description" class="reference internal" href="#sqlite3.Cursor.description"><tt class="xref docutils literal"><span class="pre">Cursor.description</span></tt></a>
is only the first word of the column name, i. e. if you use something like
<tt class="docutils literal"><span class="pre">'as</span> <span class="pre">"x</span> <span class="pre">[datetime]"'</span></tt> in your SQL, then we will parse out everything until the
first blank for the column name: the column name would simply be “x”.</p>
</dd></dl>
<dl class="function">
<dt id="sqlite3.connect">
<tt class="descclassname">sqlite3.</tt><tt class="descname">connect</tt><big>(</big><em>database</em><span class="optional">[</span>, <em>timeout</em>, <em>isolation_level</em>, <em>detect_types</em>, <em>factory</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>Opens a connection to the SQLite database file <em>database</em>. You can use
<tt class="docutils literal"><span class="pre">":memory:"</span></tt> to open a database connection to a database that resides in RAM
instead of on disk.</p>
<p>When a database is accessed by multiple connections, and one of the processes
modifies the database, the SQLite database is locked until that transaction is
committed. The <em>timeout</em> parameter specifies how long the connection should wait
for the lock to go away until raising an exception. The default for the timeout
parameter is 5.0 (five seconds).</p>
<p>For the <em>isolation_level</em> parameter, please see the
<a title="sqlite3.Connection.isolation_level" class="reference internal" href="#sqlite3.Connection.isolation_level"><tt class="xref docutils literal"><span class="pre">Connection.isolation_level</span></tt></a> property of <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> objects.</p>
<p>SQLite natively supports only the types TEXT, INTEGER, FLOAT, BLOB and NULL. If
you want to use other types you must add support for them yourself. The
<em>detect_types</em> parameter and the using custom <strong>converters</strong> registered with the
module-level <a title="sqlite3.register_converter" class="reference internal" href="#sqlite3.register_converter"><tt class="xref docutils literal"><span class="pre">register_converter()</span></tt></a> function allow you to easily do that.</p>
<p><em>detect_types</em> defaults to 0 (i. e. off, no type detection), you can set it to
any combination of <a title="sqlite3.PARSE_DECLTYPES" class="reference internal" href="#sqlite3.PARSE_DECLTYPES"><tt class="xref docutils literal"><span class="pre">PARSE_DECLTYPES</span></tt></a> and <a title="sqlite3.PARSE_COLNAMES" class="reference internal" href="#sqlite3.PARSE_COLNAMES"><tt class="xref docutils literal"><span class="pre">PARSE_COLNAMES</span></tt></a> to turn
type detection on.</p>
<p>By default, the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module uses its <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> class for the
connect call. You can, however, subclass the <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> class and make
<a title="sqlite3.connect" class="reference internal" href="#sqlite3.connect"><tt class="xref docutils literal"><span class="pre">connect()</span></tt></a> use your class instead by providing your class for the <em>factory</em>
parameter.</p>
<p>Consult the section <a class="reference internal" href="#sqlite3-types"><em>SQLite and Python types</em></a> of this manual for details.</p>
<p>The <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module internally uses a statement cache to avoid SQL parsing
overhead. If you want to explicitly set the number of statements that are cached
for the connection, you can set the <em>cached_statements</em> parameter. The currently
implemented default is to cache 100 statements.</p>
</dd></dl>
<dl class="function">
<dt id="sqlite3.register_converter">
<tt class="descclassname">sqlite3.</tt><tt class="descname">register_converter</tt><big>(</big><em>typename</em>, <em>callable</em><big>)</big><a class="headerlink" href="#sqlite3.register_converter" title="Permalink to this definition">¶</a></dt>
<dd>Registers a callable to convert a bytestring from the database into a custom
Python type. The callable will be invoked for all database values that are of
the type <em>typename</em>. Confer the parameter <em>detect_types</em> of the <a title="sqlite3.connect" class="reference internal" href="#sqlite3.connect"><tt class="xref docutils literal"><span class="pre">connect()</span></tt></a>
function for how the type detection works. Note that the case of <em>typename</em> and
the name of the type in your query must match!</dd></dl>
<dl class="function">
<dt id="sqlite3.register_adapter">
<tt class="descclassname">sqlite3.</tt><tt class="descname">register_adapter</tt><big>(</big><em>type</em>, <em>callable</em><big>)</big><a class="headerlink" href="#sqlite3.register_adapter" title="Permalink to this definition">¶</a></dt>
<dd>Registers a callable to convert the custom Python type <em>type</em> into one of
SQLite’s supported types. The callable <em>callable</em> accepts as single parameter
the Python value, and must return a value of the following types: int, long,
float, str (UTF-8 encoded), unicode or buffer.</dd></dl>
<dl class="function">
<dt id="sqlite3.complete_statement">
<tt class="descclassname">sqlite3.</tt><tt class="descname">complete_statement</tt><big>(</big><em>sql</em><big>)</big><a class="headerlink" href="#sqlite3.complete_statement" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <a title="True" class="reference external" href="constants.html#True"><tt class="xref xref docutils literal"><span class="pre">True</span></tt></a> if the string <em>sql</em> contains one or more complete SQL
statements terminated by semicolons. It does not verify that the SQL is
syntactically correct, only that there are no unclosed string literals and the
statement is terminated by a semicolon.</p>
<p>This can be used to build a shell for SQLite, as in the following example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># A minimal SQLite shell for experiments</span>
<span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">isolation_level</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="nb">buffer</span> <span class="o">=</span> <span class="s">""</span>
<span class="k">print</span> <span class="s">"Enter your SQL commands to execute in sqlite3."</span>
<span class="k">print</span> <span class="s">"Enter a blank line to exit."</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">line</span> <span class="o">=</span> <span class="nb">raw_input</span><span class="p">()</span>
<span class="k">if</span> <span class="n">line</span> <span class="o">==</span> <span class="s">""</span><span class="p">:</span>
<span class="k">break</span>
<span class="nb">buffer</span> <span class="o">+=</span> <span class="n">line</span>
<span class="k">if</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">complete_statement</span><span class="p">(</span><span class="nb">buffer</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">buffer</span> <span class="o">=</span> <span class="nb">buffer</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="nb">buffer</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">buffer</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">"SELECT"</span><span class="p">):</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
<span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Error</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">print</span> <span class="s">"An error occurred:"</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="nb">buffer</span> <span class="o">=</span> <span class="s">""</span>
<span class="n">con</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="sqlite3.enable_callback_tracebacks">
<tt class="descclassname">sqlite3.</tt><tt class="descname">enable_callback_tracebacks</tt><big>(</big><em>flag</em><big>)</big><a class="headerlink" href="#sqlite3.enable_callback_tracebacks" title="Permalink to this definition">¶</a></dt>
<dd>By default you will not get any tracebacks in user-defined functions,
aggregates, converters, authorizer callbacks etc. If you want to debug them, you
can call this function with <em>flag</em> as True. Afterwards, you will get tracebacks
from callbacks on <tt class="docutils literal"><span class="pre">sys.stderr</span></tt>. Use <a title="False" class="reference external" href="constants.html#False"><tt class="xref xref docutils literal"><span class="pre">False</span></tt></a> to disable the feature
again.</dd></dl>
</div>
<div class="section" id="connection-objects">
<span id="sqlite3-connection-objects"></span><h2>12.13.2. Connection Objects<a class="headerlink" href="#connection-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="sqlite3.Connection">
<em class="property">class </em><tt class="descclassname">sqlite3.</tt><tt class="descname">Connection</tt><a class="headerlink" href="#sqlite3.Connection" title="Permalink to this definition">¶</a></dt>
<dd>A SQLite database connection has the following attributes and methods:</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Connection.isolation_level">
<tt class="descclassname">Connection.</tt><tt class="descname">isolation_level</tt><a class="headerlink" href="#sqlite3.Connection.isolation_level" title="Permalink to this definition">¶</a></dt>
<dd>Get or set the current isolation level. <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a> for autocommit mode or
one of “DEFERRED”, “IMMEDIATE” or “EXCLUSIVE”. See section
<a class="reference internal" href="#sqlite3-controlling-transactions"><em>Controlling Transactions</em></a> for a more detailed explanation.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.cursor">
<tt class="descclassname">Connection.</tt><tt class="descname">cursor</tt><big>(</big><span class="optional">[</span><em>cursorClass</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.Connection.cursor" title="Permalink to this definition">¶</a></dt>
<dd>The cursor method accepts a single optional parameter <em>cursorClass</em>. If
supplied, this must be a custom cursor class that extends
<a title="sqlite3.Cursor" class="reference internal" href="#sqlite3.Cursor"><tt class="xref docutils literal"><span class="pre">sqlite3.Cursor</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.commit">
<tt class="descclassname">Connection.</tt><tt class="descname">commit</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Connection.commit" title="Permalink to this definition">¶</a></dt>
<dd>This method commits the current transaction. If you don’t call this method,
anything you did since the last call to <tt class="docutils literal"><span class="pre">commit()</span></tt> is not visible from from
other database connections. If you wonder why you don’t see the data you’ve
written to the database, please check you didn’t forget to call this method.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.rollback">
<tt class="descclassname">Connection.</tt><tt class="descname">rollback</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Connection.rollback" title="Permalink to this definition">¶</a></dt>
<dd>This method rolls back any changes to the database since the last call to
<a title="sqlite3.Connection.commit" class="reference internal" href="#sqlite3.Connection.commit"><tt class="xref docutils literal"><span class="pre">commit()</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.close">
<tt class="descclassname">Connection.</tt><tt class="descname">close</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Connection.close" title="Permalink to this definition">¶</a></dt>
<dd>This closes the database connection. Note that this does not automatically
call <a title="sqlite3.Connection.commit" class="reference internal" href="#sqlite3.Connection.commit"><tt class="xref docutils literal"><span class="pre">commit()</span></tt></a>. If you just close your database connection without
calling <a title="sqlite3.Connection.commit" class="reference internal" href="#sqlite3.Connection.commit"><tt class="xref docutils literal"><span class="pre">commit()</span></tt></a> first, your changes will be lost!</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.execute">
<tt class="descclassname">Connection.</tt><tt class="descname">execute</tt><big>(</big><em>sql</em><span class="optional">[</span>, <em>parameters</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.Connection.execute" title="Permalink to this definition">¶</a></dt>
<dd>This is a nonstandard shortcut that creates an intermediate cursor object by
calling the cursor method, then calls the cursor’s
<a title="sqlite3.Cursor.execute" class="reference internal" href="#sqlite3.Cursor.execute"><tt class="xref docutils literal"><span class="pre">execute</span></tt></a> method with the parameters given.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.executemany">
<tt class="descclassname">Connection.</tt><tt class="descname">executemany</tt><big>(</big><em>sql</em><span class="optional">[</span>, <em>parameters</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.Connection.executemany" title="Permalink to this definition">¶</a></dt>
<dd>This is a nonstandard shortcut that creates an intermediate cursor object by
calling the cursor method, then calls the cursor’s
<a title="sqlite3.Cursor.executemany" class="reference internal" href="#sqlite3.Cursor.executemany"><tt class="xref docutils literal"><span class="pre">executemany</span></tt></a> method with the parameters given.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.executescript">
<tt class="descclassname">Connection.</tt><tt class="descname">executescript</tt><big>(</big><em>sql_script</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.executescript" title="Permalink to this definition">¶</a></dt>
<dd>This is a nonstandard shortcut that creates an intermediate cursor object by
calling the cursor method, then calls the cursor’s
<a title="sqlite3.Cursor.executescript" class="reference internal" href="#sqlite3.Cursor.executescript"><tt class="xref docutils literal"><span class="pre">executescript</span></tt></a> method with the parameters
given.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.create_function">
<tt class="descclassname">Connection.</tt><tt class="descname">create_function</tt><big>(</big><em>name</em>, <em>num_params</em>, <em>func</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.create_function" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a user-defined function that you can later use from within SQL
statements under the function name <em>name</em>. <em>num_params</em> is the number of
parameters the function accepts, and <em>func</em> is a Python callable that is called
as the SQL function.</p>
<p>The function can return any of the types supported by SQLite: unicode, str, int,
long, float, buffer and None.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="kn">import</span> <span class="nn">md5</span>
<span class="k">def</span> <span class="nf">md5sum</span><span class="p">(</span><span class="n">t</span><span class="p">):</span>
<span class="k">return</span> <span class="n">md5</span><span class="o">.</span><span class="n">md5</span><span class="p">(</span><span class="n">t</span><span class="p">)</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">create_function</span><span class="p">(</span><span class="s">"md5"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">md5sum</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select md5(?)"</span><span class="p">,</span> <span class="p">(</span><span class="s">"foo"</span><span class="p">,))</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.create_aggregate">
<tt class="descclassname">Connection.</tt><tt class="descname">create_aggregate</tt><big>(</big><em>name</em>, <em>num_params</em>, <em>aggregate_class</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.create_aggregate" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a user-defined aggregate function.</p>
<p>The aggregate class must implement a <tt class="docutils literal"><span class="pre">step</span></tt> method, which accepts the number
of parameters <em>num_params</em>, and a <tt class="docutils literal"><span class="pre">finalize</span></tt> method which will return the
final result of the aggregate.</p>
<p>The <tt class="docutils literal"><span class="pre">finalize</span></tt> method can return any of the types supported by SQLite:
unicode, str, int, long, float, buffer and None.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">class</span> <span class="nc">MySum</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="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">def</span> <span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">+=</span> <span class="n">value</span>
<span class="k">def</span> <span class="nf">finalize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">create_aggregate</span><span class="p">(</span><span class="s">"mysum"</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">MySum</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table test(i)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into test(i) values (1)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into test(i) values (2)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select mysum(i) from test"</span><span class="p">)</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.create_collation">
<tt class="descclassname">Connection.</tt><tt class="descname">create_collation</tt><big>(</big><em>name</em>, <em>callable</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.create_collation" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a collation with the specified <em>name</em> and <em>callable</em>. The callable will
be passed two string arguments. It should return -1 if the first is ordered
lower than the second, 0 if they are ordered equal and 1 if the first is ordered
higher than the second. Note that this controls sorting (ORDER BY in SQL) so
your comparisons don’t affect other SQL operations.</p>
<p>Note that the callable will get its parameters as Python bytestrings, which will
normally be encoded in UTF-8.</p>
<p>The following example shows a custom collation that sorts “the wrong way”:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">def</span> <span class="nf">collate_reverse</span><span class="p">(</span><span class="n">string1</span><span class="p">,</span> <span class="n">string2</span><span class="p">):</span>
<span class="k">return</span> <span class="o">-</span><span class="nb">cmp</span><span class="p">(</span><span class="n">string1</span><span class="p">,</span> <span class="n">string2</span><span class="p">)</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">create_collation</span><span class="p">(</span><span class="s">"reverse"</span><span class="p">,</span> <span class="n">collate_reverse</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table test(x)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="s">"insert into test(x) values (?)"</span><span class="p">,</span> <span class="p">[(</span><span class="s">"a"</span><span class="p">,),</span> <span class="p">(</span><span class="s">"b"</span><span class="p">,)])</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select x from test order by x collate reverse"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="p">:</span>
<span class="k">print</span> <span class="n">row</span>
<span class="n">con</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>To remove a collation, call <tt class="docutils literal"><span class="pre">create_collation</span></tt> with None as callable:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">con</span><span class="o">.</span><span class="n">create_collation</span><span class="p">(</span><span class="s">"reverse"</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.interrupt">
<tt class="descclassname">Connection.</tt><tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Connection.interrupt" title="Permalink to this definition">¶</a></dt>
<dd>You can call this method from a different thread to abort any queries that might
be executing on the connection. The query will then abort and the caller will
get an exception.</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.set_authorizer">
<tt class="descclassname">Connection.</tt><tt class="descname">set_authorizer</tt><big>(</big><em>authorizer_callback</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.set_authorizer" title="Permalink to this definition">¶</a></dt>
<dd><p>This routine registers a callback. The callback is invoked for each attempt to
access a column of a table in the database. The callback should return
<tt class="xref docutils literal"><span class="pre">SQLITE_OK</span></tt> if access is allowed, <tt class="xref docutils literal"><span class="pre">SQLITE_DENY</span></tt> if the entire SQL
statement should be aborted with an error and <tt class="xref docutils literal"><span class="pre">SQLITE_IGNORE</span></tt> if the
column should be treated as a NULL value. These constants are available in the
<tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module.</p>
<p>The first argument to the callback signifies what kind of operation is to be
authorized. The second and third argument will be arguments or <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>
depending on the first argument. The 4th argument is the name of the database
(“main”, “temp”, etc.) if applicable. The 5th argument is the name of the
inner-most trigger or view that is responsible for the access attempt or
<a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a> if this access attempt is directly from input SQL code.</p>
<p>Please consult the SQLite documentation about the possible values for the first
argument and the meaning of the second and third argument depending on the first
one. All necessary constants are available in the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module.</p>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Connection.set_progress_handler">
<tt class="descclassname">Connection.</tt><tt class="descname">set_progress_handler</tt><big>(</big><em>handler</em>, <em>n</em><big>)</big><a class="headerlink" href="#sqlite3.Connection.set_progress_handler" title="Permalink to this definition">¶</a></dt>
<dd><p class="versionadded">
<span class="versionmodified">New in version 2.6.</span></p>
<p>This routine registers a callback. The callback is invoked for every <em>n</em>
instructions of the SQLite virtual machine. This is useful if you want to
get called from SQLite during long-running operations, for example to update
a GUI.</p>
<p>If you want to clear any previously installed progress handler, call the
method with <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a> for <em>handler</em>.</p>
</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Connection.row_factory">
<tt class="descclassname">Connection.</tt><tt class="descname">row_factory</tt><a class="headerlink" href="#sqlite3.Connection.row_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>You can change this attribute to a callable that accepts the cursor and the
original row as a tuple and will return the real result row. This way, you can
implement more advanced ways of returning results, such as returning an object
that can also access columns by name.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">def</span> <span class="nf">dict_factory</span><span class="p">(</span><span class="n">cursor</span><span class="p">,</span> <span class="n">row</span><span class="p">):</span>
<span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">col</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">cursor</span><span class="o">.</span><span class="n">description</span><span class="p">):</span>
<span class="n">d</span><span class="p">[</span><span class="n">col</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span>
<span class="k">return</span> <span class="n">d</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">row_factory</span> <span class="o">=</span> <span class="n">dict_factory</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select 1 as a"</span><span class="p">)</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="s">"a"</span><span class="p">]</span>
</pre></div>
</div>
<p>If returning a tuple doesn’t suffice and you want name-based access to
columns, you should consider setting <a title="sqlite3.Connection.row_factory" class="reference internal" href="#sqlite3.Connection.row_factory"><tt class="xref docutils literal"><span class="pre">row_factory</span></tt></a> to the
highly-optimized <a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">sqlite3.Row</span></tt></a> type. <a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">Row</span></tt></a> provides both
index-based and case-insensitive name-based access to columns with almost no
memory overhead. It will probably be better than your own custom
dictionary-based approach or even a db_row based solution.</p>
</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Connection.text_factory">
<tt class="descclassname">Connection.</tt><tt class="descname">text_factory</tt><a class="headerlink" href="#sqlite3.Connection.text_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Using this attribute you can control what objects are returned for the <tt class="docutils literal"><span class="pre">TEXT</span></tt>
data type. By default, this attribute is set to <a title="unicode" class="reference external" href="functions.html#unicode"><tt class="xref docutils literal"><span class="pre">unicode</span></tt></a> and the
<tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module will return Unicode objects for <tt class="docutils literal"><span class="pre">TEXT</span></tt>. If you want to
return bytestrings instead, you can set it to <a title="str" class="reference external" href="functions.html#str"><tt class="xref docutils literal"><span class="pre">str</span></tt></a>.</p>
<p>For efficiency reasons, there’s also a way to return Unicode objects only for
non-ASCII data, and bytestrings otherwise. To activate it, set this attribute to
<tt class="xref docutils literal"><span class="pre">sqlite3.OptimizedUnicode</span></tt>.</p>
<p>You can also set it to any other callable that accepts a single bytestring
parameter and returns the resulting object.</p>
<p>See the following example code for illustration:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="c"># Create the table</span>
<span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table person(lastname, firstname)"</span><span class="p">)</span>
<span class="n">AUSTRIA</span> <span class="o">=</span> <span class="s">u"</span><span class="se">\xd6</span><span class="s">sterreich"</span>
<span class="c"># by default, rows are returned as Unicode</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">AUSTRIA</span><span class="p">,))</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">AUSTRIA</span>
<span class="c"># but we can make sqlite3 always return bytestrings ...</span>
<span class="n">con</span><span class="o">.</span><span class="n">text_factory</span> <span class="o">=</span> <span class="nb">str</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">AUSTRIA</span><span class="p">,))</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="nb">str</span>
<span class="c"># the bytestrings will be encoded in UTF-8, unless you stored garbage in the</span>
<span class="c"># database ...</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">AUSTRIA</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">"utf-8"</span><span class="p">)</span>
<span class="c"># we can also implement a custom text_factory ...</span>
<span class="c"># here we implement one that will ignore Unicode characters that cannot be</span>
<span class="c"># decoded from UTF-8</span>
<span class="n">con</span><span class="o">.</span><span class="n">text_factory</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="s">"utf-8"</span><span class="p">,</span> <span class="s">"ignore"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="s">"this is latin1 and would normally create errors"</span> <span class="o">+</span>
<span class="s">u"</span><span class="se">\xe4\xf6\xfc</span><span class="s">"</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">"latin1"</span><span class="p">),))</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="nb">unicode</span>
<span class="c"># sqlite3 offers a built-in optimized text_factory that will return bytestring</span>
<span class="c"># objects, if the data is in ASCII only, and otherwise return unicode objects</span>
<span class="n">con</span><span class="o">.</span><span class="n">text_factory</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">OptimizedUnicode</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">AUSTRIA</span><span class="p">,))</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="nb">unicode</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="s">"Germany"</span><span class="p">,))</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">==</span> <span class="nb">str</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Connection.total_changes">
<tt class="descclassname">Connection.</tt><tt class="descname">total_changes</tt><a class="headerlink" href="#sqlite3.Connection.total_changes" title="Permalink to this definition">¶</a></dt>
<dd>Returns the total number of database rows that have been modified, inserted, or
deleted since the database connection was opened.</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Connection.iterdump">
<tt class="descclassname">Connection.</tt><tt class="descname">iterdump</tt><a class="headerlink" href="#sqlite3.Connection.iterdump" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an iterator to dump the database in an SQL text format. Useful when
saving an in-memory database for later restoration. This function provides
the same capabilities as the <tt class="docutils literal"><span class="pre">.dump</span></tt> command in the <strong>sqlite3</strong>
shell.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.6.</span></p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># Convert file existing_db.db to SQL dump file dump.sql</span>
<span class="kn">import</span> <span class="nn">sqlite3</span><span class="o">,</span> <span class="nn">os</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">'existing_db.db'</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s">'dump.sql'</span><span class="p">,</span> <span class="s">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">con</span><span class="o">.</span><span class="n">iterdump</span><span class="p">():</span>
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
<div class="section" id="cursor-objects">
<span id="sqlite3-cursor-objects"></span><h2>12.13.3. Cursor Objects<a class="headerlink" href="#cursor-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="sqlite3.Cursor">
<em class="property">class </em><tt class="descclassname">sqlite3.</tt><tt class="descname">Cursor</tt><a class="headerlink" href="#sqlite3.Cursor" title="Permalink to this definition">¶</a></dt>
<dd>A SQLite database cursor has the following attributes and methods:</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.execute">
<tt class="descclassname">Cursor.</tt><tt class="descname">execute</tt><big>(</big><em>sql</em><span class="optional">[</span>, <em>parameters</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.Cursor.execute" title="Permalink to this definition">¶</a></dt>
<dd><p>Executes an SQL statement. The SQL statement may be parametrized (i. e.
placeholders instead of SQL literals). The <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module supports two
kinds of placeholders: question marks (qmark style) and named placeholders
(named style).</p>
<p>This example shows how to use parameters with qmark style:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">"mydb"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">who</span> <span class="o">=</span> <span class="s">"Yeltsin"</span>
<span class="n">age</span> <span class="o">=</span> <span class="mi">72</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select name_last, age from people where name_last=? and age=?"</span><span class="p">,</span> <span class="p">(</span><span class="n">who</span><span class="p">,</span> <span class="n">age</span><span class="p">))</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
</pre></div>
</div>
<p>This example shows how to use the named style:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">"mydb"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">who</span> <span class="o">=</span> <span class="s">"Yeltsin"</span>
<span class="n">age</span> <span class="o">=</span> <span class="mi">72</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select name_last, age from people where name_last=:who and age=:age"</span><span class="p">,</span>
<span class="p">{</span><span class="s">"who"</span><span class="p">:</span> <span class="n">who</span><span class="p">,</span> <span class="s">"age"</span><span class="p">:</span> <span class="n">age</span><span class="p">})</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
</pre></div>
</div>
<p><a title="sqlite3.Cursor.execute" class="reference internal" href="#sqlite3.Cursor.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a> will only execute a single SQL statement. If you try to execute
more than one statement with it, it will raise a Warning. Use
<a title="sqlite3.Cursor.executescript" class="reference internal" href="#sqlite3.Cursor.executescript"><tt class="xref docutils literal"><span class="pre">executescript()</span></tt></a> if you want to execute multiple SQL statements with one
call.</p>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.executemany">
<tt class="descclassname">Cursor.</tt><tt class="descname">executemany</tt><big>(</big><em>sql</em>, <em>seq_of_parameters</em><big>)</big><a class="headerlink" href="#sqlite3.Cursor.executemany" title="Permalink to this definition">¶</a></dt>
<dd><p>Executes an SQL command against all parameter sequences or mappings found in
the sequence <em>sql</em>. The <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module also allows using an
<a class="reference external" href="../glossary.html#term-iterator"><em class="xref">iterator</em></a> yielding parameters instead of a sequence.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">class</span> <span class="nc">IterChars</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="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">=</span> <span class="nb">ord</span><span class="p">(</span><span class="s">'a'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">></span> <span class="nb">ord</span><span class="p">(</span><span class="s">'z'</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">StopIteration</span>
<span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="p">(</span><span class="nb">chr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">count</span> <span class="o">-</span> <span class="mi">1</span><span class="p">),)</span> <span class="c"># this is a 1-tuple</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table characters(c)"</span><span class="p">)</span>
<span class="n">theIter</span> <span class="o">=</span> <span class="n">IterChars</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="s">"insert into characters(c) values (?)"</span><span class="p">,</span> <span class="n">theIter</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select c from characters"</span><span class="p">)</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
</pre></div>
</div>
<p>Here’s a shorter example using a <a class="reference external" href="../glossary.html#term-generator"><em class="xref">generator</em></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">def</span> <span class="nf">char_generator</span><span class="p">():</span>
<span class="kn">import</span> <span class="nn">string</span>
<span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">string</span><span class="o">.</span><span class="n">letters</span><span class="p">[:</span><span class="mi">26</span><span class="p">]:</span>
<span class="k">yield</span> <span class="p">(</span><span class="n">c</span><span class="p">,)</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table characters(c)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="s">"insert into characters(c) values (?)"</span><span class="p">,</span> <span class="n">char_generator</span><span class="p">())</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select c from characters"</span><span class="p">)</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.executescript">
<tt class="descclassname">Cursor.</tt><tt class="descname">executescript</tt><big>(</big><em>sql_script</em><big>)</big><a class="headerlink" href="#sqlite3.Cursor.executescript" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a nonstandard convenience method for executing multiple SQL statements
at once. It issues a <tt class="docutils literal"><span class="pre">COMMIT</span></tt> statement first, then executes the SQL script it
gets as a parameter.</p>
<p><em>sql_script</em> can be a bytestring or a Unicode string.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">executescript</span><span class="p">(</span><span class="s">"""</span>
<span class="s"> create table person(</span>
<span class="s"> firstname,</span>
<span class="s"> lastname,</span>
<span class="s"> age</span>
<span class="s"> );</span>
<span class="s"> create table book(</span>
<span class="s"> title,</span>
<span class="s"> author,</span>
<span class="s"> published</span>
<span class="s"> );</span>
<span class="s"> insert into book(title, author, published)</span>
<span class="s"> values (</span>
<span class="s"> 'Dirk Gently''s Holistic Detective Agency',</span>
<span class="s"> 'Douglas Adams',</span>
<span class="s"> 1987</span>
<span class="s"> );</span>
<span class="s"> """</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.fetchone">
<tt class="descclassname">Cursor.</tt><tt class="descname">fetchone</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Cursor.fetchone" title="Permalink to this definition">¶</a></dt>
<dd>Fetches the next row of a query result set, returning a single sequence,
or <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a> when no more data is available.</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.fetchmany">
<tt class="descclassname">Cursor.</tt><tt class="descname">fetchmany</tt><big>(</big><span class="optional">[</span><em>size=cursor.arraysize</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#sqlite3.Cursor.fetchmany" title="Permalink to this definition">¶</a></dt>
<dd><p>Fetches the next set of rows of a query result, returning a list. An empty
list is returned when no more rows are available.</p>
<p>The number of rows to fetch per call is specified by the <em>size</em> parameter.
If it is not given, the cursor’s arraysize determines the number of rows
to be fetched. The method should try to fetch as many rows as indicated by
the size parameter. If this is not possible due to the specified number of
rows not being available, fewer rows may be returned.</p>
<p>Note there are performance considerations involved with the <em>size</em> parameter.
For optimal performance, it is usually best to use the arraysize attribute.
If the <em>size</em> parameter is used, then it is best for it to retain the same
value from one <a title="sqlite3.Cursor.fetchmany" class="reference internal" href="#sqlite3.Cursor.fetchmany"><tt class="xref docutils literal"><span class="pre">fetchmany()</span></tt></a> call to the next.</p>
</dd></dl>
<dl class="method">
<dt id="sqlite3.Cursor.fetchall">
<tt class="descclassname">Cursor.</tt><tt class="descname">fetchall</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Cursor.fetchall" title="Permalink to this definition">¶</a></dt>
<dd>Fetches all (remaining) rows of a query result, returning a list. Note that
the cursor’s arraysize attribute can affect the performance of this operation.
An empty list is returned when no rows are available.</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Cursor.rowcount">
<tt class="descclassname">Cursor.</tt><tt class="descname">rowcount</tt><a class="headerlink" href="#sqlite3.Cursor.rowcount" title="Permalink to this definition">¶</a></dt>
<dd><p>Although the <a title="sqlite3.Cursor" class="reference internal" href="#sqlite3.Cursor"><tt class="xref docutils literal"><span class="pre">Cursor</span></tt></a> class of the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module implements this
attribute, the database engine’s own support for the determination of “rows
affected”/”rows selected” is quirky.</p>
<p>For <tt class="docutils literal"><span class="pre">DELETE</span></tt> statements, SQLite reports <a title="sqlite3.Cursor.rowcount" class="reference internal" href="#sqlite3.Cursor.rowcount"><tt class="xref docutils literal"><span class="pre">rowcount</span></tt></a> as 0 if you make a
<tt class="docutils literal"><span class="pre">DELETE</span> <span class="pre">FROM</span> <span class="pre">table</span></tt> without any condition.</p>
<p>For <a title="sqlite3.Cursor.executemany" class="reference internal" href="#sqlite3.Cursor.executemany"><tt class="xref docutils literal"><span class="pre">executemany()</span></tt></a> statements, the number of modifications are summed up
into <a title="sqlite3.Cursor.rowcount" class="reference internal" href="#sqlite3.Cursor.rowcount"><tt class="xref docutils literal"><span class="pre">rowcount</span></tt></a>.</p>
<p>As required by the Python DB API Spec, the <a title="sqlite3.Cursor.rowcount" class="reference internal" href="#sqlite3.Cursor.rowcount"><tt class="xref docutils literal"><span class="pre">rowcount</span></tt></a> attribute “is -1 in
case no <tt class="docutils literal"><span class="pre">executeXX()</span></tt> has been performed on the cursor or the rowcount of the
last operation is not determinable by the interface”.</p>
<p>This includes <tt class="docutils literal"><span class="pre">SELECT</span></tt> statements because we cannot determine the number of
rows a query produced until all rows were fetched.</p>
</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Cursor.lastrowid">
<tt class="descclassname">Cursor.</tt><tt class="descname">lastrowid</tt><a class="headerlink" href="#sqlite3.Cursor.lastrowid" title="Permalink to this definition">¶</a></dt>
<dd>This read-only attribute provides the rowid of the last modified row. It is
only set if you issued a <tt class="docutils literal"><span class="pre">INSERT</span></tt> statement using the <a title="sqlite3.Cursor.execute" class="reference internal" href="#sqlite3.Cursor.execute"><tt class="xref docutils literal"><span class="pre">execute()</span></tt></a>
method. For operations other than <tt class="docutils literal"><span class="pre">INSERT</span></tt> or when <a title="sqlite3.Cursor.executemany" class="reference internal" href="#sqlite3.Cursor.executemany"><tt class="xref docutils literal"><span class="pre">executemany()</span></tt></a> is
called, <a title="sqlite3.Cursor.lastrowid" class="reference internal" href="#sqlite3.Cursor.lastrowid"><tt class="xref docutils literal"><span class="pre">lastrowid</span></tt></a> is set to <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>.</dd></dl>
<dl class="attribute">
<dt id="sqlite3.Cursor.description">
<tt class="descclassname">Cursor.</tt><tt class="descname">description</tt><a class="headerlink" href="#sqlite3.Cursor.description" title="Permalink to this definition">¶</a></dt>
<dd><p>This read-only attribute provides the column names of the last query. To
remain compatible with the Python DB API, it returns a 7-tuple for each
column where the last six items of each tuple are <a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a>.</p>
<p>It is set for <tt class="docutils literal"><span class="pre">SELECT</span></tt> statements without any matching rows as well.</p>
</dd></dl>
</div>
<div class="section" id="row-objects">
<span id="sqlite3-row-objects"></span><h2>12.13.4. Row Objects<a class="headerlink" href="#row-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="sqlite3.Row">
<em class="property">class </em><tt class="descclassname">sqlite3.</tt><tt class="descname">Row</tt><a class="headerlink" href="#sqlite3.Row" title="Permalink to this definition">¶</a></dt>
<dd><p>A <a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">Row</span></tt></a> instance serves as a highly optimized
<a title="sqlite3.Connection.row_factory" class="reference internal" href="#sqlite3.Connection.row_factory"><tt class="xref docutils literal"><span class="pre">row_factory</span></tt></a> for <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> objects.
It tries to mimic a tuple in most of its features.</p>
<p>It supports mapping access by column name and index, iteration,
representation, equality testing and <a title="len" class="reference external" href="functions.html#len"><tt class="xref docutils literal"><span class="pre">len()</span></tt></a>.</p>
<p>If two <a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">Row</span></tt></a> objects have exactly the same columns and their
members are equal, they compare equal.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.6: </span>Added iteration and equality (hashability).</p>
<dl class="method">
<dt id="sqlite3.Row.keys">
<tt class="descname">keys</tt><big>(</big><big>)</big><a class="headerlink" href="#sqlite3.Row.keys" title="Permalink to this definition">¶</a></dt>
<dd><p>This method returns a tuple of column names. Immediately after a query,
it is the first member of each tuple in <a title="sqlite3.Cursor.description" class="reference internal" href="#sqlite3.Cursor.description"><tt class="xref docutils literal"><span class="pre">Cursor.description</span></tt></a>.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.6.</span></p>
</dd></dl>
</dd></dl>
<p>Let’s assume we initialize a table as in the example given above:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">conn</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</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="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'''create table stocks</span>
<span class="s">(date text, trans text, symbol text,</span>
<span class="s"> qty real, price real)'''</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="s">"""insert into stocks</span>
<span class="s"> values ('2006-01-05','BUY','RHAT',100,35.14)"""</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="n">c</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
<p>Now we plug <a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">Row</span></tt></a> in:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">conn</span><span class="o">.</span><span class="n">row_factory</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Row</span>
<span class="gp">>>> </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="gp">>>> </span><span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'select * from stocks'</span><span class="p">)</span>
<span class="go"><sqlite3.Cursor object at 0x7f4e7dd8fa80></span>
<span class="gp">>>> </span><span class="n">r</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="gp">>>> </span><span class="nb">type</span><span class="p">(</span><span class="n">r</span><span class="p">)</span>
<span class="go"><type 'sqlite3.Row'></span>
<span class="gp">>>> </span><span class="n">r</span>
<span class="go">(u'2006-01-05', u'BUY', u'RHAT', 100.0, 35.140000000000001)</span>
<span class="gp">>>> </span><span class="nb">len</span><span class="p">(</span><span class="n">r</span><span class="p">)</span>
<span class="go">5</span>
<span class="gp">>>> </span><span class="n">r</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="go">u'RHAT'</span>
<span class="gp">>>> </span><span class="n">r</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="go">['date', 'trans', 'symbol', 'qty', 'price']</span>
<span class="gp">>>> </span><span class="n">r</span><span class="p">[</span><span class="s">'qty'</span><span class="p">]</span>
<span class="go">100.0</span>
<span class="gp">>>> </span><span class="k">for</span> <span class="n">member</span> <span class="ow">in</span> <span class="n">r</span><span class="p">:</span> <span class="k">print</span> <span class="n">member</span>
<span class="gp">...</span>
<span class="go">2006-01-05</span>
<span class="go">BUY</span>
<span class="go">RHAT</span>
<span class="go">100.0</span>
<span class="go">35.14</span>
</pre></div>
</div>
</div>
<div class="section" id="sqlite-and-python-types">
<span id="sqlite3-types"></span><h2>12.13.5. SQLite and Python types<a class="headerlink" href="#sqlite-and-python-types" title="Permalink to this headline">¶</a></h2>
<div class="section" id="introduction">
<h3>12.13.5.1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h3>
<p>SQLite natively supports the following types: <tt class="docutils literal"><span class="pre">NULL</span></tt>, <tt class="docutils literal"><span class="pre">INTEGER</span></tt>,
<tt class="docutils literal"><span class="pre">REAL</span></tt>, <tt class="docutils literal"><span class="pre">TEXT</span></tt>, <tt class="docutils literal"><span class="pre">BLOB</span></tt>.</p>
<p>The following Python types can thus be sent to SQLite without any problem:</p>
<table border="1" class="docutils">
<colgroup>
<col width="69%" />
<col width="31%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Python type</th>
<th class="head">SQLite type</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">NULL</span></tt></td>
</tr>
<tr><td><a title="int" class="reference external" href="functions.html#int"><tt class="xref docutils literal"><span class="pre">int</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">INTEGER</span></tt></td>
</tr>
<tr><td><a title="long" class="reference external" href="functions.html#long"><tt class="xref docutils literal"><span class="pre">long</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">INTEGER</span></tt></td>
</tr>
<tr><td><a title="float" class="reference external" href="functions.html#float"><tt class="xref docutils literal"><span class="pre">float</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">REAL</span></tt></td>
</tr>
<tr><td><a title="str" class="reference external" href="functions.html#str"><tt class="xref docutils literal"><span class="pre">str</span></tt></a> (UTF8-encoded)</td>
<td><tt class="docutils literal"><span class="pre">TEXT</span></tt></td>
</tr>
<tr><td><a title="unicode" class="reference external" href="functions.html#unicode"><tt class="xref docutils literal"><span class="pre">unicode</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">TEXT</span></tt></td>
</tr>
<tr><td><a title="buffer" class="reference external" href="functions.html#buffer"><tt class="xref docutils literal"><span class="pre">buffer</span></tt></a></td>
<td><tt class="docutils literal"><span class="pre">BLOB</span></tt></td>
</tr>
</tbody>
</table>
<p>This is how SQLite types are converted to Python types by default:</p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
<col width="78%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">SQLite type</th>
<th class="head">Python type</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal"><span class="pre">NULL</span></tt></td>
<td><a title="None" class="reference external" href="constants.html#None"><tt class="xref xref docutils literal"><span class="pre">None</span></tt></a></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">INTEGER</span></tt></td>
<td><a title="int" class="reference external" href="functions.html#int"><tt class="xref docutils literal"><span class="pre">int</span></tt></a> or <a title="long" class="reference external" href="functions.html#long"><tt class="xref docutils literal"><span class="pre">long</span></tt></a>,
depending on size</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">REAL</span></tt></td>
<td><a title="float" class="reference external" href="functions.html#float"><tt class="xref docutils literal"><span class="pre">float</span></tt></a></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">TEXT</span></tt></td>
<td>depends on <a title="sqlite3.Connection.text_factory" class="reference internal" href="#sqlite3.Connection.text_factory"><tt class="xref docutils literal"><span class="pre">text_factory</span></tt></a>,
<a title="unicode" class="reference external" href="functions.html#unicode"><tt class="xref docutils literal"><span class="pre">unicode</span></tt></a> by default</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">BLOB</span></tt></td>
<td><a title="buffer" class="reference external" href="functions.html#buffer"><tt class="xref docutils literal"><span class="pre">buffer</span></tt></a></td>
</tr>
</tbody>
</table>
<p>The type system of the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module is extensible in two ways: you can
store additional Python types in a SQLite database via object adaptation, and
you can let the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module convert SQLite types to different Python
types via converters.</p>
</div>
<div class="section" id="using-adapters-to-store-additional-python-types-in-sqlite-databases">
<h3>12.13.5.2. Using adapters to store additional Python types in SQLite databases<a class="headerlink" href="#using-adapters-to-store-additional-python-types-in-sqlite-databases" title="Permalink to this headline">¶</a></h3>
<p>As described before, SQLite supports only a limited set of types natively. To
use other Python types with SQLite, you must <strong>adapt</strong> them to one of the
sqlite3 module’s supported types for SQLite: one of NoneType, int, long, float,
str, unicode, buffer.</p>
<p>The <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module uses Python object adaptation, as described in
<span class="target" id="index-569"></span><a class="reference external" href="http://www.python.org/dev/peps/pep-0246"><strong>PEP 246</strong></a> for this. The protocol to use is <tt class="xref docutils literal"><span class="pre">PrepareProtocol</span></tt>.</p>
<p>There are two ways to enable the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module to adapt a custom Python
type to one of the supported ones.</p>
<div class="section" id="letting-your-object-adapt-itself">
<h4>12.13.5.2.1. Letting your object adapt itself<a class="headerlink" href="#letting-your-object-adapt-itself" title="Permalink to this headline">¶</a></h4>
<p>This is a good approach if you write the class yourself. Let’s suppose you have
a class like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Point</span><span class="p">(</span><span class="nb">object</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">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span> <span class="o">=</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
</pre></div>
</div>
<p>Now you want to store the point in a single SQLite column. First you’ll have to
choose one of the supported types first to be used for representing the point.
Let’s just use str and separate the coordinates using a semicolon. Then you need
to give your class a method <tt class="docutils literal"><span class="pre">__conform__(self,</span> <span class="pre">protocol)</span></tt> which must return
the converted value. The parameter <em>protocol</em> will be <tt class="xref docutils literal"><span class="pre">PrepareProtocol</span></tt>.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">class</span> <span class="nc">Point</span><span class="p">(</span><span class="nb">object</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">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span> <span class="o">=</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<span class="k">def</span> <span class="nf">__conform__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">protocol</span><span class="p">):</span>
<span class="k">if</span> <span class="n">protocol</span> <span class="ow">is</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">PrepareProtocol</span><span class="p">:</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%f</span><span class="s">;</span><span class="si">%f</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span><span class="p">)</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">Point</span><span class="p">(</span><span class="mf">4.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">3.2</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">p</span><span class="p">,))</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="registering-an-adapter-callable">
<h4>12.13.5.2.2. Registering an adapter callable<a class="headerlink" href="#registering-an-adapter-callable" title="Permalink to this headline">¶</a></h4>
<p>The other possibility is to create a function that converts the type to the
string representation and register the function with <a title="sqlite3.register_adapter" class="reference internal" href="#sqlite3.register_adapter"><tt class="xref docutils literal"><span class="pre">register_adapter()</span></tt></a>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The type/class to adapt must be a <a class="reference external" href="../glossary.html#term-new-style-class"><em class="xref">new-style class</em></a>, i. e. it must have
<a title="object" class="reference external" href="functions.html#object"><tt class="xref docutils literal"><span class="pre">object</span></tt></a> as one of its bases.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">class</span> <span class="nc">Point</span><span class="p">(</span><span class="nb">object</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">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span> <span class="o">=</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<span class="k">def</span> <span class="nf">adapt_point</span><span class="p">(</span><span class="n">point</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%f</span><span class="s">;</span><span class="si">%f</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">point</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">point</span><span class="o">.</span><span class="n">y</span><span class="p">)</span>
<span class="n">sqlite3</span><span class="o">.</span><span class="n">register_adapter</span><span class="p">(</span><span class="n">Point</span><span class="p">,</span> <span class="n">adapt_point</span><span class="p">)</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">Point</span><span class="p">(</span><span class="mf">4.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">3.2</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">p</span><span class="p">,))</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
<p>The <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module has two default adapters for Python’s built-in
<a title="datetime.date" class="reference external" href="datetime.html#datetime.date"><tt class="xref docutils literal"><span class="pre">datetime.date</span></tt></a> and <a title="datetime.datetime" class="reference external" href="datetime.html#datetime.datetime"><tt class="xref docutils literal"><span class="pre">datetime.datetime</span></tt></a> types. Now let’s suppose
we want to store <a title="datetime.datetime" class="reference external" href="datetime.html#datetime.datetime"><tt class="xref docutils literal"><span class="pre">datetime.datetime</span></tt></a> objects not in ISO representation,
but as a Unix timestamp.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="kn">import</span> <span class="nn">datetime</span><span class="o">,</span> <span class="nn">time</span>
<span class="k">def</span> <span class="nf">adapt_datetime</span><span class="p">(</span><span class="n">ts</span><span class="p">):</span>
<span class="k">return</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">ts</span><span class="o">.</span><span class="n">timetuple</span><span class="p">())</span>
<span class="n">sqlite3</span><span class="o">.</span><span class="n">register_adapter</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="n">adapt_datetime</span><span class="p">)</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">now</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select ?"</span><span class="p">,</span> <span class="p">(</span><span class="n">now</span><span class="p">,))</span>
<span class="k">print</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="converting-sqlite-values-to-custom-python-types">
<h3>12.13.5.3. Converting SQLite values to custom Python types<a class="headerlink" href="#converting-sqlite-values-to-custom-python-types" title="Permalink to this headline">¶</a></h3>
<p>Writing an adapter lets you send custom Python types to SQLite. But to make it
really useful we need to make the Python to SQLite to Python roundtrip work.</p>
<p>Enter converters.</p>
<p>Let’s go back to the <tt class="xref docutils literal"><span class="pre">Point</span></tt> class. We stored the x and y coordinates
separated via semicolons as strings in SQLite.</p>
<p>First, we’ll define a converter function that accepts the string as a parameter
and constructs a <tt class="xref docutils literal"><span class="pre">Point</span></tt> object from it.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Converter functions <strong>always</strong> get called with a string, no matter under which
data type you sent the value to SQLite.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">convert_point</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">";"</span><span class="p">))</span>
<span class="k">return</span> <span class="n">Point</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
</pre></div>
</div>
<p>Now you need to make the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module know that what you select from
the database is actually a point. There are two ways of doing this:</p>
<ul class="simple">
<li>Implicitly via the declared type</li>
<li>Explicitly via the column name</li>
</ul>
<p>Both ways are described in section <a class="reference internal" href="#sqlite3-module-contents"><em>Module functions and constants</em></a>, in the entries
for the constants <a title="sqlite3.PARSE_DECLTYPES" class="reference internal" href="#sqlite3.PARSE_DECLTYPES"><tt class="xref docutils literal"><span class="pre">PARSE_DECLTYPES</span></tt></a> and <a title="sqlite3.PARSE_COLNAMES" class="reference internal" href="#sqlite3.PARSE_COLNAMES"><tt class="xref docutils literal"><span class="pre">PARSE_COLNAMES</span></tt></a>.</p>
<p>The following example illustrates both approaches.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="k">class</span> <span class="nc">Point</span><span class="p">(</span><span class="nb">object</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">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span> <span class="o">=</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"(</span><span class="si">%f</span><span class="s">;</span><span class="si">%f</span><span class="s">)"</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">y</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">adapt_point</span><span class="p">(</span><span class="n">point</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"</span><span class="si">%f</span><span class="s">;</span><span class="si">%f</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">point</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">point</span><span class="o">.</span><span class="n">y</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">convert_point</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
<span class="n">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">float</span><span class="p">,</span> <span class="n">s</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">";"</span><span class="p">))</span>
<span class="k">return</span> <span class="n">Point</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
<span class="c"># Register the adapter</span>
<span class="n">sqlite3</span><span class="o">.</span><span class="n">register_adapter</span><span class="p">(</span><span class="n">Point</span><span class="p">,</span> <span class="n">adapt_point</span><span class="p">)</span>
<span class="c"># Register the converter</span>
<span class="n">sqlite3</span><span class="o">.</span><span class="n">register_converter</span><span class="p">(</span><span class="s">"point"</span><span class="p">,</span> <span class="n">convert_point</span><span class="p">)</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">Point</span><span class="p">(</span><span class="mf">4.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">3.2</span><span class="p">)</span>
<span class="c">#########################</span>
<span class="c"># 1) Using declared types</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">,</span> <span class="n">detect_types</span><span class="o">=</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">PARSE_DECLTYPES</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table test(p point)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into test(p) values (?)"</span><span class="p">,</span> <span class="p">(</span><span class="n">p</span><span class="p">,))</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select p from test"</span><span class="p">)</span>
<span class="k">print</span> <span class="s">"with declared types:"</span><span class="p">,</span> <span class="n">cur</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">cur</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">con</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="c">#######################</span>
<span class="c"># 1) Using column names</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">,</span> <span class="n">detect_types</span><span class="o">=</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">PARSE_COLNAMES</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table test(p)"</span><span class="p">)</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into test(p) values (?)"</span><span class="p">,</span> <span class="p">(</span><span class="n">p</span><span class="p">,))</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'select p as "p [point]" from test'</span><span class="p">)</span>
<span class="k">print</span> <span class="s">"with column names:"</span><span class="p">,</span> <span class="n">cur</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">cur</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">con</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="default-adapters-and-converters">
<h3>12.13.5.4. Default adapters and converters<a class="headerlink" href="#default-adapters-and-converters" title="Permalink to this headline">¶</a></h3>
<p>There are default adapters for the date and datetime types in the datetime
module. They will be sent as ISO dates/ISO timestamps to SQLite.</p>
<p>The default converters are registered under the name “date” for
<a title="datetime.date" class="reference external" href="datetime.html#datetime.date"><tt class="xref docutils literal"><span class="pre">datetime.date</span></tt></a> and under the name “timestamp” for
<a title="datetime.datetime" class="reference external" href="datetime.html#datetime.datetime"><tt class="xref docutils literal"><span class="pre">datetime.datetime</span></tt></a>.</p>
<p>This way, you can use date/timestamps from Python without any additional
fiddling in most cases. The format of the adapters is also compatible with the
experimental SQLite date/time functions.</p>
<p>The following example demonstrates this.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">,</span> <span class="n">detect_types</span><span class="o">=</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">PARSE_DECLTYPES</span><span class="o">|</span><span class="n">sqlite3</span><span class="o">.</span><span class="n">PARSE_COLNAMES</span><span class="p">)</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table test(d date, ts timestamp)"</span><span class="p">)</span>
<span class="n">today</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span>
<span class="n">now</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into test(d, ts) values (?, ?)"</span><span class="p">,</span> <span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">now</span><span class="p">))</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select d, ts from test"</span><span class="p">)</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">print</span> <span class="n">today</span><span class="p">,</span> <span class="s">"=>"</span><span class="p">,</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">print</span> <span class="n">now</span><span class="p">,</span> <span class="s">"=>"</span><span class="p">,</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">'select current_date as "d [date]", current_timestamp as "ts [timestamp]"'</span><span class="p">)</span>
<span class="n">row</span> <span class="o">=</span> <span class="n">cur</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span>
<span class="k">print</span> <span class="s">"current_date"</span><span class="p">,</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">print</span> <span class="s">"current_timestamp"</span><span class="p">,</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="nb">type</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="controlling-transactions">
<span id="sqlite3-controlling-transactions"></span><h2>12.13.6. Controlling Transactions<a class="headerlink" href="#controlling-transactions" title="Permalink to this headline">¶</a></h2>
<p>By default, the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module opens transactions implicitly before a
Data Modification Language (DML) statement (i.e.
<tt class="docutils literal"><span class="pre">INSERT</span></tt>/<tt class="docutils literal"><span class="pre">UPDATE</span></tt>/<tt class="docutils literal"><span class="pre">DELETE</span></tt>/<tt class="docutils literal"><span class="pre">REPLACE</span></tt>), and commits transactions
implicitly before a non-DML, non-query statement (i. e.
anything other than <tt class="docutils literal"><span class="pre">SELECT</span></tt> or the aforementioned).</p>
<p>So if you are within a transaction and issue a command like <tt class="docutils literal"><span class="pre">CREATE</span> <span class="pre">TABLE</span>
<span class="pre">...</span></tt>, <tt class="docutils literal"><span class="pre">VACUUM</span></tt>, <tt class="docutils literal"><span class="pre">PRAGMA</span></tt>, the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module will commit implicitly
before executing that command. There are two reasons for doing that. The first
is that some of these commands don’t work within transactions. The other reason
is that sqlite3 needs to keep track of the transaction state (if a transaction
is active or not).</p>
<p>You can control which kind of <tt class="docutils literal"><span class="pre">BEGIN</span></tt> statements sqlite3 implicitly executes
(or none at all) via the <em>isolation_level</em> parameter to the <a title="sqlite3.connect" class="reference internal" href="#sqlite3.connect"><tt class="xref docutils literal"><span class="pre">connect()</span></tt></a>
call, or via the <tt class="xref docutils literal"><span class="pre">isolation_level</span></tt> property of connections.</p>
<p>If you want <strong>autocommit mode</strong>, then set <tt class="xref docutils literal"><span class="pre">isolation_level</span></tt> to None.</p>
<p>Otherwise leave it at its default, which will result in a plain “BEGIN”
statement, or set it to one of SQLite’s supported isolation levels: “DEFERRED”,
“IMMEDIATE” or “EXCLUSIVE”.</p>
</div>
<div class="section" id="using-sqlite3-efficiently">
<h2>12.13.7. Using <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> efficiently<a class="headerlink" href="#using-sqlite3-efficiently" title="Permalink to this headline">¶</a></h2>
<div class="section" id="using-shortcut-methods">
<h3>12.13.7.1. Using shortcut methods<a class="headerlink" href="#using-shortcut-methods" title="Permalink to this headline">¶</a></h3>
<p>Using the nonstandard <tt class="xref docutils literal"><span class="pre">execute()</span></tt>, <tt class="xref docutils literal"><span class="pre">executemany()</span></tt> and
<tt class="xref docutils literal"><span class="pre">executescript()</span></tt> methods of the <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> object, your code can
be written more concisely because you don’t have to create the (often
superfluous) <a title="sqlite3.Cursor" class="reference internal" href="#sqlite3.Cursor"><tt class="xref docutils literal"><span class="pre">Cursor</span></tt></a> objects explicitly. Instead, the <a title="sqlite3.Cursor" class="reference internal" href="#sqlite3.Cursor"><tt class="xref docutils literal"><span class="pre">Cursor</span></tt></a>
objects are created implicitly and these shortcut methods return the cursor
objects. This way, you can execute a <tt class="docutils literal"><span class="pre">SELECT</span></tt> statement and iterate over it
directly using only a single call on the <a title="sqlite3.Connection" class="reference internal" href="#sqlite3.Connection"><tt class="xref docutils literal"><span class="pre">Connection</span></tt></a> object.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">persons</span> <span class="o">=</span> <span class="p">[</span>
<span class="p">(</span><span class="s">"Hugo"</span><span class="p">,</span> <span class="s">"Boss"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"Calvin"</span><span class="p">,</span> <span class="s">"Klein"</span><span class="p">)</span>
<span class="p">]</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="c"># Create the table</span>
<span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table person(firstname, lastname)"</span><span class="p">)</span>
<span class="c"># Fill the table</span>
<span class="n">con</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="s">"insert into person(firstname, lastname) values (?, ?)"</span><span class="p">,</span> <span class="n">persons</span><span class="p">)</span>
<span class="c"># Print the table contents</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select firstname, lastname from person"</span><span class="p">):</span>
<span class="k">print</span> <span class="n">row</span>
<span class="c"># Using a dummy WHERE clause to not let SQLite take the shortcut table deletes.</span>
<span class="k">print</span> <span class="s">"I just deleted"</span><span class="p">,</span> <span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"delete from person where 1=1"</span><span class="p">)</span><span class="o">.</span><span class="n">rowcount</span><span class="p">,</span> <span class="s">"rows"</span>
</pre></div>
</div>
</div>
<div class="section" id="accessing-columns-by-name-instead-of-by-index">
<h3>12.13.7.2. Accessing columns by name instead of by index<a class="headerlink" href="#accessing-columns-by-name-instead-of-by-index" title="Permalink to this headline">¶</a></h3>
<p>One useful feature of the <tt class="xref docutils literal"><span class="pre">sqlite3</span></tt> module is the built-in
<a title="sqlite3.Row" class="reference internal" href="#sqlite3.Row"><tt class="xref docutils literal"><span class="pre">sqlite3.Row</span></tt></a> class designed to be used as a row factory.</p>
<p>Rows wrapped with this class can be accessed both by index (like tuples) and
case-insensitively by name:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">"mydb"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">row_factory</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">Row</span>
<span class="n">cur</span> <span class="o">=</span> <span class="n">con</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"select name_last, age from people"</span><span class="p">)</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">cur</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">row</span><span class="p">[</span><span class="s">"name_last"</span><span class="p">]</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="s">"name_last"</span><span class="p">]</span> <span class="o">==</span> <span class="n">row</span><span class="p">[</span><span class="s">"nAmE_lAsT"</span><span class="p">]</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">row</span><span class="p">[</span><span class="s">"age"</span><span class="p">]</span>
<span class="k">assert</span> <span class="n">row</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="n">row</span><span class="p">[</span><span class="s">"AgE"</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="using-the-connection-as-a-context-manager">
<h3>12.13.7.3. Using the connection as a context manager<a class="headerlink" href="#using-the-connection-as-a-context-manager" title="Permalink to this headline">¶</a></h3>
<p class="versionadded">
<span class="versionmodified">New in version 2.6.</span></p>
<p>Connection objects can be used as context managers
that automatically commit or rollback transactions. In the event of an
exception, the transaction is rolled back; otherwise, the transaction is
committed:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">sqlite3</span>
<span class="n">con</span> <span class="o">=</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">":memory:"</span><span class="p">)</span>
<span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"create table person (id integer primary key, firstname varchar unique)"</span><span class="p">)</span>
<span class="c"># Successful, con.commit() is called automatically afterwards</span>
<span class="k">with</span> <span class="n">con</span><span class="p">:</span>
<span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into person(firstname) values (?)"</span><span class="p">,</span> <span class="p">(</span><span class="s">"Joe"</span><span class="p">,))</span>
<span class="c"># con.rollback() is called after the with block finishes with an exception, the</span>
<span class="c"># exception is still raised and must be catched</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">with</span> <span class="n">con</span><span class="p">:</span>
<span class="n">con</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s">"insert into person(firstname) values (?)"</span><span class="p">,</span> <span class="p">(</span><span class="s">"Joe"</span><span class="p">,))</span>
<span class="k">except</span> <span class="n">sqlite3</span><span class="o">.</span><span class="n">IntegrityError</span><span class="p">:</span>
<span class="k">print</span> <span class="s">"couldn't add Joe twice"</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">12.13. <tt class="docutils literal"><span class="pre">sqlite3</span></tt> — DB-API 2.0 interface for SQLite databases</a><ul>
<li><a class="reference external" href="#module-functions-and-constants">12.13.1. Module functions and constants</a></li>
<li><a class="reference external" href="#connection-objects">12.13.2. Connection Objects</a></li>
<li><a class="reference external" href="#cursor-objects">12.13.3. Cursor Objects</a></li>
<li><a class="reference external" href="#row-objects">12.13.4. Row Objects</a></li>
<li><a class="reference external" href="#sqlite-and-python-types">12.13.5. SQLite and Python types</a><ul>
<li><a class="reference external" href="#introduction">12.13.5.1. Introduction</a></li>
<li><a class="reference external" href="#using-adapters-to-store-additional-python-types-in-sqlite-databases">12.13.5.2. Using adapters to store additional Python types in SQLite databases</a><ul>
<li><a class="reference external" href="#letting-your-object-adapt-itself">12.13.5.2.1. Letting your object adapt itself</a></li>
<li><a class="reference external" href="#registering-an-adapter-callable">12.13.5.2.2. Registering an adapter callable</a></li>
</ul>
</li>
<li><a class="reference external" href="#converting-sqlite-values-to-custom-python-types">12.13.5.3. Converting SQLite values to custom Python types</a></li>
<li><a class="reference external" href="#default-adapters-and-converters">12.13.5.4. Default adapters and converters</a></li>
</ul>
</li>
<li><a class="reference external" href="#controlling-transactions">12.13.6. Controlling Transactions</a></li>
<li><a class="reference external" href="#using-sqlite3-efficiently">12.13.7. Using <tt class="docutils literal"><span class="pre">sqlite3</span></tt> efficiently</a><ul>
<li><a class="reference external" href="#using-shortcut-methods">12.13.7.1. Using shortcut methods</a></li>
<li><a class="reference external" href="#accessing-columns-by-name-instead-of-by-index">12.13.7.2. Accessing columns by name instead of by index</a></li>
<li><a class="reference external" href="#using-the-connection-as-a-context-manager">12.13.7.3. Using the connection as a context manager</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="dumbdbm.html"
title="previous chapter">12.12. <tt class="docutils literal docutils literal docutils literal"><span class="pre">dumbdbm</span></tt> — Portable DBM implementation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="archiving.html"
title="next chapter">13. Data Compression and Archiving</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/library/sqlite3.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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="../modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="archiving.html" title="13. Data Compression and Archiving"
>next</a> |</li>
<li class="right" >
<a href="dumbdbm.html" title="12.12. dumbdbm — Portable DBM implementation"
>previous</a> |</li>
<li><img src="../_static/py.png" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="../index.html">Python v2.6.5 documentation</a> »</li>
<li><a href="index.html" >The Python Standard Library</a> »</li>
<li><a href="persistence.html" >12. Data Persistence</a> »</li>
</ul>
</div>
<div class="footer">
© <a href="../copyright.html">Copyright</a> 1990-2010, Python Software Foundation.
<br />
The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on Mar 19, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
8f1462e52e1797a02c97073eed0b7f92
>
files
>
890
