Skip to content

Commit 27646f5

Browse files
committed
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.
1 parent 8a8a492 commit 27646f5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/installation.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,15 @@ mysql Fast Many Needs install/admin (MySQLdb_)
613613
Installed SQLite should be the latest version available (3.3.8 is known
614614
to work, 3.1.3 is known to have problems).
615615

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.
624+
616625
Roundup supports using `SQLite's full text search capability
617626
<admin_guide.html#sqlite-details>`_. This
618627
can improve searching if you are not installing another indexer like

0 commit comments

Comments
 (0)