You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

121 lines
4.7 KiB

  1. ==========================
  2. Attachment Unindex Content
  3. ==========================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
  15. :target: https://github.com/OCA/server-tools/tree/12.0/attachment_unindex_content
  16. :alt: OCA/server-tools
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-attachment_unindex_content
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/149/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module disables the indexation of attachments content.
  25. Attachment model has a field called 'index_content' where the content of the
  26. attachment is read and stored directly in the database. This field is useful in
  27. order to search content of a file. But most of cases it is not used, so, you
  28. can install this module in order to:
  29. - **Avoid Duplicating Data:** Because indexation extracts text content from
  30. files and put it on the database in order it could be searched, but this
  31. implies you have the file data in your ``filestore`` directory, and also part
  32. (or sometimes all) of that data in your database too.
  33. - **Improve Performance:** Since not all indexed files are plain text,
  34. they require extra process to read them.
  35. Maybe you could try to uninstall modules like ``document`` in order to disable
  36. its indexation features, but you could face the uninstallation of other modules
  37. that could be useful for you (e.g, ``hr_recruitment`` depends on that).
  38. But even if you don't have ``document`` installed, you'd still have plain text
  39. content indexation by default. As you can see in this SQL query results,
  40. indexation is active even without it:
  41. .. |sql_query| image:: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
  42. :target: https://user-images.githubusercontent.com/442938/67894113-45d27a80-fb2e-11e9-9a22-ba43d8b444c5.png
  43. :height: 200px
  44. :width: 400px
  45. :alt: SQL Query result showing indexed content
  46. |sql_query|
  47. Using this module you will not require to uninstall any module to disable
  48. the attachment content indexation, because we directly disable it at
  49. ``ir.attachment`` base.
  50. Also, after the installation, the ``index_content`` field on attachments
  51. already recorded in database will be cleared.
  52. **Table of contents**
  53. .. contents::
  54. :local:
  55. Bug Tracker
  56. ===========
  57. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  58. In case of trouble, please check there if your issue has already been reported.
  59. If you spotted it first, help us smashing it by providing a detailed and welcomed
  60. `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**>`_.
  61. Do not contact contributors directly about support or help with technical issues.
  62. Credits
  63. =======
  64. Authors
  65. ~~~~~~~
  66. * Vauxoo
  67. Contributors
  68. ~~~~~~~~~~~~
  69. - Moises López <moylop260@vauxoo.com>
  70. - Erick Birbe <erick@vauxoo.com>
  71. Maintainers
  72. ~~~~~~~~~~~
  73. This module is maintained by the OCA.
  74. .. image:: https://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: https://odoo-community.org
  77. OCA, or the Odoo Community Association, is a nonprofit organization whose
  78. mission is to support the collaborative development of Odoo features and
  79. promote its widespread use.
  80. .. |maintainer-moylop260| image:: https://github.com/moylop260.png?size=40px
  81. :target: https://github.com/moylop260
  82. :alt: moylop260
  83. .. |maintainer-ebirbe| image:: https://github.com/ebirbe.png?size=40px
  84. :target: https://github.com/ebirbe
  85. :alt: ebirbe
  86. Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
  87. |maintainer-moylop260| |maintainer-ebirbe|
  88. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/attachment_unindex_content>`_ project on GitHub.
  89. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.