Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[18.0][MIG] attachment_unindex_content #3097

Open
wants to merge 28 commits into
base: 18.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
6c2a4d7
[ADD] attachment_unindex_content: Module to disable file indexation
ebirbe Oct 29, 2019
9f6777f
[UPD] Update attachment_unindex_content.pot
oca-travis Nov 1, 2019
6d8a92a
[ADD] icon.png
OCA-git-bot Nov 1, 2019
44b6dc2
[IMP] attachment_unindex_content: black, isort, prettier
randall-vx Jul 3, 2021
ae45825
[MIG] attachment_unindex_content: Migration to 13.0
randall-vx Jul 3, 2021
327fc09
[UPD] Update attachment_unindex_content.pot
oca-travis Jul 7, 2021
872eea2
[UPD] README.rst
OCA-git-bot Jul 7, 2021
50b3a82
[MIG] attachment_unindex_content: Migration to 14.0
randall-vx Jul 13, 2021
079d989
[UPD] Update attachment_unindex_content.pot
oca-travis Jul 27, 2021
cc5ba03
[UPD] README.rst
OCA-git-bot Jul 27, 2021
eb52975
Added translation using Weblate (Catalan)
extrememicro Feb 14, 2022
93b606b
Added translation using Weblate (Spanish (Argentina))
ibuioli Mar 27, 2022
f62be19
Translated using Weblate (Spanish (Argentina))
ibuioli Mar 27, 2022
e54ebb9
[FIX] attachment_unindex_content: unsupported param on _index method
luisg123v Sep 28, 2022
312b115
[UPD] README.rst
OCA-git-bot Sep 28, 2022
7d60841
attachment_unindex_content 14.0.1.0.1
OCA-git-bot Sep 28, 2022
242fc4f
[MIG] attachment_unindex_content: Migration to 16.0
Rodrigosu-Vauxoo Feb 23, 2023
b4f3330
[UPD] Update attachment_unindex_content.pot
Mar 2, 2023
39d4e2d
[UPD] README.rst
OCA-git-bot Mar 2, 2023
df5974c
Update translation files
weblate Mar 2, 2023
7f26a28
[UPD] README.rst
OCA-git-bot Sep 3, 2023
7afcebf
Update translation files
weblate Oct 9, 2023
a775e6c
Added translation using Weblate (Spanish)
Ivorra78 Dec 7, 2023
facb129
Translated using Weblate (Spanish)
Ivorra78 Dec 7, 2023
7961d7f
Added translation using Weblate (Italian)
mymage Jan 2, 2024
852b92b
Translated using Weblate (Italian)
mymage Jan 2, 2024
1e5910a
[IMP] attachment_unindex_content: pre-commit auto fixes
Kimkhoi3010 Oct 7, 2024
0d9c98f
[MIG] attachment_unindex_content: Migration to 18.0
Kimkhoi3010 Oct 7, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
134 changes: 134 additions & 0 deletions attachment_unindex_content/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
==========================
Attachment Unindex Content
==========================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:ea58b36b08c5d8ff1eaf428f88f80f7171cac26df0babe83a7e95f7f54e518b6
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/18.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-18-0/server-tools-18-0-attachment_unindex_content
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0
:alt: Try me on Runboat

|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 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.

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

**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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20attachment_unindex_content%0Aversion:%2018.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]>
- Khoi (Kien Kim) <[email protected]>

Other credits
-------------

The migration of this module from 17.0 to 18.0 was financially supported
by:

- Camptocamp.

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
.. |maintainer-luisg123v| image:: https://github.com/luisg123v.png?size=40px
:target: https://github.com/luisg123v
:alt: luisg123v

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

|maintainer-moylop260| |maintainer-ebirbe| |maintainer-luisg123v|

