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.

103 lines
2.9 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ============================
  5. Module Uninstallation Checks
  6. ============================
  7. This module extends the functionality of base module, to improve modules
  8. uninstallation process.
  9. It provides an extra view, on module form to display which models (SQL tables)
  10. and which fields (SQL columns) will be dropped, if the selected module is
  11. uninstalled.
  12. Technical Note
  13. ==============
  14. This module uses postgreSQL native column like reltuples in pg_class that
  15. provides approximative rows quantity. To have a precise value, please
  16. run first the following code:
  17. .. code-block:: sql
  18. REINDEX DATABASE my_database_name;
  19. Usage
  20. =====
  21. To use this module, you need to:
  22. #. Go to Settings / Modules / Local Modules
  23. #. Select an installed module
  24. #. Click on the button 'Uninstallation Impact'
  25. .. figure:: /module_uninstall_check/static/description/module_form.png
  26. :width: 800 px
  27. * Sample, selecting sale_margin module
  28. .. figure:: /module_uninstall_check/static/description/sale_margin_uninstallation.png
  29. :width: 800 px
  30. * Sample, selecting sale_stock module, when sale_margin is installed
  31. .. figure:: /module_uninstall_check/static/description/sale_uninstallation.png
  32. :width: 800 px
  33. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  34. :alt: Try me on Runbot
  35. :target: https://runbot.odoo-community.org/runbot/149/8.0
  36. Known issues / Roadmap
  37. ======================
  38. * In some cases, we want to uninstall a module, but prevent some data deletion.
  39. This can happen if we want to keep some datas after uninstallation or if the
  40. data moved into another module after a refactoring.
  41. This module could implement such feature, adding extra feature on wizard lines,
  42. deleting or renaming xml ids.
  43. * For the time being, wizard displays size used for models in database. It
  44. could be interesting to know the space released by the deletion of a column.
  45. Bug Tracker
  46. ===========
  47. Bugs are tracked on `GitHub Issues
  48. <https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
  49. check there if your issue has already been reported. If you spotted it first,
  50. help us smash it by providing detailed and welcomed feedback.
  51. Credits
  52. =======
  53. Contributors
  54. ------------
  55. * Sylvain LE GAL (https://twitter.com/legalsylvain)
  56. Funders
  57. -------
  58. The development of this module has been financially supported by:
  59. * GRAP, Groupement Régional Alimentaire de Proximité (http://www.grap.coop)
  60. Maintainer
  61. ----------
  62. .. image:: https://odoo-community.org/logo.png
  63. :alt: Odoo Community Association
  64. :target: https://odoo-community.org
  65. This module is maintained by the OCA.
  66. OCA, or the Odoo Community Association, is a nonprofit organization whose
  67. mission is to support the collaborative development of Odoo features and
  68. promote its widespread use.
  69. To contribute to this module, please visit https://odoo-community.org.