python-apsw-doc 3.16.2-r1-2build2 / usr / share / doc / python-apsw / html / apsw.html

This file is indexed.

/usr/share/doc/python-apsw/html/apsw.html is in python-apsw-doc 3.16.2-r1-2build2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
<!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>APSW Module &#8212; APSW 3.16.2-r1 documentation</title>
    
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '3.16.2-r1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <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="top" title="APSW 3.16.2-r1 documentation" href="index.html" />
    <link rel="next" title="Connections to a database" href="connection.html" />
    <link rel="prev" title="Extensions" href="extensions.html" />
 
<script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-26815066-1']);
  _gaq.push(['_trackPageview']);
</script>

  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="connection.html" title="Connections to a database"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="extensions.html" title="Extensions"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">APSW 3.16.2-r1 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <span class="target" id="module-apsw"></span><div class="section" id="apsw-module">
<h1>APSW Module<a class="headerlink" href="#apsw-module" title="Permalink to this headline"></a></h1>
<p>The module is the main interface to SQLite.  Methods and data on the
module have process wide effects.  You can instantiate the
<a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal"><span class="pre">Connection</span></code></a> and <a class="reference internal" href="blob.html#apsw.zeroblob" title="apsw.zeroblob"><code class="xref py py-class docutils literal"><span class="pre">zeroblob</span></code></a> objects using
<a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-meth docutils literal"><span class="pre">Connection()</span></code></a> and <a class="reference internal" href="blob.html#apsw.zeroblob" title="apsw.zeroblob"><code class="xref py py-meth docutils literal"><span class="pre">zeroblob()</span></code></a> respectively.</p>
<div class="section" id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline"></a></h2>
<dl class="data">
<dt id="apsw.SQLITE_VERSION_NUMBER">
<code class="descname">SQLITE_VERSION_NUMBER</code><a class="headerlink" href="#apsw.SQLITE_VERSION_NUMBER" title="Permalink to this definition"></a></dt>
<dd><p>The integer version number of SQLite that APSW was compiled
against.  For example SQLite 3.6.4 will have the value <em>3006004</em>.
This number may be different than the actual library in use if the
library is shared and has been updated.  Call
<a class="reference internal" href="#apsw.sqlitelibversion" title="apsw.sqlitelibversion"><code class="xref py py-meth docutils literal"><span class="pre">sqlitelibversion()</span></code></a> to get the actual library version.</p>
</dd></dl>

<dl class="method">
<dt id="apsw.apswversion">
<code class="descname">apswversion</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &rarr; string<a class="headerlink" href="#apsw.apswversion" title="Permalink to this definition"></a></dt>
<dd><p>Returns the APSW version.</p>
</dd></dl>

<span class="target" id="index-0"></span><dl class="attribute">
<dt id="apsw.compile_options">
<code class="descname">compile_options</code><a class="headerlink" href="#apsw.compile_options" title="Permalink to this definition"></a></dt>
<dd><p>A tuple of the options used to compile SQLite.  For example it
will be something like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="p">(</span><span class="s">&#39;ENABLE_LOCKING_STYLE=0&#39;</span><span class="p">,</span> <span class="s">&#39;TEMP_STORE=1&#39;</span><span class="p">,</span> <span class="s">&#39;THREADSAFE=1&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/compileoption_get.html">sqlite3_compileoption_get</a></p>
</dd></dl>

<span class="target" id="index-1"></span><dl class="method">
<dt id="apsw.complete">
<code class="descname">complete</code><span class="sig-paren">(</span><em>statement</em><span class="sig-paren">)</span> &rarr; bool<a class="headerlink" href="#apsw.complete" title="Permalink to this definition"></a></dt>
<dd><p>Returns True if the input string comprises one or more complete SQL
statements by looking for an unquoted trailing semi-colon.</p>
<p>An example use would be if you were prompting the user for SQL
statements and needed to know if you had a whole statement, or
needed to ask for another line:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">statement</span><span class="o">=</span><span class="n">raw_input</span><span class="p">(</span><span class="s">&quot;SQL&gt; &quot;</span><span class="p">)</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">apsw</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span><span class="n">statement</span><span class="p">):</span>
   <span class="n">more</span><span class="o">=</span><span class="n">raw_input</span><span class="p">(</span><span class="s">&quot;  .. &quot;</span><span class="p">)</span>
   <span class="n">statement</span><span class="o">=</span><span class="n">statement</span><span class="o">+</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="o">+</span><span class="n">more</span>
</pre></div>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/complete.html">sqlite3_complete</a></p>
</dd></dl>

