New NullStemmer, One Word List Entry per Document Type and Documentation Improvements

With this release, the documentation has been extended with a How does it work? section (1da2e80) and some limitations of the solution (5cffe74) were added as well.

A new NullStemmer has been added which can be used to disable the stemming process (9c16753). Be aware that this compromises the search functionality and will not allow to search for similar but not equal words. Also changing the stemmer requires to run indexing again.

Finally, the words table does now contain one entry per term and document_type to avoid search pollution by other document types (e2a51d1). Before, it was possible that when searching for documents of type A the inverse document frequency score has been low due to usages of the same word in documents of type B. This was especially problematic when documents of type B contained the searched word very frequently while documents of type A did not.

Upgrading from v0.2.0 to v0.3.0

As the project is still in some sort of beta phase, no semantic versioning is used. Therefore this update may be considered a major update in the semantic versioning scheme.

To upgrade, you'll have to add a new document_type column to the words table (configured table prefix omitted for clarity). Also the unique index on this table needs to be changed from the single term column to the columns ['document_type', 'term']. The easiest way to perform this task is to rollback the old migrations, publish the new ones and run them. However, re-indexing the search is required after performing the database upgrade.

New Search Feature, Additional Stemmers and Improved Documentation

• [3a4c2ab] Feature: require match for all tokens when searching
• [5ae1e69] Support laravel/scout ^7.0 besides ^8.0
• [0385a6c] Add remaining stemmers and use common base stemmer
• [9463585, af0ba49, 7fe28e0] Documentation improvements

Bugfixes

Two bugfixes have been added for this version:

• [569d060] Fix: ensure migrations use the correct database connection
• [e75437b] Fix: ensure search query works with sqlite driver

Minor Installation Fixes

The migrations were not created with the correct filename and, under certain circumstances, in wrong order.

First Release

This is a first release of the package. Please consider this code to be in a testing phase. If you encounter any issues, be it with the documentation or the code itself, please create an issue.