This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.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
21 changes: 21 additions & 0 deletions attachment_unindex_content/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# © 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": "18.0.1.0.0",
"author": "Vauxoo, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/server-tools",
"maintainers": [
"moylop260",
"ebirbe",
"luisg123v",
],
"license": "AGPL-3",
"category": "Tools",
"depends": ["base"],
"installable": True,
"application": False,
"post_init_hook": "post_init_hook",
}
3 changes: 3 additions & 0 deletions attachment_unindex_content/hooks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
def post_init_hook(env):
"""Clear the indexed data for records already in database"""
env.cr.execute("UPDATE ir_attachment SET index_content=NULL")
19 changes: 19 additions & 0 deletions attachment_unindex_content/i18n/attachment_unindex_content.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * attachment_unindex_content
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \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: attachment_unindex_content
#: model:ir.model,name:attachment_unindex_content.model_ir_attachment
msgid "Attachment"
msgstr ""
20 changes: 20 additions & 0 deletions attachment_unindex_content/i18n/ca.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * attachment_unindex_content
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 14.0\n"
"Report-Msgid-Bugs-To: \n"
"Last-Translator: Automatically generated\n"
"Language-Team: none\n"
"Language: ca\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"

#. module: attachment_unindex_content
#: model:ir.model,name:attachment_unindex_content.model_ir_attachment
msgid "Attachment"
msgstr ""
22 changes: 22 additions & 0 deletions attachment_unindex_content/i18n/es.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * attachment_unindex_content
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2023-12-07 18:34+0000\n"
"Last-Translator: Ivorra78 <[email protected]>\n"
"Language-Team: none\n"
"Language: es\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.17\n"

#. module: attachment_unindex_content
#: model:ir.model,name:attachment_unindex_content.model_ir_attachment
msgid "Attachment"
msgstr "Archivo Adjunto"
31 changes: 31 additions & 0 deletions attachment_unindex_content/i18n/es_AR.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * attachment_unindex_content
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 14.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2022-03-28 01:17+0000\n"
"Last-Translator: Ignacio Buioli <[email protected]>\n"
"Language-Team: none\n"
"Language: es_AR\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.3.2\n"

#. module: attachment_unindex_content
#: model:ir.model,name:attachment_unindex_content.model_ir_attachment
msgid "Attachment"
msgstr "Adjunto"

#~ msgid "Display Name"
#~ msgstr "Mostrar Nombre"

#~ msgid "ID"
#~ msgstr "ID"

#~ msgid "Last Modified on"
#~ msgstr "Última modificación en"
22 changes: 22 additions & 0 deletions attachment_unindex_content/i18n/it.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Translation of Odoo Server.
# This file contains the translation of the following modules:
# * attachment_unindex_content
#
msgid ""
msgstr ""
"Project-Id-Version: Odoo Server 16.0\n"
"Report-Msgid-Bugs-To: \n"
"PO-Revision-Date: 2024-01-02 16:34+0000\n"
"Last-Translator: mymage <[email protected]>\n"
"Language-Team: none\n"
"Language: it\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: \n"
"Plural-Forms: nplurals=2; plural=n != 1;\n"
"X-Generator: Weblate 4.17\n"

#. module: attachment_unindex_content
#: model:ir.model,name:attachment_unindex_content.model_ir_attachment
msgid "Attachment"
msgstr "Allegato"
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
12 changes: 12 additions & 0 deletions attachment_unindex_content/models/ir_attachment.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 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, *args, **kwargs):
return False

Check warning on line 12 in attachment_unindex_content/models/ir_attachment.py

View check run for this annotation

Codecov / codecov/patch

attachment_unindex_content/models/ir_attachment.py#L12

Added line #L12 was not covered by tests
3 changes: 3 additions & 0 deletions attachment_unindex_content/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
3 changes: 3 additions & 0 deletions attachment_unindex_content/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Moises López \<<[email protected]>\>
- Erick Birbe \<<[email protected]>\>
- Khoi (Kien Kim) \<<[email protected]>\>
1 change: 1 addition & 0 deletions attachment_unindex_content/readme/CREDITS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The migration of this module from 16.0 to 18.0 was financially supported by Camptocamp.
31 changes: 31 additions & 0 deletions attachment_unindex_content/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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](https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png)](https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png)

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
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading