OpenUpgrade Library

https://oca.github.io/openupgradelib
Admin
OpenUpgrade Library is a Python library providing utility functions to simplify database schema...
Tokens:20,084
Snippets:194
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install OpenUpgradeLib with easy_install

Source: https://oca.github.io/openupgradelib/installation.html

Use this command to install OpenUpgradeLib using the easy_install tool.

```bash
$ easy_install openupgradelib

```

--------------------------------

### Install OpenUpgradeLib from GitHub

Source: https://oca.github.io/openupgradelib/installation.html

Install the latest version directly from the GitHub repository to ensure you have the most recent fixes and features.

```bash
$ pip install git+git://github.com/OCA/openupgradelib.git

```

--------------------------------

### Set Up Virtual Environment and Install Locally

Source: https://oca.github.io/openupgradelib/contributing.html

Set up a virtual environment using virtualenvwrapper and install your local copy of openupgradelib in development mode.

```bash
$ mkvirtualenv openupgradelib
$ cd openupgradelib/
$ python setup.py develop

```

--------------------------------

### Install OpenUpgrade Library

Source: https://oca.github.io/openupgradelib/API.html

Install the OpenUpgrade library using pip. This command is used to add the library to your Python environment.

```bash
pip install openupgradelib
```

--------------------------------

### Install OpenUpgradeLib with pip and virtualenvwrapper

Source: https://oca.github.io/openupgradelib/installation.html

Recommended for managing project dependencies. First, create a virtual environment, then install the library using pip.

```bash
$ mkvirtualenv openupgradelib
$ pip install openupgradelib

```

--------------------------------

### openupgradelib.openupgrade.migrate

Source: https://oca.github.io/openupgradelib/API.html

Decorator for the migrate() function in migration scripts. It manages environment setup and version handling for migrations.

```APIDOC
## openupgradelib.openupgrade.migrate

### Description
Decorator for migration scripts, managing environment and versioning.

### Parameters
- **_no_version** (bool): If True, the method is considered even if the module is installed during a migration.
- **_use_env** (bool): If True, use an v8+ environment; otherwise, use a plain cursor. Defaults to True for version 10+.
- **_uid**: User ID (used when an environment is requested).
- **_context**: Context dictionary (used when an environment is requested).
```

--------------------------------

### warn_possible_dataloss

Source: https://oca.github.io/openupgradelib/API.html

Warns the user about potential data loss when a field has moved from one module to another and the new module is not installed. It counts differing values and alerts the user.

```APIDOC
## warn_possible_dataloss

### Description
Use that function in the following case: if a field of a model was moved from a ‘A’ module to a ‘B’ module. (‘B’ depend on ‘A’), This function will test if ‘B’ is installed. If not, count the number of different value and possibly warn the user. Use orm, so call from the post script.

### Parameters
#### Parameters
- **cr**: Database cursor.
- **pool**: ORM pool object.
- **old_module**: name of the old module (str).
- **fields**: list of dictionary with the following keys: ‘table’ : name of the table where the field is. ‘field’ : name of the field that are moving. ‘new_module’ : name of the new module.

### Added in version
7.0
```

--------------------------------

### Import OpenUpgrade Library

Source: https://oca.github.io/openupgradelib/usage.html

Import the library to begin using its functionalities in your Python project.

```python
import openupgradelib

```

--------------------------------

### Clone the OpenUpgrade Library Repository

Source: https://oca.github.io/openupgradelib/contributing.html

Clone your forked repository locally to begin development. Ensure you replace 'your_name_here' with your GitHub username.

```bash
$ git clone git@github.com:your_name_here/openupgradelib.git

```

--------------------------------

### rename_xmlids

Source: https://oca.github.io/openupgradelib/API.html

Renames XML IDs, typically used in pre-migration scripts. This is useful when an XML ID changes its module, for example, moving from one module to another.

```APIDOC
## rename_xmlids

### Description
Rename XML IDs. Typically called in the pre script. One usage example is when an ID changes module. In OpenERP 6 for example, a number of res_groups IDs moved to module base from other modules ( although they were still being defined in their respective module).

### Parameters
* **cr** - Database cursor
* **xmlids_spec** - a list of tuples (old module.xmlid, new module.xmlid).
* **allow_merge** - if the new ID already exists, try to merge the records. This is recommended when renaming module categories, which are generated on the fly by the Odoo database initialization routine and may resurface over a longer period of time. In general though, this option should be avoided. Renaming to existing IDs is usually an error, and because this method is usually called in the pre-stage, the applied merge method is by SQL which is incomplete and can lead to inconsistencies in the database.
```

--------------------------------

### General Methods

Source: https://oca.github.io/openupgradelib/API.html

A collection of general-purpose helper functions provided by the OpenUpgrade library.

```APIDOC
## General Methods

### Description
These are general helper functions available in the OpenUpgrade library for various migration and data manipulation tasks.

### Methods
- `add_columns()`
- `add_fields()`
- `add_ir_model_fields()`
- `add_xmlid()`
- `check_values_selection_field()`
- `chunked()`
- `clean_transient_models()`
- `column_exists()`
- `convert_field_to_html()`
- `convert_to_company_dependent()`
- `copy_columns()`
- `copy_fields_multilang()`
- `cow_templates_mark_if_equal_to_upstream()`
- `cow_templates_replicate_upstream()`
- `date_to_datetime_tz()`
- `deactivate_workflow_transitions()`
- `delete_model_workflow()`
- `delete_record_translations()`
- `delete_records_safely_by_xml_id()`
- `delete_sql_constraint_safely()`
- `disable_invalid_filters()`
- `drop_columns()`
- `float_to_integer()`
- `get_field2column_type()`
- `get_legacy_name()`
- `lift_constraints()`
- `load_data()`
- `logged_query()`
- `logging()`
- `m2o_to_x2m()`
- `map_values()`
- `merge_models()`
- `message()`
- `migrate()`
- `move_field_m2o()`
- `reactivate_workflow_transitions()`
- `remove_tables_fks()`
- `rename_columns()`
- `rename_field_references()`
- `rename_fields()`
- `rename_models()`
- `rename_property()`
- `rename_tables()`
- `rename_xmlids()`
- `safe_unlink()`
- `set_defaults()`
- `set_xml_ids_noupdate_value()`
- `table_exists()`
- `update_field_multilang()`
- `update_module_moved_fields()`
- `update_module_moved_models()`
- `update_module_moved_translations()`
- `update_module_names()`
- `update_workflow_workitems()`
- `warn_possible_dataloss()`
```

--------------------------------

### Import OpenUpgrade Library

Source: https://oca.github.io/openupgradelib/API.html

Import the OpenUpgrade library into your Python scripts. This allows you to use its helper functions.

```python
from openupgradelib import openupgrade
```

--------------------------------

### Create a New Branch for Development

Source: https://oca.github.io/openupgradelib/contributing.html

Create a new branch for your bug fix or feature development. Use a descriptive name for the branch.

```bash
$ git checkout -b name-of-your-bugfix-or-feature

```

--------------------------------

### Commit and Push Changes

Source: https://oca.github.io/openupgradelib/contributing.html

Stage, commit, and push your changes to your GitHub fork. Provide a detailed description of your changes in the commit message.

```bash
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

```

--------------------------------

### openupgradelib.openupgrade.logging

Source: https://oca.github.io/openupgradelib/API.html

A decorator to add logging to functions within OpenUpgrade scripts, useful for tracking execution time and details.

```APIDOC
## openupgradelib.openupgrade.logging

### Description
This is a decorator for any sub functions called in an OpenUpgrade script. (pre or post migration script)
Decorate functions that can take time, or for debug / development purpose.
if a function is decorated, a log will be written each time the function is called.

### Parameters
* **args_details** – if True, arguments details are given in the log
* **step** – The log will be done only every step times.

### Typical use
```python
@openupgrade.logging()
def migrate_stock_warehouses(cr)
    # some custom code

@openupgrade.logging(step=1000)
def migrate_partner(cr, partner):
    # some custom code

@openupgrade.migrate()
def migrate(cr, version):
    # some custom code
    migrate_stock_warehouses(cr)

    for partner in partners:
        migrate_partner(cr, partner)
```
```

--------------------------------

### Log Database Queries - OpenUpgrade

Source: https://oca.github.io/openupgradelib/API.html

Logs a given SQL query and the number of affected rows at the DEBUG level. Useful for monitoring query performance and impact during migrations.

```python
openupgradelib.openupgrade.logged_query(_cr_ , _query_ , _args =None_, _skip_no_result =False_)

```

--------------------------------

### Run a Subset of Unit Tests

Source: https://oca.github.io/openupgradelib/contributing.html

Execute a specific subset of unit tests by providing the module path. This is useful for quickly verifying changes in a particular area.

```python
python -m unittest tests.test_openupgradelib

```

--------------------------------

### Run Code Linters and Tests Locally

Source: https://oca.github.io/openupgradelib/contributing.html

Before committing, ensure your changes pass flake8 linting and all tests, including cross-version compatibility checks with tox.

```bash
$ flake8 openupgradelib tests
$ python setup.py test
$ tox

```

--------------------------------

### Load Data from XML, CSV, or YML - OpenUpgrade

Source: https://oca.github.io/openupgradelib/API.html

Loads data from an external file (XML, CSV, YML) into the database. This is typically used for essential or useful data marked with 'noupdate=1' that the standard upgrade mechanism might not handle.

```python
openupgradelib.openupgrade.load_data(_env_or_cr_ , _module_name_ , _filename_ , _idref =None_, _mode ='init'_)

```

--------------------------------

### Methods for OpenUpgrade 7.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 7.0.

```APIDOC
## Methods for OpenUpgrade 7.0

### Description
These methods are specific to the OpenUpgrade version 7.0.

### Methods
- `get_partner_id_from_user_id()`
- `set_partner_id_from_partner_address_id()`
```

--------------------------------

### Methods for OpenUpgrade 16.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 16.0.

```APIDOC
## Methods for OpenUpgrade 16.0

### Description
These methods are specific to the OpenUpgrade version 16.0.

### Methods
- `convert_field_bootstrap_4to5()`
- `convert_string_bootstrap_4to5()`
- `fill_analytic_distribution()`
- `migrate_translations_to_jsonb()`
```

--------------------------------

### openupgradelib.openupgrade.reactivate_workflow_transitions

Source: https://oca.github.io/openupgradelib/API.html

Reactivates workflow transitions that were previously deactivated using deactivate_workflow_transitions.

```APIDOC
## openupgradelib.openupgrade.reactivate_workflow_transitions

### Description
Reactivates workflow transitions previously deactivated.

### Parameters
- **_cr_**: Database cursor.
- **_transition_conditions**: A dictionary returned by deactivate_workflow_transitions.
```

