diff --git a/sql_request_abstract/README.rst b/sql_request_abstract/README.rst index 3f57b9cd4..22325e26c 100644 --- a/sql_request_abstract/README.rst +++ b/sql_request_abstract/README.rst @@ -1,17 +1,36 @@ -.. 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 - -===================================== -Abstract Model to manage SQL Requests -===================================== +==================== +SQL Request Abstract +==================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/sql_request_abstract + :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-sql_request_abstract + :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 provides an abstract model to manage SQL Select requests on database. It is not usefull for itself. You can see an exemple of implementation in the 'sql_export' module. (same repository). Implemented features --------------------- +~~~~~~~~~~~~~~~~~~~~ * Add some restrictions in the sql request: * you can only read datas. No update, deletion or creation are possible. @@ -27,6 +46,11 @@ Implemented features them, if they are valid. * SQL Request / Manager : has full access on sql requests. +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -42,52 +66,52 @@ Inherit the model: _sql_request_users_relation = 'my_model_users_rel' - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/11.0 - 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 smash it by providing detailed and welcomed feedback. +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 ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* GRAP +* Akretion Contributors ------------- +~~~~~~~~~~~~ * Florian da Costa * Sylvain LE GAL (https://twitter.com/legalsylvain) Funders -------- +~~~~~~~ The development of this module has been financially supported by: * Akretion () * GRAP, Groupement Régional Alimentaire de Proximité () -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +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/sql_request_abstract/__manifest__.py b/sql_request_abstract/__manifest__.py index 67e62c04b..e41a114da 100644 --- a/sql_request_abstract/__manifest__.py +++ b/sql_request_abstract/__manifest__.py @@ -4,7 +4,7 @@ { 'name': 'SQL Request Abstract', - 'version': '11.0.1.0.1', + 'version': '12.0.1.0.1', 'author': 'GRAP,Akretion,Odoo Community Association (OCA)', 'website': 'https://www.odoo-community.org', 'license': 'AGPL-3', diff --git a/sql_request_abstract/models/sql_request_mixin.py b/sql_request_abstract/models/sql_request_mixin.py index 8a639b070..3c18a4318 100644 --- a/sql_request_abstract/models/sql_request_mixin.py +++ b/sql_request_abstract/models/sql_request_mixin.py @@ -15,6 +15,7 @@ from odoo.exceptions import UserError class SQLRequestMixin(models.AbstractModel): _name = 'sql.request.mixin' + _description = 'SQL Request Mixin' _clean_query_enabled = True diff --git a/sql_request_abstract/readme/CONTRIBUTORS.rst b/sql_request_abstract/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..60e47e0b7 --- /dev/null +++ b/sql_request_abstract/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Florian da Costa +* Sylvain LE GAL (https://twitter.com/legalsylvain) diff --git a/sql_request_abstract/readme/DESCRIPTION.rst b/sql_request_abstract/readme/DESCRIPTION.rst new file mode 100644 index 000000000..9ea482990 --- /dev/null +++ b/sql_request_abstract/readme/DESCRIPTION.rst @@ -0,0 +1,20 @@ +This module provides an abstract model to manage SQL Select requests on database. +It is not usefull for itself. You can see an exemple of implementation in the +'sql_export' module. (same repository). + +Implemented features +~~~~~~~~~~~~~~~~~~~~ + +* Add some restrictions in the sql request: + * you can only read datas. No update, deletion or creation are possible. + * some tables are not allowed, because they could contains clear password + or keys. For the time being ('ir_config_parameter'). + +* The request can be in a 'draft' or a 'SQL Valid' status. To be valid, + the request has to be cleaned, checked and tested. All of this operations + can be disabled in the inherited modules. + +* This module two new groups: + * SQL Request / User : Can see all the sql requests by default and execute + them, if they are valid. + * SQL Request / Manager : has full access on sql requests. diff --git a/sql_request_abstract/readme/USAGE.rst b/sql_request_abstract/readme/USAGE.rst new file mode 100644 index 000000000..dc48269e7 --- /dev/null +++ b/sql_request_abstract/readme/USAGE.rst @@ -0,0 +1,11 @@ +Inherit the model: + + from odoo import models + + class MyModel(models.model) + _name = 'my.model' + _inherit = ['sql.request.mixin'] + + _sql_request_groups_relation = 'my_model_groups_rel' + + _sql_request_users_relation = 'my_model_users_rel' diff --git a/sql_request_abstract/security/res_groups.xml b/sql_request_abstract/security/res_groups.xml index 70387ca26..17f6fbc3a 100644 --- a/sql_request_abstract/security/res_groups.xml +++ b/sql_request_abstract/security/res_groups.xml @@ -16,7 +16,7 @@ License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). Manager - + diff --git a/sql_request_abstract/static/description/index.html b/sql_request_abstract/static/description/index.html new file mode 100644 index 000000000..5f352ff01 --- /dev/null +++ b/sql_request_abstract/static/description/index.html @@ -0,0 +1,441 @@ + + + + + + +SQL Request Abstract + + + +
+

SQL Request Abstract

+ + +

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

+

This module provides an abstract model to manage SQL Select requests on database. +It is not usefull for itself. You can see an exemple of implementation in the +‘sql_export’ module. (same repository).

+
+

Implemented features

+
    +
  • +
    Add some restrictions in the sql request:
    +
      +
    • you can only read datas. No update, deletion or creation are possible.
      • +
    • some tables are not allowed, because they could contains clear password +or keys. For the time being (‘ir_config_parameter’).
      • +
    +
    +
    +
    • +

  • The request can be in a ‘draft’ or a ‘SQL Valid’ status. To be valid, +the request has to be cleaned, checked and tested. All of this operations +can be disabled in the inherited modules.

    +
    • +
  • +
    This module two new groups:
    +
      +
    • SQL Request / User : Can see all the sql requests by default and execute +them, if they are valid.
      • +
    • SQL Request / Manager : has full access on sql requests.
      • +
    +
    +
    +
    • +
+

Table of contents

+ +
+

Usage

+

Inherit the model:

+
+

from openerp import models

+
+
class MyModel(models.model)
+

_name = ‘my.model’ +_inherit = [‘sql.request.mixin’]

+

_sql_request_groups_relation = ‘my_model_groups_rel’

+

_sql_request_users_relation = ‘my_model_users_rel’

+
+
+
+
+
+

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.

+
+ +
+
+

Authors

+
    +
  • GRAP
    • +
  • Akretion
    • +
+
+
+

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.

+

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.

+
+
+ +