Mercurial > p > roundup > code
comparison doc/installation.txt @ 7724:68c04cc8edf7
More doc upates for FTS5 requires for sqlite and roundup > 2.1.0.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 31 Dec 2023 17:28:36 -0500 |
| parents | 3071db43bfb6 |
| children | bd126f890279 |
comparison
equal
deleted
inserted
replaced
| 7723:8147f6deac9f | 7724:68c04cc8edf7 |
|---|---|
| 609 effort than more scalable postgresql and mysql backends. | 609 effort than more scalable postgresql and mysql backends. |
| 610 | 610 |
| 611 SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last | 611 SQLite is supported via PySQLite versions 1.1.7, 2.1.0 and sqlite3 (the last |
| 612 being bundled with Python 2.5+) | 612 being bundled with Python 2.5+) |
| 613 | 613 |
| 614 Installed SQLite should be the latest version available (3.3.8 is known | 614 Installed SQLite should be the latest version available (3.9.0 or newer). |
| 615 to work, 3.1.3 is known to have problems). | 615 |
| 616 .. _fts5-testing: | |
| 616 | 617 |
| 617 Installation of Roundup 2.2.0 or newer requires that the installed | 618 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 SQLite supports FTS5. This is required even if you are not going to |
| 619 2015. However some vendors choose not to include it. You can check | 620 use FTS5 for full text searching. FTS5 was included in SQLite |
| 620 your SQLite by using the command line:: | 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:: | |
| 621 | 625 |
| 622 echo 'pragma compile_options' | sqlite3 | grep FTS5 | 626 echo 'pragma compile_options' | sqlite3 | grep FTS5 |
| 623 | 627 |
| 624 it should output ``ENABLE_FTS5`` if FTS5 is supported. | 628 it should output ``ENABLE_FTS5`` if FTS5 is supported. |
| 629 | |
| 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. | |
| 625 | 642 |
| 626 Roundup supports using `SQLite's full text search capability | 643 Roundup supports using `SQLite's full text search capability |
| 627 <admin_guide.html#sqlite-details>`_. This | 644 <admin_guide.html#sqlite-details>`_. This |
| 628 can improve searching if you are not installing another indexer like | 645 can improve searching if you are not installing another indexer like |
| 629 xapian or whoosh. It works best with English text. | 646 xapian or whoosh. It works best with English text. |