--------------------------------

### Methods for OpenUpgrade 9.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 9.0.

```APIDOC
## Methods for OpenUpgrade 9.0

### Description
These methods are specific to the OpenUpgrade version 9.0.

### Methods
- `convert_binary_field_to_attachment()`
- `replace_account_types()`
```

--------------------------------

### Methods for OpenUpgrade 13.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 13.0.

```APIDOC
## Methods for OpenUpgrade 13.0

### Description
These methods are specific to the OpenUpgrade version 13.0.

### Methods
- `unlink_invalid_tax_tags_from_repartition_lines()`
```

--------------------------------

### Methods for OpenUpgrade 12.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 12.0.

```APIDOC
## Methods for OpenUpgrade 12.0

### Description
These methods are specific to the OpenUpgrade version 12.0.

### Methods
- `convert_field_bootstrap_3to4()`
- `convert_string_bootstrap_3to4()`
```

--------------------------------

### Methods for OpenUpgrade 8.0

Source: https://oca.github.io/openupgradelib/API.html

Specific methods introduced or relevant for OpenUpgrade version 8.0.

```APIDOC
## Methods for OpenUpgrade 8.0

### Description
These methods are specific to the OpenUpgrade version 8.0.

### Methods
- `get_last_post_for_model()`
- `set_message_last_post()`
- `update_aliases()`
```

--------------------------------

### Decorate Functions with Logging - OpenUpgrade

Source: https://oca.github.io/openupgradelib/API.html

Use this decorator for functions within OpenUpgrade scripts that may take time or require detailed logging. It logs function calls and can optionally log arguments or log only every N steps.

```python
@openupgrade.logging()
def migrate_stock_warehouses(cr)
    # some custom code

@openupgrade.logging(step=1000)
def migrate_partner(cr, partner):
    # some custom code

@openupgrade.migrate()
def migrate(cr, version):
    # some custom code
    migrate_stock_warehouses(cr)

    for partner in partners:
        migrate_partner(cr, partner)

```

--------------------------------

### openupgradelib.openupgrade.add_fields

Source: https://oca.github.io/openupgradelib/API.html

Adds all necessary components for a new field, including SQL column, ir.model.fields entry, and ir.model.data entry. Useful for pre-migration scripts.

```APIDOC
## openupgradelib.openupgrade.add_fields

### Description
This method adds all the needed stuff for having a new field populated in the DB (SQL column, ir.model.fields entry, ir.model.data entry…). It’s intended for being run in pre-migration scripts for pre-populating fields that are going to be declared later in the module. NOTE: This is not needed in >=v12, as now Odoo always add the XML-ID entry, but you can still call this method for consistency and for avoiding knowing the internal PG column type.

### Parameters
* `_env_`: Environment object.
* `_field_spec_`: List of tuples with the following expected elements for each tuple:
  * field name (string)
  * model name (string)
  * SQL table name (string): Put False if the model is already loaded in the registry and thus the SQL table name can be obtained that way.
  * field type (string): binary, boolean, char, date, datetime, float, html, integer, many2many, many2one, many2one_reference, monetary, one2many, reference, selection, text, serialized, json, properties, properties_definition. The list can vary depending on Odoo version or custom added field types.
  * SQL field type (string): If the field type is custom or if it’s one of the special cases (see get_field2column_type), you need to indicate here the SQL type to use (from the valid PostgreSQL types). Note: From >=v16, if field is translatable, SQL field type has to be explicitly stated as ‘jsonb’.
  * module name (string): for adding the XML-ID entry.
  * (optional) initialization value (any): if included in the tuple, it is set in the column for existing records.
```

--------------------------------

### openupgradelib.openupgrade.load_data

Source: https://oca.github.io/openupgradelib/API.html

Loads data from XML, CSV, or YML files during migration scripts. Useful for essential or new data that might not be loaded by the standard upgrade mechanism.

```APIDOC
## openupgradelib.openupgrade.load_data

### Description
Loads an xml, csv or yml data file from your post script. The usual case for this is the occurrence of newly added essential or useful data in the module that is marked with “noupdate=’1’” and without “forcecreate=’1’” so that it will not be loaded by the usual upgrade mechanism. Leaving the ‘mode’ argument to its default ‘init’ will load the data from your migration script.

### Parameters
* **env_or_cr** – An `cr` until Odoo 16, and an `env` is required since Odoo 17.
* **module_name** – the name of the module
* **filename** – the path to the filename, relative to the module directory. This may also be the module directory relative to –upgrade-path
* **idref** – optional hash with ?id mapping cache?
* **mode** – one of ‘init’, ‘update’, ‘demo’, ‘init_no_create’. Defaults to ‘init’. 'init_no_create' is a hack to load data for records which have forcecreate=False set.
```

--------------------------------

### openupgradelib.openupgrade.cow_templates_replicate_upstream

Source: https://oca.github.io/openupgradelib/API.html

Resets COW'd templates to their upstream equivalents. Intended for end-migration scripts.

```APIDOC
## openupgradelib.openupgrade.cow_templates_replicate_upstream

### Description
Reset COW’d templates to their upstream equivalents.
This is meant to be executed in an end-migration script.
This only makes sense if:
  1. Origin is >= v12.
  2. Website was installed. Hint: run this in website’s end-migration.
  3. You ran `cow_templates_mark_if_equal_to_upstream()` in the pre-migration.

### Parameters
- **_cr_**: Database cursor.
- **_mark_colname_** (str, optional): The name of the column used for marking equality. Defaults to None.
```

--------------------------------

### openupgradelib.openupgrade.copy_columns

Source: https://oca.github.io/openupgradelib/API.html

Copies table columns. Typically used in pre-migration scripts to prepare for schema changes.

```APIDOC
## openupgradelib.openupgrade.copy_columns

### Description
Copy table columns. Typically called in the pre script.

### Parameters
- **_cr_**: Database cursor.
- **_column_spec_**: A dictionary with table names as keys and lists of tuples as values. Each tuple consists of (old_name, new_name, type). Use None for new_name to trigger a conversion of old_name using get_legacy_name(). Use None for type to use the type of the old field. Ensure proper quoting if a column name coincides with a SQL directive (e.g., '"column"').

### Added in version
8.0
```

--------------------------------

### openupgradelib.openupgrade.logged_query

Source: https://oca.github.io/openupgradelib/API.html

Logs a given SQL query and the number of affected rows at the DEBUG level. Useful for monitoring database operations during migration.

```APIDOC
## openupgradelib.openupgrade.logged_query

### Description
Logs query and affected rows at level DEBUG.

### Parameters
* **cr** – The database cursor
* **query** – a query string suitable to pass to cursor.execute()
* **args** – a list, tuple or dictionary passed as substitution values to cursor.execute().
* **skip_no_result** – If True, then logging details are only shown if there are affected records.
```

--------------------------------

### openupgradelib.openupgrade.cow_templates_mark_if_equal_to_upstream

Source: https://oca.github.io/openupgradelib/API.html

Marks COW'd templates that are equal to their upstream equivalents. Intended for pre-migration scripts.

```APIDOC
## openupgradelib.openupgrade.cow_templates_mark_if_equal_to_upstream

### Description
Record which COW’d templates are equal to their upstream equivalents.
This is meant to be executed in a pre-migration script.
This only makes sense if:
  1. Origin is >= v12.
  2. Website was installed. Hint: run this in website’s pre-migration.
  3. You are going to run `cow_templates_replicate_upstream()` in the end-migration.

### Parameters
- **_cr_**: Database cursor.
- **_mark_colname_** (str, optional): The name of the column to mark equality. Defaults to None.
```

--------------------------------

### openupgradelib.openupgrade.chunked

Source: https://oca.github.io/openupgradelib/API.html

Iterates over a potentially large number of records in a memory and performance-friendly manner. Yields either a whole chunk or a single record at a time.

```APIDOC
## openupgradelib.openupgrade.chunked

### Description
Memory and performance friendly method to iterate over a potentially large number of records. Yields either a whole chunk or a single record at the time. Don’t nest calls to this method.

### Parameters
* `_records_`: Iterable of records.
* `_single` (optional): Defaults to True. If True, yields single records; otherwise, yields chunks.
```

--------------------------------

### convert_string_bootstrap_4to5

Source: https://oca.github.io/openupgradelib/API.html

Converts an HTML string from Bootstrap 4 to Bootstrap 5. The output can be optionally pretty-printed.

```APIDOC
## convert_string_bootstrap_4to5

### Description
Converts an HTML string from Bootstrap 4 to Bootstrap 5. The output can be optionally pretty-printed.

### Method Signature
`openupgradelib.openupgrade_160.convert_string_bootstrap_4to5(_html_string_ , _pretty_print =True_)`

### Parameters
#### Path Parameters
- **html_string** (str) - Raw HTML fragment to convert.
- **pretty_print** (bool, optional) - Indicate if you wish to return the HTML pretty formatted. Defaults to True.

### Return
- **str**: Raw HTML fragment converted.
```

--------------------------------

### openupgradelib.openupgrade.m2o_to_x2m

Source: https://oca.github.io/openupgradelib/API.html

Transforms many2one relations into one2many or many2many fields. Use with caution, especially when converting to one2many due to potential data loss.

```APIDOC
## openupgradelib.openupgrade.m2o_to_x2m

### Description
Transform many2one relations into one2many or many2many. For openupgrade < 14.0, use rename_columns in your pre-migrate script to retain the column’s old value, then call m2o_to_x2m in your post-migrate script.
WARNING: If converting to one2many, there can be data loss, because only one inverse record can be mapped in a one2many, but you can have multiple many2one pointing to the same target. Use it when the use case allows this conversion.

### Parameters
* **cr** – The database cursor
* **model** – The target model registry object
* **table** – The source table
* **field** – The new field name on the target model
* **source_field** – the (renamed) many2one column on the source table.

Added in version 8.0.
```

--------------------------------

### Map Values Between Columns - OpenUpgrade

Source: https://oca.github.io/openupgradelib/API.html

Maps old values from a source column to new values in a target column within the same model or table. Typically used in post-migration scripts. Supports mapping boolean values for 'is set' or 'is not set'.

```python
openupgradelib.openupgrade.map_values(_cr_ , _source_column_ , _target_column_ , _mapping_ , _model =None_, _table =None_, _write ='sql'_)

```

--------------------------------

### openupgradelib.openupgrade.add_columns

Source: https://oca.github.io/openupgradelib/API.html

Adds a new column to a database table. Intended for pre-migration scripts to pre-populate columns and avoid issues with computed fields.

