Debian Codegraph @

ext/misc/README.md

raw
1 ## Miscellaneous Extensions
2
3 This folder contains a collection of smaller loadable extensions.
4 See <https://sqlite.org/loadext.html> for instructions on how
5 to compile and use loadable extensions.
6 Each extension in this folder is implemented in a single file of C code.
7
8 Each source file contains a description in its header comment. See the
9 header comments for details about each extension. Additional notes are
10 as follows:
11
12 * **csv.c** &mdash; A [virtual table](https://sqlite.org/vtab.html)
13 for reading
14 [Comma-Separated-Value (CSV) files](https://en.wikipedia.org/wiki/Comma-separated_values).
15
16 * **dbdump.c** &mdash; This is not actually a loadable extension, but
17 rather a library that implements an approximate equivalent to the
18 ".dump" command of the
19 [command-line shell](https://sqlite.org/cli.html).
20
21 * **json1.c** &mdash; Various SQL functions and table-valued functions
22 for processing JSON. This extension is already built into the
23 [SQLite amalgamation](https://sqlite.org/amalgamation.html). See
24 <https://sqlite.org/json1.html> for additional information.
25
26 * **rot13.c** &mdash; This file implements the very simple rot13()
27 substitution function. This file makes a good template for implementing
28 new custom SQL functions for SQLite.
29
30 * **series.c** &mdash; This is an implementation of the
31 "generate_series" [virtual table](https://sqlite.org/vtab.html).
32 It can make a good template for new custom virtual table implementations.
33
34 * **shathree.c** &mdash; An implementation of the sha3() and
35 sha3_query() SQL functions. The file is named "shathree.c" instead
36 of "sha3.c" because the default entry point names in SQLite are based
37 on the source filename with digits removed, so if we used the name
38 "sha3.c" then the entry point would conflict with the prior "sha1.c"
39 extension.
40
41 * **unionvtab.c** &mdash; Implementation of the unionvtab and
42 [swarmvtab](https://sqlite.org/swarmvtab.html) virtual tables.
43 These virtual tables allow a single
44 large table to be spread out across multiple database files. In the
45 case of swarmvtab, the individual database files can be attached on
46 demand.
47
48 * **zipfile.c** &mdash; A [virtual table](https://sqlite.org/vtab.html)
49 that can read and write a
50 [ZIP archive](https://en.wikipedia.org/wiki/Zip_%28file_format%29).