Fuzzy Search

• Installation
• Configuration
• Usage
  • Usage with demo data
• Known issues / Roadmap
• Bug Tracker
• Credits
  • Authors
  • Contributors
  • Maintainers

Installation

1. The PostgreSQL extension pg_trgm should be available. In debian based distribution you have to install the postgresql-contrib module.
2. Install the pg_trgm extension to your database or give your postgresql user the SUPERUSER right (this allows the odoo module to install the extension to the database).

Configuration

If the odoo module is installed:

1. You can define GIN and GiST indexes for char and text via Settings -> Database Structure -> Trigram Index. The index name will automatically created for new entries.

Usage

1. You can create an index for the name field of res.partner.

2. In the search you can use:

   self.env['res.partner'].search([('name', '%', 'Jon Smit')])

3. In this example the function will return positive result for John Smith or John Smit.

4. You can tweak the number of strings to be returned by adjusting the set limit (default: 0.3). NB: Currently you have to set the limit by executing the following SQL statement:

   self.env.cr.execute("SELECT set_limit(0.2);")

For further questions read the Documentation of the pg_trgm module.

Known issues / Roadmap

• Modify the general search parts (e.g. in tree view or many2one fields)
• Add better order by handling
• This module will not be necessary from version 16 ([IMP] Better handling of indexes #83015)

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits