1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>About — APSW 3.46.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/apsw.css?v=3c7e2631" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=d98f5d2b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="#" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="Tips" href="tips.html" />
<link rel="prev" title="APSW 3.46.0.1 documentation" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
APSW
<img src="_static/apswlogo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.46.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">About</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-apsw-does">What APSW does</a></li>
<li class="toctree-l2"><a class="reference internal" href="#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="#hosting">Hosting</a></li>
<li class="toctree-l2"><a class="reference internal" href="#mailing-lists-contacts">Mailing lists/contacts</a></li>
<li class="toctree-l2"><a class="reference internal" href="#issue-tracking">Issue tracking</a></li>
<li class="toctree-l2"><a class="reference internal" href="#backwards-compatibility">Backwards compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="#apsw-and-sqlite-versions">APSW and SQLite versions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#python-versions">Python versions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tips.html">Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="example.html">Example/Tour</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation and customization</a></li>
<li class="toctree-l1"><a class="reference internal" href="extensions.html">Extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="apsw.html">APSW Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="connection.html">Connections to a database</a></li>
<li class="toctree-l1"><a class="reference internal" href="cursor.html">Cursors (executing SQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="blob.html">Blob Input/Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="backup.html">Backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="vtable.html">Virtual Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="vfs.html">Virtual File System (VFS)</a></li>
<li class="toctree-l1"><a class="reference internal" href="shell.html">Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="bestpractice.html">Best Practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="ext.html">Various interesting and useful bits of functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions and Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="execution.html">Execution and tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="dbapi.html">DBAPI notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="pysqlite.html">sqlite3 module differences</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarking.html">Benchmarking</a></li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright and License</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Change History</a></li>
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">APSW</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">About</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/about.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="index.html" class="btn btn-neutral float-left" title="APSW 3.46.0.1 documentation" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="tips.html" class="btn btn-neutral float-right" title="Tips" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="about">
<h1>About<a class="headerlink" href="#about" title="Link to this heading"></a></h1>
<p><strong>APSW</strong> 3.46.0.1 <strong>released</strong> 17 June 2024</p>
<p>Use with <a class="reference external" href="https://sqlite.org/">SQLite</a> 3.44 or later, <a class="reference external" href="https://www.python.org/downloads/">Python</a> 3.8 and later.</p>
<section id="what-apsw-does">
<h2>What APSW does<a class="headerlink" href="#what-apsw-does" title="Link to this heading"></a></h2>
<p>APSW lets you get the most out of the <a class="reference external" href="https://sqlite.org/">SQLite</a>
embedded relational database engine from Python, and the most out of
Python from SQLite. APSW glues together the complete <a class="reference external" href="https://sqlite.org/c3ref/intro.html">SQLite C API</a> and <a class="reference external" href="https://docs.python.org/3/c-api/index.html">Python’s C API</a>, staying up to date
with both SQLite and Python.</p>
<p>It is recommended to use the builtin <a class="reference external" href="https://docs.python.org/3/library/sqlite3.html#module-sqlite3" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sqlite3</span></code></a> module
if you want SQLite to appear interchangeable with the other database
drivers.</p>
<p>Use APSW when you want to use SQLite fully, and have an improved
developer experience. See more about the <a class="reference internal" href="pysqlite.html"><span class="doc">differences between
APSW and sqlite3</span></a>.</p>
</section>
<section id="dependencies">
<h2>Dependencies<a class="headerlink" href="#dependencies" title="Link to this heading"></a></h2>
<p>APSW has no dependencies other than Python itself, and SQLite which
you can provide or have APSW fetch and include statically in the
extension.</p>
</section>
<section id="hosting">
<h2>Hosting<a class="headerlink" href="#hosting" title="Link to this heading"></a></h2>
<p>APSW is hosted at <a class="reference external" href="https://github.com/rogerbinns/apsw">https://github.com/rogerbinns/apsw</a> with <a class="reference external" href="https://github.com/rogerbinns/apsw/releases">source
releases at Github</a>
and <code class="code docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apsw</span></code> at <a class="reference external" href="https://pypi.org/project/apsw/">PyPI</a>. See the <a class="reference internal" href="install.html"><span class="doc">installation
details</span></a>.</p>
</section>
<section id="mailing-lists-contacts">
<h2>Mailing lists/contacts<a class="headerlink" href="#mailing-lists-contacts" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://groups.google.com/group/python-sqlite">Python SQLite discussion group</a>
(preferred)</p></li>
<li><p><a class="reference external" href="https://github.com/rogerbinns/apsw/discussions">Github discussions</a></p></li>
<li><p>You can also email the author at <a class="reference external" href="mailto:rogerb%40rogerbinns.com">rogerb<span>@</span>rogerbinns<span>.</span>com</a></p></li>
</ul>
</section>
<section id="issue-tracking">
<h2>Issue tracking<a class="headerlink" href="#issue-tracking" title="Link to this heading"></a></h2>
<p>You can find existing and fixed bugs by clicking on <a class="reference external" href="https://github.com/rogerbinns/apsw/issues">Issues</a> and using “New Issue”
to report previously unknown issues.</p>
</section>
<section id="backwards-compatibility">
<span id="backcompat"></span><h2>Backwards compatibility<a class="headerlink" href="#backwards-compatibility" title="Link to this heading"></a></h2>
<p>Great effort is expended to ensure your code using APSW continues to
work without maintenance as Python, SQLite, and APSW update over time.
The very rare breaks are documented in the <a class="reference internal" href="changes.html"><span class="doc">change log</span></a>. 20 year old code still works unchanged!</p>
</section>
<section id="apsw-and-sqlite-versions">
<h2>APSW and SQLite versions<a class="headerlink" href="#apsw-and-sqlite-versions" title="Link to this heading"></a></h2>
<p>SQLite has approximately quarterly releases. These include tweaks,
bug fixes, and new functionality based on the billions of SQLite
databases in use, and the many programs that use SQLite (eg almost
every browser, mail client, photo library, mobile and desktop OS).
Despite these changes, SQLite retains backwards and forwards
compatibility with the <a class="reference external" href="https://www.sqlite.org/onefile.html">file format</a> and APIs.</p>
<p>APSW wraps the <a class="reference external" href="https://www.sqlite.org/c3ref/intro.html">SQLite C API</a>. That means when SQLite
adds new constant or API, then so does APSW. You can think of APSW as
the Python expression of SQLite’s C API. You can <a class="reference external" href="genindex.html#S">lookup</a> SQLite APIs to find which APSW functions and
attributes call them.</p>
<p>Consequently the APSW version mirrors the SQLite version, with an
additional final number on the end to reflect APSW iterations. For
example the SQLite <code class="code docutils literal notranslate"><span class="pre">3.42.1</span></code> release would have APSW
<code class="code docutils literal notranslate"><span class="pre">3.42.1.0</span></code> as the corresponding release with the final
<code class="code docutils literal notranslate"><span class="pre">.0</span></code> incrementing if there are more APSW releases for the same
SQLite version.</p>
<p>You can use APSW with the corresponding version of SQLite, or any
newer version of SQLite. You could use the original 2004 release of
APSW with today’s SQLite just fine, although it wouldn’t know about
the new APIs and constants.</p>
</section>
<section id="python-versions">
<h2>Python versions<a class="headerlink" href="#python-versions" title="Link to this heading"></a></h2>
<p>APSW supports <a class="reference external" href="https://devguide.python.org/versions/">all supported Python versions</a>, including versions under
development. Once a Python release goes end of life, there will be
one final APSW release supporting that version of Python.</p>
<table class="docutils align-default" id="id1">
<caption><span class="caption-text">Last APSW release</span><a class="headerlink" href="#id1" title="Link to this table"></a></caption>
<thead>
<tr class="row-odd"><th class="head"><p>Python version</p></th>
<th class="head"><p>APSW release</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>3.6, 3.7</p></td>
<td><p><a class="reference external" href="https://github.com/rogerbinns/apsw/releases/tag/3.43.0.0">3.43.0.0</a></p></td>
</tr>
<tr class="row-odd"><td><p>2.3 - 3.5</p></td>
<td><p><a class="reference external" href="https://github.com/rogerbinns/apsw/releases/tag/3.37.0-r1">3.37.0-r1</a></p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="APSW 3.46.0.1 documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="tips.html" class="btn btn-neutral float-right" title="Tips" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© <a href="copyright.html">Copyright</a> 2004-2024, Roger Binns <rogerb@rogerbinns.com>.
<span class="lastupdated">Last updated on Jun 16, 2024.
</span></p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
