Search 1.9 billion lines of Odoo code on GitHub
smile_upgrade
<p><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/tree/15.0/smile_upgrade"><img alt="Smile-SA/odoo_addons" src="https://img.shields.io/badge/github-Smile--SA%2Fodoo_addons-lightgray.png?logo=github" /></a></p>
<a name="database-upgrade"></a>
<h2>Database Upgrade</h2>
<p>This module helps you upgrade database automatically
after code update and server restarting.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#requirements" id="id1">Requirements</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a><ul>
<li><a class="reference internal" href="#configuration" id="id3">Configuration</a><ul>
<li><a class="reference internal" href="#upgrade-tree-view" id="id4">Upgrade tree view</a></li>
<li><a class="reference internal" href="#configure-the-version" id="id5">Configure the version</a></li>
<li><a class="reference internal" href="#configure-the-version-to-load" id="id6">Configure the version to load</a></li>
</ul>
</li>
<li><a class="reference internal" href="#execute-an-upgrade" id="id7">Execute an upgrade</a><ul>
<li><a class="reference internal" href="#odoo-configuration" id="id8">Odoo configuration</a></li>
<li><a class="reference internal" href="#execute-upgrade" id="id9">Execute upgrade</a></li>
</ul>
</li>
<li><a class="reference internal" href="#additional-features" id="id10">Additional features</a></li>
</ul>
</li>
<li><a class="reference internal" href="#known-issues" id="id11">Known Issues</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id12">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id13">Credits</a><ul>
<li><a class="reference internal" href="#contributors" id="id14">Contributors</a></li>
<li><a class="reference internal" href="#maintainer" id="id15">Maintainer</a></li>
</ul>
</li>
</ul>
</div>
<a name="requirements"></a>
<h3><a class="toc-backref" href="#id1">Requirements</a></h3>
<p>There are no requirements to use this module.</p>
<a name="usage"></a>
<h3><a class="toc-backref" href="#id2">Usage</a></h3>
<a name="configuration"></a>
<h4><a class="toc-backref" href="#id3">Configuration</a></h4>
<a name="upgrade-tree-view"></a>
<h5><a class="toc-backref" href="#id4">Upgrade tree view</a></h5>
<p>Upgrades directory must be structured like this:</p>
<pre>
<code>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</code>
</pre>
<p>You can find an example of upgrade in <a class="reference external" href="smile_upgrade/demo">demo directory</a> of this module.</p>
<a name="configure-the-version"></a>
<h5><a class="toc-backref" href="#id5">Configure the version</a></h5>
<p>Fill the file <em>__upgrade__.py</em> with following options:</p>
<ul class="simple">
<li><cite>version</cite></li>
<li><cite>databases</cite>: let empty if valid for all databases</li>
<li><cite>translations_to_reload</cite>: language codes list to reload in post-load</li>
<li><cite>description</cite></li>
<li><cite>modules_to_install_at_creation</cite>: modules list to install at database creation</li>
<li><cite>modules_to_upgrade</cite>: modules list to update or to install</li>
<li><cite>pre-load</cite>: list of .sql files</li>
<li><dl class="first docutils">
<dt><cite>post-load</cite>: list with .sql, .py, .csv and .xml files</dt>
<dd><ul class="first last">
<li><cite>.../filename</cite> (depending on option <cite>upgrades_path</cite>) or</li>
<li><cite>module_name/.../filename</cite></li>
</ul>
</dd>
</dl>
</li>
</ul>
<p>Each Python file in post-load must have a function post_load_hook(env)</p>
<a name="configure-the-version-to-load"></a>
<h5><a class="toc-backref" href="#id6">Configure the version to load</a></h5>
<p>The upgrade version to load is set in file <em>upgrade.conf</em>, at the root of the <em>upgrades</em> directory, with this content (replace the version by your version number):</p>
<pre>
<code>[options]
version=1.2</code>
</pre>
<a name="execute-an-upgrade"></a>
<h4><a class="toc-backref" href="#id7">Execute an upgrade</a></h4>
<a name="odoo-configuration"></a>
<h5><a class="toc-backref" href="#id8">Odoo configuration</a></h5>
<p>Update your Odoo configuration file with the following options:</p>
<ul class="simple">
<li><cite>upgrades_path</cite> (required): path to the upgrades directory</li>
<li><cite>stop_after_upgrades</cite> (default: False): stop server after upgrades if True</li>
</ul>
<a name="execute-upgrade"></a>
<h5><a class="toc-backref" href="#id9">Execute upgrade</a></h5>
<p>To execute an upgrade, you need to launch server with the following command:</p>
<pre>
<code>odoo.py -c <config_file> -d <db_name> --load=web,smile_upgrade</code>
</pre>
<a name="additional-features"></a>
<h4 class="with-subtitle"><a class="toc-backref" href="#id10">Additional features</a></h4>
<h4 class="section-subtitle" id="specify-error-management"><span class="section-subtitle">Specify error management</span></h4>
<p>In <cite>post-load</cite>, you can replace filename string by tuple to specify error management.</p>
<p>Available options are:</p>
<ul class="simple">
<li><cite>raise</cite> (default value): if an error is raised, stop upgrade execution by raising the error</li>
<li><cite>rollback_and_continue</cite>: if an error is raised, rollback to the savepoint set before the file execution and continue with the other files of the list</li>
<li><cite>not_rollback_and_continue</cite>: if an error is raised, no rollback is done and continue with the other files of the list</li>
</ul>
<p>Example:</p>
<pre>
<code>'post-load': [
('post-load/fix_product_pricelist.py', 'rollback_and_continue'),
],</code>
</pre>
<a name="known-issues"></a>
<h3><a class="toc-backref" href="#id11">Known Issues</a></h3>
<p>Adding fields on models <cite>res.partner</cite> or <cite>res.users</cite> can result to a failure of
the upgrade.</p>
<p>To fix that, please add in <cite>pre-load</cite> a SQL file to add field on table <cite>res_partner</cite>
or <cite>res_users</cite>, by defining the type and of column, constraint and set a default value
on existing records:</p>
<pre>
<code>ALTER TABLE res_users ADD COLUMN IF NOT EXISTS my_new_boolean BOOLEAN;
UPDATE res_users SET my_new_boolean = TRUE;</code>
</pre>
<p>These SQL requests are not required at database creation.</p>
<a name="bug-tracker"></a>
<h3><a class="toc-backref" href="#id12">Bug Tracker</a></h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/Smile-SA/odoo_addons/issues/new?body=module:%20smile_upgrade%0Aversion:%215.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h3><a class="toc-backref" href="#id13">Credits</a></h3>
<a name="contributors"></a>
<h4><a class="toc-backref" href="#id14">Contributors</a></h4>
<ul class="simple">
<li>Corentin POUHET-BRUNERIE</li>
</ul>
<a name="maintainer"></a>
<h4><a class="toc-backref" href="#id15">Maintainer</a></h4>
<p>This module is maintained by Smile SA.</p>
<p>Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.</p>