```APIDOC
## openupgradelib.openupgrade.add_columns

### Description
This method adds a new column. It's intended for being run in pre-migration scripts for pre-populating columns to avoid the execution of new stored computed fields.

### Parameters
* `_env_`: Environment object.
* `_field_spec_`: List of tuples with the following expected elements for each tuple:
  * model name (string)
  * field name (string)
  * field type (string): binary, boolean, char, date, datetime, float, html, integer, many2many, many2one, many2one_reference, monetary, one2many, reference, selection, text, serialized, json, properties, properties_definition. The list can vary depending on Odoo version or custom added field types.
  * (optional) initialization value (any): if it contains a value different from None, it is set in the column for the existing records.
  * (optional) SQL table name (string)
  * (optional) SQL field type (string): If the field type is custom or if it’s one of the special cases (see get_field2column_type), you need to indicate here the SQL type to use (from the valid PostgreSQL types).
  * (optional) translatable (boolean): From >=v16, if field is translatable then SQL field type is changed to ‘jsonb’.
```

--------------------------------

### openupgradelib.openupgrade_120.convert_string_bootstrap_3to4

Source: https://oca.github.io/openupgradelib/API.html

Converts a given HTML string from Bootstrap 3 to Bootstrap 4 format. Optionally, the output can be pretty-printed.

```APIDOC
## openupgradelib.openupgrade_120.convert_string_bootstrap_3to4

### Description
Convert an HTML string from Bootstrap 3 to 4.

### Parameters

#### Parameters
- **html_string** (str) - Raw HTML fragment to convert.
- **pretty_print** (bool) - Indicate if you wish to return the HTML pretty formatted.

### Return
str: Raw HTML fragment converted.
```

--------------------------------

### openupgradelib.openupgrade.message

Source: https://oca.github.io/openupgradelib/API.html

A logging handler for non-critical notifications during the upgrade process. It can be extended for reporting purposes.

```APIDOC
## openupgradelib.openupgrade.message

### Description
Logs non-critical notifications about the upgrade process.

### Parameters
- **_cr_**: Database cursor.
- **_module_**: The name of the module the message concerns.
- **_table_**: The model the message concerns (can be False).
- **_column_**: The column the message concerns (can be False).
- **_message_**: The log message.
- **_*args_**: Additional arguments.
- **_**kwargs_**: Additional keyword arguments.
```

--------------------------------

### fill_analytic_distribution

Source: https://oca.github.io/openupgradelib/API.html

Converts v15 analytic accounts and tags with optional distributions to v16 analytic distributions. This method is useful for migrating analytic data structures.

```APIDOC
## fill_analytic_distribution

### Description
Converts v15 analytic accounts and tags with optional distributions to v16 analytic distributions. This method is useful for migrating analytic data structures.

### Method Signature
`openupgradelib.openupgrade_160.fill_analytic_distribution(_env_ , _table_ , _m2m_rel =False_, _m2m_column1 =False_, _m2m_column2 ='account_analytic_tag_id'_, _column ='analytic_distribution'_, _analytic_account_column ='analytic_account_id'_)`

### Parameters
#### Path Parameters
- **env** (Odoo environment) - Odoo environment.
- **table** (string) - Name of the main table (e.g., sale_order_line…).
- **m2m_rel** (string, optional) - Name of the table for the m2m field that stores v15 analytic tags (e.g., account_analytic_tag_sale_order_line_rel). If falsy, no tags are evaluated. Defaults to False.
- **m2m_column1** (string, optional) - Name of the column in the m2m table storing the ID of the record of the main table (e.g., sale_order_line_id). Defaults to False.
- **m2m_column2** (string, optional) - Name of the column in the m2m table storing the ID of the record of the analytic tag. By default, it’s “account_analytic_tag_id”. Defaults to 'account_analytic_tag_id'.
- **column** (string, optional) - Name of the column in the main table for storing the new analytic distribution. By default, it’s “analytic_distribution”. Defaults to 'analytic_distribution'.
- **analytic_account_column** (string, optional) - Name of the column in the main table for storing the old analytic account. By default, it’s analytic_account_id. Defaults to 'analytic_account_id'.
```

--------------------------------

### openupgradelib.openupgrade.add_xmlid

Source: https://oca.github.io/openupgradelib/API.html

Adds an entry in ir_model_data, typically called in the pre script. Useful for handling cases where an XML entry might have been manually created.

```APIDOC
## openupgradelib.openupgrade.add_xmlid

### Description
Adds an entry in ir_model_data. Typically called in the pre script. One usage example is when an entry has been add in the XML and there is a high probability that the user has already created the entry manually. For example, a currency was added in the XML data of the base module in OpenERP 6 but the user had already created this missing currency by hand in it’s 5.0 database. In order to avoid having 2 identical currencies (which is in fact blocked by a sql_constraint), you have to add the entry in ir_model_data before the upgrade.

### Parameters
* `_cr_`: Database cursor.
* `_module_`: Module name.
* `_xmlid_`: XML ID.
* `_model_`: Model name.
* `_res_id_`: Resource ID.
* `_noupdate` (optional): Defaults to False.
```

--------------------------------

### openupgradelib.openupgrade.add_ir_model_fields

Source: https://oca.github.io/openupgradelib/API.html

Adds new columns to ir_model_fields, typically in raw SQL during early upgrade stages. Use for fields needing specific SQL constraints.