<span class="target" id="index-2"></span><dl class="method">
<dt id="apsw.config">
<code class="descname">config</code><span class="sig-paren">(</span><em>op</em><span class="optional">[</span>, <em>*args</em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#apsw.config" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>op</strong> &#8211; A <a class="reference external" href="https://sqlite.org/c3ref/c_config_chunkalloc.html">configuration operation</a></li>
<li><strong>args</strong> &#8211; Zero or more arguments as appropriate for <em>op</em></li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Many operations don&#8217;t make sense from a Python program.  The
following configuration operations are supported: SQLITE_CONFIG_LOG,
SQLITE_CONFIG_SINGLETHREAD, SQLITE_CONFIG_MULTITHREAD,
SQLITE_CONFIG_SERIALIZED, SQLITE_CONFIG_URI, SQLITE_CONFIG_MEMSTATUS,
SQLITE_CONFIG_COVERING_INDEX_SCAN, SQLITE_CONFIG_PCACHE_HDRSZ,
SQLITE_CONFIG_PMASZ, and SQLITE_CONFIG_STMTJRNL_SPILL.</p>
<p>See <a class="reference internal" href="tips.html#diagnostics-tips"><span class="std std-ref">tips</span></a> for an example of how to receive
log messages (SQLITE_CONFIG_LOG)</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/config.html">sqlite3_config</a></p>
</dd></dl>

<dl class="attribute">
<dt id="apsw.connection_hooks">
<code class="descname">connection_hooks</code><a class="headerlink" href="#apsw.connection_hooks" title="Permalink to this definition"></a></dt>
<dd><p>The purpose of the hooks is to allow the easy registration of
<a class="reference internal" href="connection.html#apsw.Connection.createscalarfunction" title="apsw.Connection.createscalarfunction"><code class="xref py py-meth docutils literal"><span class="pre">functions</span></code></a>,
<a class="reference internal" href="vtable.html#virtualtables"><span class="std std-ref">virtual tables</span></a> or similar items with
each <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal"><span class="pre">Connection</span></code></a> as it is created. The default value is an empty
list. Whenever a Connection is created, each item in
apsw.connection_hooks is invoked with a single parameter being
the new Connection object. If the hook raises an exception then
the creation of the Connection fails.</p>
<p>If you wanted to store your own defined functions in the
database then you could define a hook that looked in the
relevant tables, got the Python text and turned it into the
functions.</p>
</dd></dl>

<span class="target" id="index-3"></span><dl class="method">
<dt id="apsw.enablesharedcache">
<code class="descname">enablesharedcache</code><span class="sig-paren">(</span><em>bool</em><span class="sig-paren">)</span><a class="headerlink" href="#apsw.enablesharedcache" title="Permalink to this definition"></a></dt>
<dd><p>If you use the same <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal"><span class="pre">Connection</span></code></a> across threads or use
multiple <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal"><span class="pre">connections</span></code></a> accessing the same file,
then SQLite can <a class="reference external" href="https://sqlite.org/sharedcache.html">share the cache between them</a>.  It is <a class="reference internal" href="tips.html#sharedcache"><span class="std std-ref">not
recommended</span></a> that you use this.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/enable_shared_cache.html">sqlite3_enable_shared_cache</a></p>
</dd></dl>

<dl class="method">
<dt id="apsw.exceptionfor">
<code class="descname">exceptionfor</code><span class="sig-paren">(</span><em>int</em><span class="sig-paren">)</span> &rarr; Exception<a class="headerlink" href="#apsw.exceptionfor" title="Permalink to this definition"></a></dt>
<dd><p>If you would like to raise an exception that corresponds to a
particular SQLite <a class="reference external" href="https://sqlite.org/c3ref/c_abort.html">error code</a> then call this function.
It also understands <a class="reference external" href="https://sqlite.org/c3ref/c_ioerr_access.html">extended error codes</a>.</p>
<p>For example to raise <a class="reference external" href="https://sqlite.org/c3ref/c_ioerr_access.html">SQLITE_IOERR_ACCESS</a>:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="k">raise</span> <span class="n">apsw</span><span class="o">.</span><span class="n">exceptionfor</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_IOERR_ACCESS</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="apsw.fork_checker">
<code class="descname">fork_checker</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apsw.fork_checker" title="Permalink to this definition"></a></dt>
<dd><p><strong>Note</strong> This method is not available on Windows as it does not
support the fork system call.</p>
<p>SQLite does not allow the use of database connections across <a class="reference external" href="http://en.wikipedia.org/wiki/Fork_(operating_system)">forked</a> processes
(see the <a class="reference external" href="https://sqlite.org/faq.html#q6">SQLite FAQ Q6</a>).
(Forking creates a child process that is a duplicate of the parent
including the state of all data structures in the program.  If you
do this to SQLite then parent and child would both consider
themselves owners of open databases and silently corrupt each
other&#8217;s work and interfere with each other&#8217;s locks.)</p>
<p>One example of how you may end up using fork is if you use the
<a class="reference external" href="http://docs.python.org/library/multiprocessing.html">multiprocessing module</a> which uses
fork to make child processes.</p>
<p>If you do use fork or multiprocessing on a platform that supports
fork then you <strong>must</strong> ensure database connections and their objects
(cursors, backup, blobs etc) are not used in the parent process, or
are all closed before calling fork or starting a <a class="reference external" href="http://docs.python.org/library/multiprocessing.html#process-and-exceptions">Process</a>.
(Note you must call close to ensure the underlying SQLite objects
are closed.  It is also a good idea to call <a class="reference external" href="http://docs.python.org/library/gc.html#gc.collect">gc.collect(2)</a> to ensure
anything you may have missed is also deallocated.)</p>
<p>Once you run this method, extra checking code is inserted into
SQLite&#8217;s mutex operations (at a very small performance penalty) that
verifies objects are not used across processes.  You will get a
<a class="reference internal" href="exceptions.html#apsw.ForkingViolationError" title="apsw.ForkingViolationError"><code class="xref py py-exc docutils literal"><span class="pre">ForkingViolationError</span></code></a> if you do so.  Note that due to the way
Python&#8217;s internals work, the exception will be delivered to
<cite>sys.excepthook</cite> in addition to the normal exception mechanisms and
may be reported by Python after the line where the issue actually
arose.  (Destructors of objects you didn&#8217;t close also run between
lines.)</p>
<p>You should only call this method as the first line after importing
APSW, as it has to shutdown and re-initialize SQLite.  If you have
any SQLite objects already allocated when calling the method then
the program will later crash.  The recommended use is to use the fork
checking as part of your test suite.</p>
</dd></dl>

<dl class="method">
<dt id="apsw.format_sql_value">
<code class="descname">format_sql_value</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span> &rarr; string<a class="headerlink" href="#apsw.format_sql_value" title="Permalink to this definition"></a></dt>
<dd><p>Returns a Python string (unicode) representing the supplied value in
SQL syntax.  Python 2 note: You must supply unicode strings not
plain strings.</p>
</dd></dl>

<span class="target" id="index-4"></span><dl class="method">
<dt id="apsw.initialize">
<code class="descname">initialize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apsw.initialize" title="Permalink to this definition"></a></dt>
<dd><p>It is unlikely you will want to call this method as SQLite automatically initializes.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/initialize.html">sqlite3_initialize</a></p>
</dd></dl>

<span class="target" id="index-5"></span><dl class="method">
<dt id="apsw.log">
<code class="descname">log</code><span class="sig-paren">(</span><em>level</em>, <em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#apsw.log" title="Permalink to this definition"></a></dt>
<dd><p>Calls the SQLite logging interface.  Note that you must format the
message before passing it to this method:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">apsw</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_NOMEM</span><span class="p">,</span> <span class="s">&quot;Need %d bytes of memory&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="mi">1234</span><span class="p">,))</span>
</pre></div>
</div>
<p>See <a class="reference internal" href="tips.html#diagnostics-tips"><span class="std std-ref">tips</span></a> for an example of how to
receive log messages.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/log.html">sqlite3_log</a></p>
</dd></dl>

<dl class="method">
<dt id="apsw.main">
<code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apsw.main" title="Permalink to this definition"></a></dt>
<dd><p>Call this to run the interactive shell.  It automatically passes
in sys.argv[1:] and exits Python when done.</p>
</dd></dl>

<span class="target" id="index-6"></span><dl class="method">
<dt id="apsw.memoryhighwater">
<code class="descname">memoryhighwater</code><span class="sig-paren">(</span><em>reset=False</em><span class="sig-paren">)</span> &rarr; int<a class="headerlink" href="#apsw.memoryhighwater" title="Permalink to this definition"></a></dt>
<dd><p>Returns the maximum amount of memory SQLite has used.  If <em>reset</em> is
True then the high water mark is reset to the current value.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#apsw.status" title="apsw.status"><code class="xref py py-meth docutils literal"><span class="pre">status()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/memory_highwater.html">sqlite3_memory_highwater</a></p>
</dd></dl>

<span class="target" id="index-7"></span><dl class="method">
<dt id="apsw.memoryused">
<code class="descname">memoryused</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &rarr; int<a class="headerlink" href="#apsw.memoryused" title="Permalink to this definition"></a></dt>
<dd><p>Returns the amount of memory SQLite is currently using.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#apsw.status" title="apsw.status"><code class="xref py py-meth docutils literal"><span class="pre">status()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/memory_highwater.html">sqlite3_memory_used</a></p>
</dd></dl>

<span class="target" id="index-8"></span><dl class="method">
<dt id="apsw.randomness">
<code class="descname">randomness</code><span class="sig-paren">(</span><em>bytes</em><span class="sig-paren">)</span> &rarr; data<a class="headerlink" href="#apsw.randomness" title="Permalink to this definition"></a></dt>
<dd><p>Gets random data from SQLite&#8217;s random number generator.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>bytes</strong> &#8211; How many bytes to return</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">(Python 2) string, (Python 3) bytes</td>
</tr>
</tbody>
</table>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/randomness.html">sqlite3_randomness</a></p>
</dd></dl>

<span class="target" id="index-9"></span><dl class="method">
<dt id="apsw.releasememory">
<code class="descname">releasememory</code><span class="sig-paren">(</span><em>bytes</em><span class="sig-paren">)</span> &rarr; int<a class="headerlink" href="#apsw.releasememory" title="Permalink to this definition"></a></dt>
<dd><p>Requests SQLite try to free <em>bytes</em> bytes of memory.  Returns how
many bytes were freed.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/release_memory.html">sqlite3_release_memory</a></p>
</dd></dl>

<span class="target" id="index-10"></span><dl class="method">
<dt id="apsw.shutdown">
<code class="descname">shutdown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apsw.shutdown" title="Permalink to this definition"></a></dt>
<dd><p>It is unlikely you will want to call this method and there is no
need to do so.  It is a <strong>really</strong> bad idea to call it unless you
are absolutely sure all <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal"><span class="pre">connections</span></code></a>,
<a class="reference internal" href="blob.html#apsw.blob" title="apsw.blob"><code class="xref py py-class docutils literal"><span class="pre">blobs</span></code></a>, <a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><code class="xref py py-class docutils literal"><span class="pre">cursors</span></code></a>, <a class="reference internal" href="vfs.html#apsw.VFS" title="apsw.VFS"><code class="xref py py-class docutils literal"><span class="pre">vfs</span></code></a>
etc have been closed, deleted and garbage collected.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/initialize.html">sqlite3_shutdown</a></p>
</dd></dl>

<span class="target" id="index-11"></span><dl class="method">
<dt id="apsw.softheaplimit">
<code class="descname">softheaplimit</code><span class="sig-paren">(</span><em>bytes</em><span class="sig-paren">)</span> &rarr; oldlimit<a class="headerlink" href="#apsw.softheaplimit" title="Permalink to this definition"></a></dt>
<dd><p>Requests SQLite try to keep memory usage below <em>bytes</em> bytes and
returns the previous setting.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/soft_heap_limit64.html">sqlite3_soft_heap_limit64</a></p>
</dd></dl>

<span class="target" id="index-12"></span><dl class="method">
<dt id="apsw.sqlite3_sourceid">
<code class="descname">sqlite3_sourceid</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &rarr; string<a class="headerlink" href="#apsw.sqlite3_sourceid" title="Permalink to this definition"></a></dt>
<dd><p>Returns the exact checkin information for the SQLite 3 source
being used.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/libversion.html">sqlite3_sourceid</a></p>
</dd></dl>

<span class="target" id="index-13"></span><dl class="method">
<dt id="apsw.sqlitelibversion">
<code class="descname">sqlitelibversion</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &rarr; string<a class="headerlink" href="#apsw.sqlitelibversion" title="Permalink to this definition"></a></dt>
<dd><p>Returns the version of the SQLite library.  This value is queried at
run time from the library so if you use shared libraries it will be
the version in the shared library.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/libversion.html">sqlite3_libversion</a></p>
</dd></dl>

<span class="target" id="index-14"></span><dl class="method">
<dt id="apsw.status">
<code class="descname">status</code><span class="sig-paren">(</span><em>op</em>, <em>reset=False) -&gt; (int</em>, <em>int</em><span class="sig-paren">)</span><a class="headerlink" href="#apsw.status" title="Permalink to this definition"></a></dt>
<dd><p>Returns current and highwater measurements.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>op</strong> &#8211; A <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_size.html">status parameter</a></li>
<li><strong>reset</strong> &#8211; If <em>True</em> then the highwater is set to the current value</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A tuple of current value and highwater value</p>
</td>
</tr>
</tbody>
</table>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<ul class="last simple">
<li><a class="reference internal" href="example.html#example-status"><span class="std std-ref">Status example</span></a></li>
</ul>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/status.html">sqlite3_status64</a></p>
</dd></dl>

<dl class="attribute">
<dt id="apsw.using_amalgamation">
<code class="descname">using_amalgamation</code><a class="headerlink" href="#apsw.using_amalgamation" title="Permalink to this definition"></a></dt>
<dd><p>If True then <a class="reference external" href="https://sqlite.org/cvstrac/wiki?p=TheAmalgamation">SQLite amalgamation</a> is in
use (statically compiled into APSW).  Using the amalgamation means
that SQLite shared libraries are not used and will not affect your
code.</p>
</dd></dl>

<dl class="method">
<dt id="apsw.vfsnames">
<code class="descname">vfsnames</code><span class="sig-paren">(</span><em>) -&gt; list(string</em><span class="sig-paren">)</span><a class="headerlink" href="#apsw.vfsnames" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list of the currently installed <a class="reference internal" href="vfs.html#vfs"><span class="std std-ref">vfs</span></a>.  The first
item in the list is the default vfs.</p>
</dd></dl>

</div>
<div class="section" id="sqlite-constants">
<span id="sqliteconstants"></span><h2>SQLite constants<a class="headerlink" href="#sqlite-constants" title="Permalink to this headline"></a></h2>
<p>SQLite has <a class="reference external" href="https://sqlite.org/c3ref/constlist.html">many constants</a> used in various
interfaces.  To use a constant such as <code class="xref py py-const docutils literal"><span class="pre">SQLITE_OK</span></code>, just
use <code class="docutils literal"><span class="pre">apsw.SQLITE_OK</span></code>.</p>
<p>The same values can be used in different contexts. For example
<code class="xref py py-const docutils literal"><span class="pre">SQLITE_OK</span></code> and <code class="xref py py-const docutils literal"><span class="pre">SQLITE_CREATE_INDEX</span></code> both have a value
of zero. For each group of constants there is also a mapping (dict)
available that you can supply a string to and get the corresponding
numeric value, or supply a numeric value and get the corresponding
string. These can help improve diagnostics/logging, calling other
modules etc. For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">apsw</span><span class="o">.</span><span class="n">mapping_authorizer_function</span><span class="p">[</span><span class="s">&quot;SQLITE_READ&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="mi">20</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">mapping_authorizer_function</span><span class="p">[</span><span class="mi">20</span><span class="p">]</span> <span class="o">==</span> <span class="s">&quot;SQLITE_READ&quot;</span>
</pre></div>
</div>
<p>mapping_access <a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">Flags for the xAccess VFS method</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_EXISTS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_READ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_READWRITE</a></div></blockquote>
<p>mapping_authorizer_function <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">Authorizer Action Codes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ALTER_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ANALYZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ATTACH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_COPY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_VTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DELETE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DETACH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_VTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_FUNCTION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_INSERT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_PRAGMA</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_READ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_RECURSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_REINDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_SAVEPOINT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_SELECT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_TRANSACTION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_UPDATE</a></div></blockquote>
<p>mapping_authorizer_return <a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">Authorizer Return Codes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_DENY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_IGNORE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok">SQLITE_OK</a></div></blockquote>
<p>mapping_bestindex_constraints <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">Virtual Table Constraint Operator Codes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_EQ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GLOB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LIKE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_MATCH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_REGEXP</a></div></blockquote>
<p>mapping_config <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html">Configuration Options</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigcoveringindexscan">SQLITE_CONFIG_COVERING_INDEX_SCAN</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetmalloc">SQLITE_CONFIG_GETMALLOC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetmutex">SQLITE_CONFIG_GETMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetpcache">SQLITE_CONFIG_GETPCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetpcache2">SQLITE_CONFIG_GETPCACHE2</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigheap">SQLITE_CONFIG_HEAP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiglog">SQLITE_CONFIG_LOG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiglookaside">SQLITE_CONFIG_LOOKASIDE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmalloc">SQLITE_CONFIG_MALLOC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmemstatus">SQLITE_CONFIG_MEMSTATUS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmmapsize">SQLITE_CONFIG_MMAP_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmultithread">SQLITE_CONFIG_MULTITHREAD</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmutex">SQLITE_CONFIG_MUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcache">SQLITE_CONFIG_PCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcache2">SQLITE_CONFIG_PCACHE2</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcachehdrsz">SQLITE_CONFIG_PCACHE_HDRSZ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpmasz">SQLITE_CONFIG_PMASZ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigserialized">SQLITE_CONFIG_SERIALIZED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsinglethread">SQLITE_CONFIG_SINGLETHREAD</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsqllog">SQLITE_CONFIG_SQLLOG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigstmtjrnlspill">SQLITE_CONFIG_STMTJRNL_SPILL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiguri">SQLITE_CONFIG_URI</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigwin32heapsize">SQLITE_CONFIG_WIN32_HEAPSIZE</a></div></blockquote>
<p>mapping_conflict_resolution_modes <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">Conflict resolution modes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/rescode.html#abort">SQLITE_ABORT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_FAIL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_IGNORE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_REPLACE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_ROLLBACK</a></div></blockquote>
<p>mapping_db_config <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">Database Connection Configuration Options</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_ENABLE_FKEY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_ENABLE_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_LOOKASIDE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_MAINDBNAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_enable_fkey.html">SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</a></div></blockquote>
<p>mapping_db_status <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html">Status Parameters for database connections</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachehit">SQLITE_DBSTATUS_CACHE_HIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachemiss">SQLITE_DBSTATUS_CACHE_MISS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscacheused">SQLITE_DBSTATUS_CACHE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscacheusedshared">SQLITE_DBSTATUS_CACHE_USED_SHARED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachewrite">SQLITE_DBSTATUS_CACHE_WRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusdeferredfks">SQLITE_DBSTATUS_DEFERRED_FKS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidehit">SQLITE_DBSTATUS_LOOKASIDE_HIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidemissfull">SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidemisssize">SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasideused">SQLITE_DBSTATUS_LOOKASIDE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html">SQLITE_DBSTATUS_MAX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusschemaused">SQLITE_DBSTATUS_SCHEMA_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusstmtused">SQLITE_DBSTATUS_STMT_USED</a></div></blockquote>
<p>mapping_device_characteristics <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">Device Characteristics</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC16K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC1K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC2K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC32K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC4K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC512</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC64K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC8K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_IMMUTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_POWERSAFE_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_SAFE_APPEND</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_SEQUENTIAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN</a></div></blockquote>
<p>mapping_extended_result_codes <a class="reference external" href="https://sqlite.org/rescode.html">Extended Result Codes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/rescode.html#abort_rollback">SQLITE_ABORT_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_AUTH_USER</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy_recovery">SQLITE_BUSY_RECOVERY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy_snapshot">SQLITE_BUSY_SNAPSHOT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_convpath">SQLITE_CANTOPEN_CONVPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_fullpath">SQLITE_CANTOPEN_FULLPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_isdir">SQLITE_CANTOPEN_ISDIR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_notempdir">SQLITE_CANTOPEN_NOTEMPDIR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_check">SQLITE_CONSTRAINT_CHECK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_commithook">SQLITE_CONSTRAINT_COMMITHOOK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_foreignkey">SQLITE_CONSTRAINT_FOREIGNKEY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_function">SQLITE_CONSTRAINT_FUNCTION</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_notnull">SQLITE_CONSTRAINT_NOTNULL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_primarykey">SQLITE_CONSTRAINT_PRIMARYKEY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_rowid">SQLITE_CONSTRAINT_ROWID</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_trigger">SQLITE_CONSTRAINT_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_unique">SQLITE_CONSTRAINT_UNIQUE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_vtab">SQLITE_CONSTRAINT_VTAB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt_vtab">SQLITE_CORRUPT_VTAB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_access">SQLITE_IOERR_ACCESS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_IOERR_AUTH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_blocked">SQLITE_IOERR_BLOCKED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_checkreservedlock">SQLITE_IOERR_CHECKRESERVEDLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_close">SQLITE_IOERR_CLOSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_convpath">SQLITE_IOERR_CONVPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_delete">SQLITE_IOERR_DELETE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_delete_noent">SQLITE_IOERR_DELETE_NOENT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_dir_close">SQLITE_IOERR_DIR_CLOSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_dir_fsync">SQLITE_IOERR_DIR_FSYNC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_fstat">SQLITE_IOERR_FSTAT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_fsync">SQLITE_IOERR_FSYNC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_gettemppath">SQLITE_IOERR_GETTEMPPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_lock">SQLITE_IOERR_LOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_mmap">SQLITE_IOERR_MMAP</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_nomem">SQLITE_IOERR_NOMEM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_rdlock">SQLITE_IOERR_RDLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_read">SQLITE_IOERR_READ</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_seek">SQLITE_IOERR_SEEK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmlock">SQLITE_IOERR_SHMLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmmap">SQLITE_IOERR_SHMMAP</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmopen">SQLITE_IOERR_SHMOPEN</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmsize">SQLITE_IOERR_SHMSIZE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_short_read">SQLITE_IOERR_SHORT_READ</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_truncate">SQLITE_IOERR_TRUNCATE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_unlock">SQLITE_IOERR_UNLOCK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_IOERR_VNODE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_write">SQLITE_IOERR_WRITE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#locked_sharedcache">SQLITE_LOCKED_SHAREDCACHE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice_recover_rollback">SQLITE_NOTICE_RECOVER_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice_recover_wal">SQLITE_NOTICE_RECOVER_WAL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok_load_permanently">SQLITE_OK_LOAD_PERMANENTLY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_cantlock">SQLITE_READONLY_CANTLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_dbmoved">SQLITE_READONLY_DBMOVED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_recovery">SQLITE_READONLY_RECOVERY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_rollback">SQLITE_READONLY_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#warning_autoindex">SQLITE_WARNING_AUTOINDEX</a></div></blockquote>
<p>mapping_file_control <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html">Standard File Control Opcodes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlbusyhandler">SQLITE_FCNTL_BUSYHANDLER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlchunksize">SQLITE_FCNTL_CHUNK_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlcommitphasetwo">SQLITE_FCNTL_COMMIT_PHASETWO</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlfilepointer">SQLITE_FCNTL_FILE_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html">SQLITE_FCNTL_GET_LOCKPROXYFILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlhasmoved">SQLITE_FCNTL_HAS_MOVED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntljournalpointer">SQLITE_FCNTL_JOURNAL_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html">SQLITE_FCNTL_LAST_ERRNO</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntllockstate">SQLITE_FCNTL_LOCKSTATE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlmmapsize">SQLITE_FCNTL_MMAP_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntloverwrite">SQLITE_FCNTL_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html">SQLITE_FCNTL_PDB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlpersistwal">SQLITE_FCNTL_PERSIST_WAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlpowersafeoverwrite">SQLITE_FCNTL_POWERSAFE_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlpragma">SQLITE_FCNTL_PRAGMA</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlrbu">SQLITE_FCNTL_RBU</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html">SQLITE_FCNTL_SET_LOCKPROXYFILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlsizehint">SQLITE_FCNTL_SIZE_HINT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlsync">SQLITE_FCNTL_SYNC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlsyncomitted">SQLITE_FCNTL_SYNC_OMITTED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntltempfilename">SQLITE_FCNTL_TEMPFILENAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntltrace">SQLITE_FCNTL_TRACE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlvfsname">SQLITE_FCNTL_VFSNAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlvfspointer">SQLITE_FCNTL_VFS_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlwalblock">SQLITE_FCNTL_WAL_BLOCK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlwin32avretry">SQLITE_FCNTL_WIN32_AV_RETRY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlwin32gethandle">SQLITE_FCNTL_WIN32_GET_HANDLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlwin32sethandle">SQLITE_FCNTL_WIN32_SET_HANDLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_busyhandler.html#sqlitefcntlzipvfs">SQLITE_FCNTL_ZIPVFS</a></div></blockquote>
<p>mapping_limits <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html">Run-Time Limit Categories</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitattached">SQLITE_LIMIT_ATTACHED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitcolumn">SQLITE_LIMIT_COLUMN</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitcompoundselect">SQLITE_LIMIT_COMPOUND_SELECT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitexprdepth">SQLITE_LIMIT_EXPR_DEPTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitfunctionarg">SQLITE_LIMIT_FUNCTION_ARG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitlength">SQLITE_LIMIT_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitlikepatternlength">SQLITE_LIMIT_LIKE_PATTERN_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitsqllength">SQLITE_LIMIT_SQL_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimittriggerdepth">SQLITE_LIMIT_TRIGGER_DEPTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitvariablenumber">SQLITE_LIMIT_VARIABLE_NUMBER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitvdbeop">SQLITE_LIMIT_VDBE_OP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitworkerthreads">SQLITE_LIMIT_WORKER_THREADS</a></div></blockquote>
<p>mapping_locking_level <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">File Locking Levels</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_NONE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_PENDING</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_RESERVED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_SHARED</a></div></blockquote>
<p>mapping_open_flags <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">Flags For File Open Operations</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_AUTOPROXY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_CREATE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_DELETEONCLOSE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_FULLMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MAIN_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MAIN_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MASTER_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MEMORY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_NOMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_PRIVATECACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_READONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_READWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_SHAREDCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_SUBJOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TEMP_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TEMP_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TRANSIENT_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_URI</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_WAL</a></div></blockquote>
<p>mapping_result_codes <a class="reference external" href="https://sqlite.org/rescode.html">Result Codes</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/rescode.html#abort">SQLITE_ABORT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#auth">SQLITE_AUTH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy">SQLITE_BUSY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen">SQLITE_CANTOPEN</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint">SQLITE_CONSTRAINT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt">SQLITE_CORRUPT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#done">SQLITE_DONE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#empty">SQLITE_EMPTY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#error">SQLITE_ERROR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#format">SQLITE_FORMAT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#full">SQLITE_FULL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#internal">SQLITE_INTERNAL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#interrupt">SQLITE_INTERRUPT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr">SQLITE_IOERR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#locked">SQLITE_LOCKED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#mismatch">SQLITE_MISMATCH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#misuse">SQLITE_MISUSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#nolfs">SQLITE_NOLFS</a>, <a class="reference external" href="https://sqlite.org/rescode.html#nomem">SQLITE_NOMEM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notadb">SQLITE_NOTADB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notfound">SQLITE_NOTFOUND</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice">SQLITE_NOTICE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok">SQLITE_OK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#perm">SQLITE_PERM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#protocol">SQLITE_PROTOCOL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#range">SQLITE_RANGE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly">SQLITE_READONLY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#row">SQLITE_ROW</a>, <a class="reference external" href="https://sqlite.org/rescode.html#schema">SQLITE_SCHEMA</a>, <a class="reference external" href="https://sqlite.org/rescode.html#toobig">SQLITE_TOOBIG</a>, <a class="reference external" href="https://sqlite.org/rescode.html#warning">SQLITE_WARNING</a></div></blockquote>
<p>mapping_status <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html">Status Parameters</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmalloccount">SQLITE_STATUS_MALLOC_COUNT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmallocsize">SQLITE_STATUS_MALLOC_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmemoryused">SQLITE_STATUS_MEMORY_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecacheoverflow">SQLITE_STATUS_PAGECACHE_OVERFLOW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecachesize">SQLITE_STATUS_PAGECACHE_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecacheused">SQLITE_STATUS_PAGECACHE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusparserstack">SQLITE_STATUS_PARSER_STACK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchoverflow">SQLITE_STATUS_SCRATCH_OVERFLOW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchsize">SQLITE_STATUS_SCRATCH_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchused">SQLITE_STATUS_SCRATCH_USED</a></div></blockquote>
<p>mapping_sync <a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">Synchronization Type Flags</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_DATAONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_NORMAL</a></div></blockquote>
<p>mapping_virtual_table_configuration_options <a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html">Virtual Table Configuration Options</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html">SQLITE_VTAB_CONSTRAINT_SUPPORT</a></div></blockquote>
<p>mapping_virtual_table_scan_flags <a class="reference external" href="https://sqlite.org/c3ref/c_index_scan_unique.html">Virtual Table Scan Flags</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_index_scan_unique.html">SQLITE_INDEX_SCAN_UNIQUE</a></div></blockquote>
<p>mapping_wal_checkpoint <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">Checkpoint Mode Values</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_PASSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_RESTART</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_TRUNCATE</a></div></blockquote>
<p>mapping_xshmlock_flags <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">Flags for the xShmLock VFS method</a></p>
<blockquote>
<div><a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_LOCK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_SHARED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_UNLOCK</a></div></blockquote>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">APSW Module</a><ul>
<li><a class="reference internal" href="#api-reference">API Reference</a></li>
<li><a class="reference internal" href="#sqlite-constants">SQLite constants</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="extensions.html"
                        title="previous chapter">Extensions</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="connection.html"
                        title="next chapter">Connections to a database</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/apsw.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="connection.html" title="Connections to a database"
             >next</a> |</li>
        <li class="right" >
          <a href="extensions.html" title="Extensions"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">APSW 3.16.2-r1 documentation</a> &#187;</li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
        &#169; <a href="copyright.html">Copyright</a> 2004-2016, Roger Binns &lt;rogerb@rogerbinns.com&gt;.
      Last updated on Jan 14, 2017.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
    </div>

  </body>
</html>

APT Browse - Built by Thomas Orozco.