New addon: Fuzzy Search with PostgreSQL pg_trgm extension

base_search_fuzzy/README.rst

@@ -0,0 +1,104 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+   :alt: License: AGPL-3
+
+=========================
+PostgreSQL Trigram Search
+=========================
+
+This addon provides the ability to create GIN or GiST indexes of char and text
+fields and also to use the search operator `%` in search domains. Currently
+this module doesn't change the backend search or anything else. It provides
+only the possibilty to perfrom the fuzzy search for external addons.
+
+
+Installation
+============
+
+#. The PostgreSQL extension ``pg_trgm`` should be available. In debian based
+   distribution you have to install the `postgresql-contrib` module.
+#. 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:
+
+#. 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
+=====
+
+#. You can create an index for the `name` field of `res.partner`.
+#. In the search you can use:
+
+   ``self.env['res.partner'].search([('name', '%', 'Jon Miller)])``
+
+#. In this example the function will return positive result for `John Miller` or
+   `John Mill`.
+
+#. 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 statment:
+
+   ``self.env.cr.execute("SELECT set_limit(0.2);")``
+
+#. Another interesting feature is the use of ``similarity(column, 'text')``
+   function in the ``order`` parameter to order by similarity. This module just
+   contains a basic implementation which doesn't perform validations and has to
+   start with this function. For example you can define the function as
+   followed:
+
+   ``similarity(%s.name, 'John Mil') DESC" % self.env['res.partner']._table``
+
+For further questions read the Documentation of the
+`pg_trgm <https://www.postgresql.org/docs/current/static/pgtrgm.html>`_ module.
+
+Known issues / Roadmap
+======================
+
+* Modify the general search parts (e.g. in tree view or many2one fields)
+* add better `order by` handling
+
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues
+<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
+check there if your issue has already been reported. If you spotted it first,
+help us smashing it by providing a detailed and welcomed feedback.
+
+Credits
+=======
+
+Images
+------
+
+* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+
+Contributors
+------------
+
+* Christoph Giesel <https://github.com/christophlsa>
+
+Maintainer
+----------
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+To contribute to this module, please visit https://odoo-community.org.

base_search_fuzzy/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from . import models

base_search_fuzzy/__openerp__.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+{
+    'name': "Fuzzy Search",
+    'summary': "Fuzzy search with the PostgreSQL trigram extension",
+    'category': 'Uncategorized',
+    'version': '8.0.1.0.0',
+    'website': 'https://odoo-community.org/',
+    'author': 'bloopark systems GmbH & Co. KG, '
+              'Odoo Community Association (OCA)',
+    'license': 'AGPL-3',
+    'depends': [
+        'base',
+    ],
+    'data': [
+        'views/trgm_index.xml',
+        'security/ir.model.access.csv',
+    ],
+    'installable': True,
+}

base_search_fuzzy/i18n/base_search_fuzzy.pot

@@ -0,0 +1,100 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* base_search_fuzzy
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 9.0alpha1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2016-06-24 08:47+0000\n"
+"PO-Revision-Date: 2016-06-24 08:47+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_search_fuzzy
+#: help:trgm.index,index_type:0
+msgid "Cite from PostgreSQL documentation: \"As a rule of thumb, a GIN index is faster to search than a GiST index, but slower to build or update; so GIN is better suited for static data and GiST for often-updated data.\""
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,create_uid:0
+msgid "Created by"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,create_date:0
+msgid "Created on"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,field_id:0
+msgid "Field"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: selection:trgm.index,index_type:0
+msgid "GIN"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: selection:trgm.index,index_type:0
+msgid "GiST"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,id:0
+msgid "ID"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,index_name:0
+msgid "Index Name"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,index_type:0
+msgid "Index Type"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,write_uid:0
+msgid "Last Updated by"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,write_date:0
+msgid "Last Updated on"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: model:ir.model,name:base_search_fuzzy.model_ir_model
+msgid "Models"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: help:trgm.index,index_name:0
+msgid "The index name is automatically generated like fieldname_indextype_idx. If the index already exists and the index is located in the same table then this index is resused. If the index is located in another table then a number is added at the end of the index name."
+msgstr ""
+
+#. module: base_search_fuzzy
+#: model:ir.actions.act_window,name:base_search_fuzzy.trgm_index_action
+#: model:ir.ui.menu,name:base_search_fuzzy.trgm_index_menu
+#: view:trgm.index:base_search_fuzzy.trgm_index_view_form
+#: view:trgm.index:base_search_fuzzy.trgm_index_view_tree
+msgid "Trigram Index"
+msgstr ""
+
+#. module: base_search_fuzzy
+#: help:trgm.index,field_id:0
+msgid "You can either select a field of type \"text\" or \"char\"."
+msgstr ""
+
+#. module: base_search_fuzzy
+#: code:addons/base_search_fuzzy/models/trgm_index.py:123
+#, python-format
+msgid "The pg_trgm extension does not exists or cannot be installed."
+msgstr ""

base_search_fuzzy/i18n/de.po

@@ -0,0 +1,100 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* base_search_fuzzy
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 9.0alpha1\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2016-06-24 08:49+0000\n"
+"PO-Revision-Date: 2016-06-24 08:49+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_search_fuzzy
+#: help:trgm.index,index_type:0
+msgid "Cite from PostgreSQL documentation: \"As a rule of thumb, a GIN index is faster to search than a GiST index, but slower to build or update; so GIN is better suited for static data and GiST for often-updated data.\""
+msgstr "Zitat aus der PostgreSQL Dokumentation: \"Eine Fausregel ist, ein GIN Index ist schneller durchzusuchen als ein GiST Index, aber langsamer aufzubauen und zu aktualisieren; so ist GIN besser geeignet für statische Daten und GiST für oft aktualisierte Daten.\""
+
+#. module: base_search_fuzzy
+#: field:trgm.index,create_uid:0
+msgid "Created by"
+msgstr "Erstellt durch"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,create_date:0
+msgid "Created on"
+msgstr "Erstellt am"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,field_id:0
+msgid "Field"
+msgstr "Feld"
+
+#. module: base_search_fuzzy
+#: selection:trgm.index,index_type:0
+msgid "GIN"
+msgstr "GIN"
+
+#. module: base_search_fuzzy
+#: selection:trgm.index,index_type:0
+msgid "GiST"
+msgstr "GiST"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,id:0
+msgid "ID"
+msgstr "ID"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,index_name:0
+msgid "Index Name"
+msgstr "Index Name"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,index_type:0
+msgid "Index Type"
+msgstr "Index Typ"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,write_uid:0
+msgid "Last Updated by"
+msgstr "Zuletzt aktualisiert durch"
+
+#. module: base_search_fuzzy
+#: field:trgm.index,write_date:0
+msgid "Last Updated on"
+msgstr "Zuletzt aktualisiert am"
+
+#. module: base_search_fuzzy
+#: model:ir.model,name:base_search_fuzzy.model_ir_model
+msgid "Models"
+msgstr "Datenmodelle"
+
+#. module: base_search_fuzzy
+#: help:trgm.index,index_name:0
+msgid "The index name is automatically generated like fieldname_indextype_idx. If the index already exists and the index is located in the same table then this index is resused. If the index is located in another table then a number is added at the end of the index name."
+msgstr "Der Index Name wird automatisch im Format feldname_indextyp_idx generiert. Falls der Index bereits existiert und der Index sich in der selben Tabelle befindet, dann wird dieser Index wiederverwendet. Falls der Index in einer anderen Tabelle existiert, dann wird eine Zahl an das Ende des Index Namens angefügt."
+
+#. module: base_search_fuzzy
+#: model:ir.actions.act_window,name:base_search_fuzzy.trgm_index_action
+#: model:ir.ui.menu,name:base_search_fuzzy.trgm_index_menu
+#: view:trgm.index:base_search_fuzzy.trgm_index_view_form
+#: view:trgm.index:base_search_fuzzy.trgm_index_view_tree
+msgid "Trigram Index"
+msgstr "Trigram Index"
+
+#. module: base_search_fuzzy
+#: help:trgm.index,field_id:0
+msgid "You can either select a field of type \"text\" or \"char\"."
+msgstr "Sie können entweder Felder vom Typ \"text\" oder \"char\" auswählen."
+
+#. module: base_search_fuzzy
+#: code:addons/base_search_fuzzy/models/trgm_index.py:123
+#, python-format
+msgid "The pg_trgm extension does not exists or cannot be installed."
+msgstr "Die pg_trgm Erweiterung existiert nicht oder kann nicht installiert werden."

base_search_fuzzy/models/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from . import ir_model
+from . import trgm_index