```APIDOC
## openupgradelib.openupgrade.add_ir_model_fields

### Description
Typically, new columns on ir_model_fields need to be added in a very early stage in the upgrade process of the base module, in raw sql as they need to be in place before any model gets initialized. Do not use for fields with additional SQL constraints, such as a reference to another table or the cascade constraint, but craft your own statement taking them into account.

### Parameters
* `_cr_`: Database cursor.
* `_columnspec_`: Tuple of (column name, column type).
```

--------------------------------

### openupgradelib.openupgrade.date_to_datetime_tz

Source: https://oca.github.io/openupgradelib/API.html

Converts a date field to a datetime field, considering the user's timezone. Must be called in a post-migration script.

```APIDOC
## openupgradelib.openupgrade.date_to_datetime_tz

### Description
Take the related user’s timezone into account when converting date field to datetime in a given table. This function must be call in post migration script.

### Parameters
- **_cr_**: Database cursor.
- **_table_name_**: Name of the table where the field is.
- **_user_field_name_**: The name of the user field (res.users).
- **_date_field_name_**: The name of the old date field (Typically a legacy name, set in pre-migration script).
- **_datetime_field_name_**: The name of the new date field.

### Added in version
8.0
```

--------------------------------

### table_exists

Source: https://oca.github.io/openupgradelib/API.html

Checks if a specified table or view exists in the database.

```APIDOC
## table_exists

### Description
Check whether a certain table or view exists.

### Parameters
#### Parameters
- **_cr_**: Database cursor.
- **_table_**: table name (str).
```

--------------------------------

### Transform Many2one to One2many/Many2many - OpenUpgrade

Source: https://oca.github.io/openupgradelib/API.html

Converts many2one relations to one2many or many2many. Be cautious with one2many conversion as it may lead to data loss if multiple many2one point to the same target. Requires renaming columns in pre-migrate scripts for versions before 14.0.

```python
openupgradelib.openupgrade.m2o_to_x2m(_cr_ , _model_ , _table_ , _field_ , _source_field_)

```

--------------------------------

### openupgradelib.openupgrade.convert_field_to_html

Source: https://oca.github.io/openupgradelib/API.html

Converts a field's value to an HTML representation. This is useful for migrating text fields to HTML fields.

```APIDOC
## openupgradelib.openupgrade.convert_field_to_html

### Description
Convert field value to HTML value.

### Parameters
- **_cr_**: Database cursor.
- **_table_**: Name of the table.
- **_field_name_**: Name of the field to convert.
- **_html_field_name_**: Name of the HTML field to store the converted value.
- **_verbose_** (bool, optional): Whether to print verbose output. Defaults to True.
- **_translate_** (bool, optional): Whether to translate the field. Defaults to False.

### Version Added
7.0
```

--------------------------------

### openupgradelib.openupgrade.map_values

Source: https://oca.github.io/openupgradelib/API.html

Maps old values from a source column to new values in a target column within the same model or table, typically used in post-migration scripts.

```APIDOC
## openupgradelib.openupgrade.map_values

### Description
Map old values to new values within the same model or table. Old values presumably come from a legacy column. You will typically want to use it in post-migration scripts.

### Parameters
* **cr** – The database cursor
* **source_column** – the database column that contains old values to be mapped
* **target_column** – the database column, or model field (if ‘write’ is ‘orm’) that the new values are written to
* **mapping** – list of tuples [(old value, new value)] Old value True represents “is set”, False “is not set”. New value False represents “is not set”.
* **model** – used for writing if ‘write’ is ‘orm’, or to retrieve the table if ‘table’ is not given.
* **table** – The source table
* **write** – 'sql' or 'orm'. Defaults to 'sql'.
```

--------------------------------

### set_defaults

Source: https://oca.github.io/openupgradelib/API.html

Sets default values for fields, useful for newly required fields. This method uses the ORM and should be called from the post-migration script.

```APIDOC
## set_defaults

### Description
Set default value. Useful for fields that are newly required. Uses orm, so call from the post script.

### Parameters
* **cr** - Database cursor
* **pool** - you can pass ‘env’ as well.
* **default_spec** - Specification for default values
* **force** - If True, force setting defaults
* **use_orm** - If True, use ORM to set defaults
```

--------------------------------

### openupgradelib.openupgrade.clean_transient_models

Source: https://oca.github.io/openupgradelib/API.html

Cleans transient models to prevent issues with chained data. Intended for the base pre-migration script.

```APIDOC
## openupgradelib.openupgrade.clean_transient_models

### Description
Clean transient models to prevent possible issues due to chained data. To be run at the base pre-migration script for having a general scope. Only works on > v8.

### Parameters
* `_cr_`: Database cursor.
```

--------------------------------

### openupgradelib.openupgrade.copy_fields_multilang

Source: https://oca.github.io/openupgradelib/API.html

Copies field contents, including translations, between models and tables. Useful for migrating translatable fields.

