Database Upgrade

This module helps you upgrade database automatically after code update and server restarting.

Table of contents

• Requirements
• Usage
  • Configuration
    • Upgrade tree view
    • Configure the version
    • Configure the version to load
  • Execute an upgrade
    • Odoo configuration
    • Execute upgrade
  • Additional features
    • Specify error management
• Known Issues
• Bug Tracker
• Credits
  • Contributors
  • Maintainer

Requirements

There are no requirements to use this module.

Usage

Configuration

Upgrade tree view

Upgrades directory must be structured like this:

project
├── upgrades
|   ├── 1.1
|   |   ├── __upgrade__.py
|   |   ├── *.sql
|   |   ├── *.py  # only for post-load
|   |   ├── *.csv  # only for post-load
|   |   ├── *.xml  # only for post-load
|   ├── 1.2
|   |   ├── __upgrade__.py
|   |   ├── *.sql
|   ├── upgrade.conf

You can find an example of upgrade in demo directory of this module.

Configure the version

Fill the file __upgrade__.py with following options:

• version
• databases: let empty if valid for all databases
• translations_to_reload: language codes list to reload in post-load
• description
• modules_to_install_at_creation: modules list to install at database creation
• modules_to_upgrade: modules list to update or to install
• pre-load: list of .sql files

• post-load: list with .sql, .py, .csv and .xml files

  • .../filename (depending on option upgrades_path) or
  • module_name/.../filename

Each Python file in post-load must have a function post_load_hook(env)

Configure the version to load

The upgrade version to load is set in file upgrade.conf, at the root of the upgrades directory, with this content (replace the version by your version number):

[options]
version=1.2

Execute an upgrade

Odoo configuration

Update your Odoo configuration file with the following options:

• upgrades_path (required): path to the upgrades directory
• stop_after_upgrades (default: False): stop server after upgrades if True

Execute upgrade

To execute an upgrade, you need to launch server with the following command:

odoo.py -c <config_file> -d <db_name> --load=web,smile_upgrade

Additional features

Specify error management

In post-load, you can replace filename string by tuple to specify error management.

Available options are:

• raise (default value): if an error is raised, stop upgrade execution by raising the error
• rollback_and_continue: if an error is raised, rollback to the savepoint set before the file execution and continue with the other files of the list
• not_rollback_and_continue: if an error is raised, no rollback is done and continue with the other files of the list

Example:

'post-load': [
    ('post-load/fix_product_pricelist.py', 'rollback_and_continue'),
],

Known Issues

Adding fields on models res.partner or res.users can result to a failure of the upgrade.

To fix that, please add in pre-load a SQL file to add field on table res_partner or res_users, by defining the type and of column, constraint and set a default value on existing records:

ALTER TABLE res_users ADD COLUMN IF NOT EXISTS my_new_boolean BOOLEAN;
UPDATE res_users SET my_new_boolean = TRUE;

These SQL requests are not required at database creation.

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 here.

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

Credits

Contributors

• Corentin POUHET-BRUNERIE

Maintainer

This module is maintained by Smile SA.

Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.