Skip to content

Commit

Permalink
Add documentation in the module description
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre Verkest committed Jan 9, 2015
1 parent 0c69aa7 commit 53ae7ee
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions materialized_sql_view/__openerp__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,50 @@
'version': '0.0.1',
'category': 'Tools',
'description': """
This v7.0 odoo module, add utilities to manage materialized SQL view
and add necessary user interface to interact with.
=====================
Materialized SQL VIEW
=====================
This odoo module, add utilities to manage materialized SQL view
and necessary user interface to interact with.
How to use it
-------------
You can have a look to `the basic example
<https://github.com/OCA/server-tools/blob/8.0/test_materialized_sql_view/model/
model_test_using_sql_mat_view.py>`_,
used in test module: `test_materialized_sql_view`.
You can etheir add cron to refresh the materialized view periodicly,
`here <https://github.com/OCA/server-tools/blob/8.0/test_materialized_sql_view/
data/ir_cron.xml>`
an example on the previous model
Features
--------
* UI to manage materialized Sql view, and manually launch refresh
- add `Materialized sql view Manager` group to your expected user.
- Go through `Settings > Technical > Database Structure >
Materialized SQL view` menu to manage materialized sql views
* Abstract class, to help developer to create materialized sql view
* Use postgresql materialized view if pg >= 9.3.0.
* Manage when pg version changed
* Recreate materialized sql view only if necessary, one of those change:
- sql materialized view name `_sql_mat_view_name`, this is used as search key
(so if you change it, you have to manage how to clean unecessary views and
records)
- sql definition has changed `_sql_view_definition`
- sql view name has changed `_sql_view_name`
- database version has changed
TODO
----
* Add UI on models based on materialized view. Specialy on dashboards
""",
'author': 'Pierre Verkest',
'depends': [
Expand Down

0 comments on commit 53ae7ee

Please sign in to comment.