```APIDOC
## openupgradelib.openupgrade.copy_fields_multilang

### Description
Copy field contents including translations.

### Parameters
- **_cr_**: Database cursor.
- **_destination_model_** (str): Name of the destination model where the data will be copied to.
- **_destination_table_** (str): Name of the destination table where the data will be copied to. It must be `env[destination_model]._table`.
- **_destination_columns_** (list): List of column names in the `destination_table` that will receive the copied data.
- **_relation_column_** (str): Name of a column in `destination_table` which points to IDs in `source_table`. An `INNER JOIN` will be done to update the destination records with their corresponding source records only. Records where this column is `NULL` will be skipped.
- **_source_model_** (str, optional): Name of the source model where the data will be copied from. If empty, it will default to `destination_table`.
- **_source_table_** (str, optional): Name of the source table where the data will be copied from. If empty, it will default to `destination_table`. It must be `env[source_model]._table`.
- **_source_columns_** (list, optional): List of column names in the `source_table` that will provide the copied data. If empty, it will default to `destination_columns`.
- **_translations_only_** (bool, optional): If `True`, it will only handle transferring translations. Won’t copy the raw field from `source_table`. Defaults to False.

### Added in version
12.0
```

--------------------------------

### openupgradelib.openupgrade_90.replace_account_types

Source: https://oca.github.io/openupgradelib/API.html

Replaces old account types with their new counterparts. This function is useful for migrating account type configurations.

```APIDOC
## openupgradelib.openupgrade_90.replace_account_types

### Description
Replace old account types with their replacements. The old account type is allowed not to exist anymore, except when running unit tests.

### Parameters
#### Path Parameters
- **env** (object) - Required - Odoo environment.
- **type_spec** (list) - Required - List of tuples (xmlid of old account.account.type, xmlid of new account.account.type).
- **unlink** (boolean) - Optional - Attempt to unlink the old account type.
```

--------------------------------

### openupgradelib.openupgrade_90.convert_binary_field_to_attachment

Source: https://oca.github.io/openupgradelib/API.html

Converts binary fields from Odoo 8.0 format to Odoo 9.0 attachments. This method should be called in post-migration scripts and handles the conversion of data, including MIME type guessing and file saving.

```APIDOC
## openupgradelib.openupgrade_90.convert_binary_field_to_attachment

### Description
This method converts the 8.0 binary fields to attachments like Odoo 9.0 makes with the new attachment=True attribute. It has to be called on post-migration script, as there’s a call to get the res_name of the target model, which is not yet loaded on pre-migration. You need to rename the involved column in pre-migration script if you don’t want to lose your data in the process. This method also removes after the conversion the source column for avoiding data duplication.

### Parameters
#### Path Parameters
- **env** (object) - Required - Odoo environment.
- **field_spec** (dict) - Required - A dictionary with the ORM model name as key, and as dictionary values a tuple with: field name to be converted as attachment as first element, SQL column name that contains actual data as second element. If the second element is None, then the column name is taken calling get_legacy_name method, which is the typical technique.
```

--------------------------------

### lift_constraints

Source: https://oca.github.io/openupgradelib/API.html

Lifts constraints on a specified table and column.

```APIDOC
## lift_constraints

### Description
Lifts constraints on a specified table and column.

### Parameters

#### Path Parameters
* **cr** (cursor) - DB cursor.
* **table** (string) - The table name.
* **column** (string) - The column name.
```

--------------------------------

### openupgradelib.openupgrade_120.convert_field_bootstrap_3to4

Source: https://oca.github.io/openupgradelib/API.html

Converts Bootstrap 3 HTML content in a specified model field to Bootstrap 4 format. It can filter records using a domain and choose between ORM or SQL methods for conversion.

```APIDOC
## openupgradelib.openupgrade_120.convert_field_bootstrap_3to4

### Description
This converts all the values for the given model and field, being able to restrict to a domain of affected records.

### Parameters

#### Parameters
- **env** (Odoo environment) - Odoo environment.
- **model_name** (str) - Name of the model that contains the field.
- **field_name** (str) - Name of the field that contains the BS3 HTML content.
- **domain** (Optional) - Optional domain for filtering records in the model
- **method** (str) - ‘orm’ (default) for using ORM; ‘sql’ for avoiding problems with extra triggers in ORM.
```

--------------------------------

### openupgradelib.openupgrade.move_field_m2o

Source: https://oca.github.io/openupgradelib/API.html

Migrates a Many2One field that moves from one model to another (e.g., A -> m2o -> B). Manages the migration of this field, with options for SQL updates or using a compute function.

```APIDOC
## openupgradelib.openupgrade.move_field_m2o

### Description
Migrates a Many2One field from one model to another.

### Parameters
- **_cr_**: Database cursor.
- **_pool_**: The pool object.
- **_registry_old_model_**: Registry of the source model (Model A).
- **_field_old_model_**: Name of the field to move in the source model.
- **_m2o_field_old_model_**: Name of the field in the source model's table linking to the destination model.
- **_registry_new_model_**: Registry of the destination model (Model B).
- **_field_new_model_**: Name of the field to move in the destination model.
- **_quick_request** (bool): If False, use the write function; otherwise, use UPDATE SQL. Defaults to True.
- **_compute_func**: A function to compute the new field value. Receives cr, pool, id, and vals. If not set, the most frequent value is used.
- **_binary_field** (bool): Set to True if the migrated field is a binary field.
```

--------------------------------

### openupgradelib.openupgrade.column_exists

Source: https://oca.github.io/openupgradelib/API.html

Checks if a specified column exists in a given table.

```APIDOC
## openupgradelib.openupgrade.column_exists

### Description
Checks if a specified column exists in a given table.

### Parameters
* `_cr_`: Database cursor.
* `_table_`: Name of the table.
* `_column_`: Name of the column.
```

--------------------------------

