Skip to content

Commit

Permalink
[ADD] attachment_unindex_content: Module to disable file indexation
Browse files Browse the repository at this point in the history
This module is intended to disable the indexation of data on the
ir.attachment model.

Attachment model has a field called 'index_content' where the content
of the attachment is read and stored directly in the database. This field is
useful in order to search content of a file. But most of cases it is not used,
so, you can install this module in order to:

- **Avoid Duplicating Data:** Because indexation extracts text content
from files and put it on the database in order it could be searched, but
this implies you have the file data in your `filestore` directory, and
also part (or sometimes all) of that data in your database too.
- **Improve Performance:** Since not all indexed files are plain text, they
require extra process to read them.

Maybe you could try to uninstall modules like `document` in order to
disable its indexation features, but you could face the uninstallation of other
modules that could be useful for you (e.g, `hr_recruitment` depends on that).

But even if you don't have `document` installed, you'd still have
plain text content indexation by default.

Using this module you will not require to uninstall any module to
disable the attachment content indexation, because we directly disable it at
`ir.attachment` base.
  • Loading branch information
ebirbe authored and Rodrigosu-Vauxoo committed Feb 23, 2023
1 parent 7fdeff0 commit 4ee1903
Show file tree
Hide file tree
Showing 9 changed files with 646 additions and 0 deletions.
121 changes: 121 additions & 0 deletions attachment_unindex_content/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
==========================
Attachment Unindex Content
==========================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/12.0/attachment_unindex_content
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-attachment_unindex_content
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/12.0
:alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|

This module disables the indexation of attachments content.

Attachment model has a field called 'index_content' where the content of the
attachment is read and stored directly in the database. This field is useful in
order to search content of a file. But most of cases it is not used, so, you
can install this module in order to:

- **Avoid Duplicating Data:** Because indexation extracts text content from
files and put it on the database in order it could be searched, but this
implies you have the file data in your ``filestore`` directory, and also part
(or sometimes all) of that data in your database too.
- **Improve Performance:** Since not all indexed files are plain text,
they require extra process to read them.

Maybe you could try to uninstall modules like ``document`` in order to disable
its indexation features, but you could face the uninstallation of other modules
that could be useful for you (e.g, ``hr_recruitment`` depends on that).

But even if you don't have ``document`` installed, you'd still have plain text
content indexation by default. As you can see in this SQL query results,
indexation is active even without it:

.. |sql_query| image:: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
:target: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
:height: 200px
:width: 400px
:alt: SQL Query result showing indexed content

|sql_query|

Using this module you will not require to uninstall any module to disable
the attachment content indexation, because we directly disable it at
``ir.attachment`` base.

Also, after the installation, the ``index_content`` field on attachments
already recorded in database will be cleared.

**Table of contents**

.. contents::
:local:

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 <https://github.com/OCA/server-tools/issues/new?body=module:%20attachment_unindex_content%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
~~~~~~~

* Vauxoo

Contributors
~~~~~~~~~~~~

- Moises López <[email protected]>
- Erick Birbe <[email protected]>


Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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.

.. |maintainer-moylop260| image:: https://github.com/moylop260.png?size=40px
:target: https://github.com/moylop260
:alt: moylop260
.. |maintainer-ebirbe| image:: https://github.com/ebirbe.png?size=40px
:target: https://github.com/ebirbe
:alt: ebirbe

Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-moylop260| |maintainer-ebirbe|

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/attachment_unindex_content>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions attachment_unindex_content/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from .hooks import post_init_hook
19 changes: 19 additions & 0 deletions attachment_unindex_content/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# © 2019 Vauxoo (<http://www.vauxoo.com/>)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

{
'name': 'Attachment Unindex Content',
'summary': 'Disable indexing of attachments',
'version': '12.0.1.0.0',
'author': 'Vauxoo, Odoo Community Association (OCA)',
'website': 'https://github.com/OCA/server-tools',
'maintainers': ['moylop260', 'ebirbe'],
'license': 'AGPL-3',
'category': 'Tools',
'depends': [
'base',
],
'installable': True,
'application': False,
'post_init_hook': 'post_init_hook',
}
5 changes: 5 additions & 0 deletions attachment_unindex_content/hooks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@


def post_init_hook(cr, registry):
"""Clear the indexed data for records already in database"""
cr.execute("UPDATE ir_attachment SET index_content=NULL")
1 change: 1 addition & 0 deletions attachment_unindex_content/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import ir_attachment
13 changes: 13 additions & 0 deletions attachment_unindex_content/models/ir_attachment.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 2019 Vauxoo (<http://www.vauxoo.com/>)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

from odoo import api, models


class IrAttachment(models.Model):

_inherit = "ir.attachment"

@api.model
def _index(self, bin_data, datas_fname, file_type):
return False
3 changes: 3 additions & 0 deletions attachment_unindex_content/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Moises López <[email protected]>
- Erick Birbe <[email protected]>

36 changes: 36 additions & 0 deletions attachment_unindex_content/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
This module disables the indexation of attachments content.

Attachment model has a field called 'index_content' where the content of the
attachment is read and stored directly in the database. This field is useful in
order to search content of a file. But most of cases it is not used, so, you
can install this module in order to:

- **Avoid Duplicating Data:** Because indexation extracts text content from
files and put it on the database in order it could be searched, but this
implies you have the file data in your ``filestore`` directory, and also part
(or sometimes all) of that data in your database too.
- **Improve Performance:** Since not all indexed files are plain text,
they require extra process to read them.

Maybe you could try to uninstall modules like ``document`` in order to disable
its indexation features, but you could face the uninstallation of other modules
that could be useful for you (e.g, ``hr_recruitment`` depends on that).

But even if you don't have ``document`` installed, you'd still have plain text
content indexation by default. As you can see in this SQL query results,
indexation is active even without it:

.. |sql_query| image:: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
:target: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
:height: 200px
:width: 400px
:alt: SQL Query result showing indexed content

|sql_query|

Using this module you will not require to uninstall any module to disable
the attachment content indexation, because we directly disable it at
``ir.attachment`` base.

Also, after the installation, the ``index_content`` field on attachments
already recorded in database will be cleared.
Loading

0 comments on commit 4ee1903

Please sign in to comment.