Author: |
bloopark systems GmbH & Co. KG, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
fix/UAASDEV-4991/install_pg_trgm_extension_on_module_install |
Repository: |
EssentNovaTeam/server-tools |
Dependencies: |
base |
Languages: |
PO File (4045, 93.6%),
Python (187, 4.3%),
XML (42, 1.0%),
and
reStructuredText (47, 1.1%) |
Other branches: |
77ae6d0a,
8.0-base_trigram_index,
and
fix/UAASDEV-4991/install_pg_tgrm_extension_on_module_install |
<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="postgresql-trigram-search"></a>
<h2>PostgreSQL Trigram Search</h2>
<p>This addon provides the ability to create GIN or GiST indexes of char and text
fields. Case insensitive searches will be more performant if such indexes
exist.</p>
<a name="installation"></a>
<h3>Installation</h3>
<ol class="arabic simple">
<li>The PostgreSQL extension <code>pg_trgm</code> should be available. In debian based
distribution you have to install the <cite>postgresql-contrib</cite> module.</li>
<li>Install the <code>pg_trgm</code> extension to your database or give your postgresql
user the <code>SUPERUSER</code> right (this allows the odoo module to install the
extension to the database).</li>
</ol>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>If the odoo module is installed:</p>
<ol class="arabic simple">
<li>You can define <code>GIN</code> and <code>GiST</code> indexes for <cite>char</cite> and <cite>text</cite> via
<cite>Settings -> Database Structure -> Trigram Index</cite>. The index name will
automatically created for new entries.</li>
</ol>
<a name="usage"></a>
<h3>Usage</h3>
<ol class="arabic simple">
<li>You can create an index for the <cite>name</cite> field of <cite>res.partner</cite>.</li>
</ol>
<p>For further questions read the Documentation of the
<a class="reference external" href="https://www.postgresql.org/docs/current/static/pgtrgm.html">pg_trgm</a> module.</p>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>. 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.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Christoph Giesel <<a class="reference external" href="https://github.com/christophlsa">https://github.com/christophlsa</a>></li>
</ul>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>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.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>