### openupgradelib.openupgrade_70.get_partner_id_from_user_id

Source: https://oca.github.io/openupgradelib/API.html

Retrieves the new partner ID associated with a given user ID. This is useful for migrating user data to partner data.

```APIDOC
## openupgradelib.openupgrade_70.get_partner_id_from_user_id

### Description
Get the new partner_id from user_id.

### Parameters
#### Path Parameters
- **_cr_** (object) - Required - Database cursor.
- **_user_id_** (integer) - Required - The user ID to look up.

### Returns
- **partner_id** (integer) - The corresponding partner ID.
```

--------------------------------

### delete_sql_constraint_safely

Source: https://oca.github.io/openupgradelib/API.html

Safely removes obsolete SQL constraints. Recommended for use in pre-migration scripts from version 14 onwards.

```APIDOC
## delete_sql_constraint_safely

### Description
In case of obsolete constraints, run this in pre-migration script. Useful from v14 onwards.

### Parameters

#### Path Parameters
* **env** (Environment) - Environment parameter.
* **module** (string) - Module where the SQL constraint was declared.
* **table** (string) - Table where the SQL constraint belongs.
* **name** (string) - Name of the SQL constraint as it was declared.
```

--------------------------------

### openupgradelib.openupgrade_80.get_last_post_for_model

Source: https://oca.github.io/openupgradelib/API.html

Retrieves the latest post date for a given set of records within a specific model. This is intended for use in post-migration scripts.

```APIDOC
## openupgradelib.openupgrade_80.get_last_post_for_model

### Description
Given a set of ids and a model pool, return a dict of each object ids with their latest message date as a value. To be called in post-migration scripts.

### Parameters
#### Path Parameters
- **cr** (object) - Required - database cursor.
- **uid** (integer) - Required - user id, assumed to be openerp.SUPERUSER_ID.
- **ids** (list) - Required - ids of the model in question to retrieve ids.
- **model_pool** (object) - Required - ORM model pool, assumed to be from pool.get().

### Returns
- **dict** - A dictionary with IDs as keys and dates as values.
```

--------------------------------

### openupgradelib.openupgrade.rename_columns

Source: https://oca.github.io/openupgradelib/API.html

Renames columns based on the provided specification.

```APIDOC
## openupgradelib.openupgrade.rename_columns

### Description
Renames columns according to the given specification.

### Parameters
- **_cr_**: Database cursor.
- **_column_spec**: A specification detailing the columns to rename.
```

--------------------------------

### convert_field_bootstrap_4to5

Source: https://oca.github.io/openupgradelib/API.html

Converts all values for a given model and field, with an option to restrict to a specific domain of affected records. It supports both ORM and SQL methods for conversion.

```APIDOC
## convert_field_bootstrap_4to5

### Description
Converts all values for a given model and field, with an option to restrict to a specific domain of affected records. It supports both ORM and SQL methods for conversion.

### Method Signature
`openupgradelib.openupgrade_160.convert_field_bootstrap_4to5(_env_ , _model_name_ , _field_name_ , _domain =None_, _method ='orm'_)`

### Parameters
#### Path Parameters
- **env** (Odoo environment) - Odoo environment.
- **model_name** (string) - Name of the model that contains the field.
- **field_name** (string) - Name of the field that contains the BS3 HTML content.
- **domain** (any, optional) - Optional domain for filtering records in the model. Defaults to None.
- **method** (string, optional) - Method for conversion: ‘orm’ (default) or ‘sql’. Defaults to 'orm'.
```

--------------------------------

### get_legacy_name

Source: https://oca.github.io/openupgradelib/API.html

Generates a versioned name for legacy tables or columns to avoid naming collisions with future or past versions.

```APIDOC
## get_legacy_name

### Description
Returns a versioned name for legacy tables/columns/etc Use this function instead of some custom name to avoid collisions with future or past legacy tables/columns/etc.

### Parameters

#### Path Parameters
* **original_name** (string) - The original name of the column.
* **version** (string) - Current version as passed to migrate().
```

--------------------------------

### migrate_translations_to_jsonb

Source: https://oca.github.io/openupgradelib/API.html

Migrates translated fields from the `ir.translation` model to jsonb columns in the respective model's table, as required in Odoo 16. This method executes provided queries to perform the migration.

```APIDOC
## migrate_translations_to_jsonb

### Description
Migrates translated fields from the `ir.translation` model to jsonb columns in the respective model's table, as required in Odoo 16. This method executes provided queries to perform the migration.

### Method Signature
`openupgradelib.openupgrade_160.migrate_translations_to_jsonb(_env_ , _fields_spec_)`

### Parameters
#### Path Parameters
- **env** (Odoo environment) - Odoo environment.
- **fields_spec** (list of tuples) - List of tuples, where each tuple contains (model name, field name) for translatable fields.
```

--------------------------------

### openupgradelib.openupgrade.deactivate_workflow_transitions

Source: https://oca.github.io/openupgradelib/API.html

Deactivates specified workflow transitions for a given model.

```APIDOC
## openupgradelib.openupgrade.deactivate_workflow_transitions

### Description
Deactivate workflow transitions.

### Parameters
- **_cr_**: Database cursor.
- **_model_**: The model for which to deactivate transitions.
- **_transitions_** (list, optional): A list of transitions to deactivate. If None, all transitions might be considered (behavior depends on implementation details not fully specified here).
```
Tokens:
Raw