Skip to content

Commit df87549

Browse files
committed
More doc upates for FTS5 requires for sqlite and roundup > 2.1.0.
1 parent c8eb6db commit df87549

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

doc/installation.txt

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -611,18 +611,35 @@ mysql Fast Many Needs install/admin (MySQLdb_)
611611
SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last
612612
being bundled with Python 2.5+)
613613

614-
Installed SQLite should be the latest version available (3.3.8 is known
615-
to work, 3.1.3 is known to have problems).
614+
Installed SQLite should be the latest version available (3.9.0 or newer).
615+
616+
.. _fts5-testing:
616617

617618
Installation of Roundup 2.2.0 or newer requires that the installed
618-
SQLite supports FTS5. FTS5 was supported in release 3.9.0 in October
619-
2015. However some vendors choose not to include it. You can check
620-
your SQLite by using the command line::
619+
SQLite supports FTS5. This is required even if you are not going to
620+
use FTS5 for full text searching. FTS5 was included in SQLite
621+
release 3.9.0 in October 2015. However some vendors choose not to
622+
include it. RedHat 7's native sqlite3 is known to not work.
623+
624+
You can check your SQLite by using the command line::
621625

622626
echo 'pragma compile_options' | sqlite3 | grep FTS5
623627

624628
it should output ``ENABLE_FTS5`` if FTS5 is supported.
625629

630+
You can check using the same version of Python you use for running
631+
Roundup with::
632+
633+
import sqlite3
634+
635+
con = sqlite3.connect(':memory:')
636+
cur = con.cursor()
637+
cur.execute('pragma compile_options;')
638+
available_pragmas = cur.fetchall()
639+
con.close()
640+
641+
The output should include ``('ENABLE_FTS5',)`` in the output.
642+
626643
Roundup supports using `SQLite's full text search capability
627644
<admin_guide.html#sqlite-details>`_. This
628645
can improve searching if you are not installing another indexer like

doc/upgrading.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -709,6 +709,14 @@ to login without a password, set the ``login_empty_passwords`` setting
709709
in the ``web`` section of ``config.ini`` to ``yes``. In
710710
general this should be left at its default value of ``no``.
711711

712+
Verify that SQLite supports FTS5 (required)
713+
-------------------------------------------
714+
715+
If you use SQLite as your backend, it *must* support FTS5. See the
716+
`FTS5 testing steps`_ for how to verify this.
717+
718+
.. _FTS5 testing steps: installation.html#fts5-testing
719+
712720
Check allowed_api_origins setting (optional)
713721
--------------------------------------------
714722

0 commit comments

Comments
 (0)