Skip to main content

Abstract Model to manage SQL Requests

Project description

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

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

Configuration

To configure the use of an external database, you need to edit the main configuration file of your instance and add the external database configuration with following keys : * external_db_user * external_db_password * external_db_name * external_db_host * external_db_port

Usage

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'

See implementations in the modules bi_sql_editor and sql_export. (same OCA/reporting-engine repository)

Development

This module add the ‘pgsql’ mode syntax for the ace widget. (the ace widget is used in odoo web module, but only with the xml and python mode).

The file is a copy of the file present here (https://github.com/ajaxorg/ace-builds/blob/v1.12.3/src/mode-pgsql.js (Release 18 Oct 2022)

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 to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • GRAP

  • Akretion

Contributors

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.

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.

Current maintainer:

legalsylvain

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo_addon_sql_request_abstract-18.0.1.0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_sql_request_abstract-18.0.1.0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 13f9122daf5b7e61510e2c18560fa619a34eba956e26ae5707a91e8d206bf14f
MD5 c92d8640e51eac8527532c4bc9fd3d9b
BLAKE2b-256 51bee782dd81c6ad4aced4263917a07b159593e4bd411b318f933fef30ac0d04

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page