Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update local_customizations.rst #280

Merged
merged 1 commit into from
May 2, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions doc/developer-guide/local_customizations.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Customize local DB models
=========================

DISCLAIMER: This section is being rewritten with the new PostgreSQL Update Manager (PUM). The versionning logic has changed and local customization still need some more work.

Since QWAT 1.3.2, customization process and extension have been formalised.

An **extension is a core data model customization** that is part of the core. It can be activated at any time, using its own initialization script.
Expand All @@ -15,12 +13,16 @@ local customizations must be first initialized manually and then applied in QWAT
Both extension and customizations require the following :

- a init script, adding the necessary informations to the model

- a set of update scripts used when upgrading QWAT core data model :

- a pre-all.py script wich will eventually drop all additionnal views, trigger function or any dependencies locking the data model upgrade

- a set of SQL files prefixed with a version number inlined with QWAT core data model versions (ex: 1.3.1.001_local_Pully_script)

- a post-all.py script restoring the necessary dependencies once the core model and the extension/customization have been applied

to implement
A full example is provided in the customizations/sigip folder

Customizing the data model
--------------------------
Expand Down