Mercurial > p > roundup > code
comparison doc/installation.txt @ 7698:4e37a7833708
doc: add FTS5 requirement for sqlite backend.
Document the requirement for FTS5 if you are using the sqlite backend.
Tonu Mikk reported issues with using a SQLite that was missing FTS5
support (RedHat 7 sqlite with python 3.6). Even though FTS5 has been
in the sqlite amalgamation since 2015-10-14 (v3.9.0) RedHat chose to
not build their package with that. This leads to a traceback when
initializing the database.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 11 Nov 2023 19:39:57 -0500 |
| parents | e9a2b74150bd |
| children | 939e2edeab40 |
comparison
equal
deleted
inserted
replaced
| 7697:c73a1177c2b2 | 7698:4e37a7833708 |
|---|---|
| 610 SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last | 610 SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last |
| 611 being bundled with Python 2.5+) | 611 being bundled with Python 2.5+) |
| 612 | 612 |
| 613 Installed SQLite should be the latest version available (3.3.8 is known | 613 Installed SQLite should be the latest version available (3.3.8 is known |
| 614 to work, 3.1.3 is known to have problems). | 614 to work, 3.1.3 is known to have problems). |
| 615 | |
| 616 Installation of Roundup 2.2.0 or newer requires that the installed | |
| 617 SQLite supports FTS5. FTS5 was supported in release 3.9.0 in October | |
| 618 2015. However some vendors choose not to include it. You can check | |
| 619 your SQLite by using the command line:: | |
| 620 | |
| 621 echo 'pragma compile_options' | sqlite3 | grep FTS5 | |
| 622 | |
| 623 it should output ``ENABLE_FTS5`` if FTS5 is supported. | |
| 615 | 624 |
| 616 Roundup supports using `SQLite's full text search capability | 625 Roundup supports using `SQLite's full text search capability |
| 617 <admin_guide.html#sqlite-details>`_. This | 626 <admin_guide.html#sqlite-details>`_. This |
| 618 can improve searching if you are not installing another indexer like | 627 can improve searching if you are not installing another indexer like |
| 619 xapian or whoosh. It works best with English text. | 628 xapian or whoosh. It works best with English text. |