Skip to content

Commit f83ecf1

Browse files
committed
Document vend merge
1 parent 7f1dd3d commit f83ecf1

2 files changed

Lines changed: 26 additions & 5 deletions

File tree

doc/changes.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Regularised str and repr for APSW objects:
3939
* async and closed are indicated
4040
* Subclasses name are used instead of the APSW parent class
4141

42+
SQLite has many extra useful extensions and programs that have to be
43+
compiled. These can be packaged with APSW for convenient access. See
44+
:doc:`extra` documentation. This is the default for PyPI builds.
45+
Also included is the experimental under development `vec1 vector
46+
search extension <https://sqlite.org/vec1>`__.
47+
4248
Fix wrapping, indents. and space for hyphens in
4349
:func:`apsw.unicode.text_wrap` under various conditions (:issue:`600`)
4450

doc/extra.rst

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,35 @@ SQLite extra
44
In addition to the main library, SQLite has additional programs and
55
loadable extensions. However these need to be separately compiled and
66
installed. Full APSW builds such as those on PyPI include all the
7-
ones that compile for that platform. This is for convenience and to
8-
help promote these great extras. They add just over 1MB to the
9-
download and 3MB of disk space.
7+
ones that compile for that platform, without any modifications. This
8+
is for convenience and to help promote these great extras. They add
9+
just over 1MB to the download and 3MB of disk space.
1010

1111
Access is provided via an :ref:`API <extra_api>`, :ref:`command line
1212
<extra_api>`, and :ref:`shell <extra_shell>`
1313

14+
vec1
15+
++++
16+
17+
There is an experimental under development vector search library by
18+
the SQLite team. It is also included with the extras if possible.
19+
**Note** if the extension is loaded on an x86 processor from before
20+
2013, then an illegal instruction exception will happen
21+
22+
* `Forum post <https://sqlite.org/forum/forumpost/ceba048877>`__ to provide feedback
23+
* `Site <https://sqlite.org/vec1>`__ with tutorial and
24+
reference documentation
25+
1426
Dependencies
1527
------------
1628

1729
There are no dependencies for the extensions and programs. That means
1830
they can be used on other compatible systems. Some of the programs
19-
require the SQLite library which **must** be placed in the same
20-
directory as the program.
31+
require the SQLite library alongside the program which **must** be
32+
placed in the same directory as the program if you copy the program
33+
elsewhere. (The SQLite library in that directory deliberately has a
34+
different name to avoid interactions with the standard system SQLite
35+
library.)
2136

2237
Marking
2338
-------

0 commit comments

Comments
 (0)