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.

109 lines
3.8 KiB

  1. ====================
  2. SQL Request Abstract
  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/sql_request_abstract
  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-sql_request_abstract
  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 provides an abstract model to manage SQL Select requests on database.
  25. It is not usefull for itself. You can see an exemple of implementation in the
  26. 'sql_export' module. (same repository).
  27. Implemented features
  28. ~~~~~~~~~~~~~~~~~~~~
  29. * Add some restrictions in the sql request:
  30. * you can only read datas. No update, deletion or creation are possible.
  31. * some tables are not allowed, because they could contains clear password
  32. or keys. For the time being ('ir_config_parameter').
  33. * The request can be in a 'draft' or a 'SQL Valid' status. To be valid,
  34. the request has to be cleaned, checked and tested. All of this operations
  35. can be disabled in the inherited modules.
  36. * This module two new groups:
  37. * SQL Request / User : Can see all the sql requests by default and execute
  38. them, if they are valid.
  39. * SQL Request / Manager : has full access on sql requests.
  40. **Table of contents**
  41. .. contents::
  42. :local:
  43. Usage
  44. =====
  45. Inherit the model:
  46. from odoo import models
  47. class MyModel(models.model)
  48. _name = 'my.model'
  49. _inherit = ['sql.request.mixin']
  50. _sql_request_groups_relation = 'my_model_groups_rel'
  51. _sql_request_users_relation = 'my_model_users_rel'
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20sql_request_abstract%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * GRAP
  64. * Akretion
  65. Contributors
  66. ~~~~~~~~~~~~
  67. * Florian da Costa <florian.dacosta@akretion.com>
  68. * Sylvain LE GAL (https://twitter.com/legalsylvain)
  69. Maintainers
  70. ~~~~~~~~~~~
  71. This module is maintained by the OCA.
  72. .. image:: https://odoo-community.org/logo.png
  73. :alt: Odoo Community Association
  74. :target: https://odoo-community.org
  75. OCA, or the Odoo Community Association, is a nonprofit organization whose
  76. mission is to support the collaborative development of Odoo features and
  77. promote its widespread use.
  78. This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.0/sql_request_abstract>`_ project on GitHub.
  79. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.