diff --git a/attachment_unindex_content/README.rst b/attachment_unindex_content/README.rst new file mode 100644 index 000000000..fe1f9c8ca --- /dev/null +++ b/attachment_unindex_content/README.rst @@ -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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Vauxoo + +Contributors +~~~~~~~~~~~~ + +- Moises López +- Erick Birbe + + +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 `__: + +|maintainer-moylop260| |maintainer-ebirbe| + +This module is part of the `OCA/server-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/attachment_unindex_content/__init__.py b/attachment_unindex_content/__init__.py new file mode 100644 index 000000000..cc6b6354a --- /dev/null +++ b/attachment_unindex_content/__init__.py @@ -0,0 +1,2 @@ +from . import models +from .hooks import post_init_hook diff --git a/attachment_unindex_content/__manifest__.py b/attachment_unindex_content/__manifest__.py new file mode 100644 index 000000000..c781f74b7 --- /dev/null +++ b/attachment_unindex_content/__manifest__.py @@ -0,0 +1,19 @@ +# © 2019 Vauxoo () +# 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', +} diff --git a/attachment_unindex_content/hooks.py b/attachment_unindex_content/hooks.py new file mode 100644 index 000000000..dd3e16a83 --- /dev/null +++ b/attachment_unindex_content/hooks.py @@ -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") diff --git a/attachment_unindex_content/models/__init__.py b/attachment_unindex_content/models/__init__.py new file mode 100644 index 000000000..aaf38a167 --- /dev/null +++ b/attachment_unindex_content/models/__init__.py @@ -0,0 +1 @@ +from . import ir_attachment diff --git a/attachment_unindex_content/models/ir_attachment.py b/attachment_unindex_content/models/ir_attachment.py new file mode 100644 index 000000000..2011b0386 --- /dev/null +++ b/attachment_unindex_content/models/ir_attachment.py @@ -0,0 +1,13 @@ +# 2019 Vauxoo () +# 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 diff --git a/attachment_unindex_content/readme/CONTRIBUTORS.rst b/attachment_unindex_content/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..1ed71719b --- /dev/null +++ b/attachment_unindex_content/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +- Moises López +- Erick Birbe + diff --git a/attachment_unindex_content/readme/DESCRIPTION.rst b/attachment_unindex_content/readme/DESCRIPTION.rst new file mode 100644 index 000000000..839781d97 --- /dev/null +++ b/attachment_unindex_content/readme/DESCRIPTION.rst @@ -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. diff --git a/attachment_unindex_content/static/description/index.html b/attachment_unindex_content/static/description/index.html new file mode 100644 index 000000000..ee3fe0747 --- /dev/null +++ b/attachment_unindex_content/static/description/index.html @@ -0,0 +1,446 @@ + + + + + + +Attachment Unindex Content + + + +
+

Attachment Unindex Content

+ + +

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

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 result showing indexed content

+

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

+ +
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Vauxoo
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

Current maintainers:

+

moylop260 ebirbe

+

This module is part of the OCA/server-tools project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +