How to Use Hooks for Data Patching in Odoo 19: Complete Guide

In Odoo development, data often needs to be updated when modules are installed or modified. Keeping existing records consistent is especially important in production databases that contain large amounts of data. Manual updates can become difficult and time-consuming, which is why automated data patching is commonly used. This is where hooks for data patching become useful. Hooks allow developers to execute custom logic automatically during a module's lifecycle, making it easier to update existing records efficiently and reliably. This complete step by step technical guide walks through using pre_init_hook, post_init_hook, and uninstall_hook with real Python code examples.

What Is Data Patching?

Data patching refers to the process of updating or modifying existing records in the database programmatically. Instead of manually editing records through the user interface or writing raw SQL queries, developers can use Python code to apply updates in a controlled and automated way.

Data patching is especially useful when new fields are added and need default values, existing data contains incorrect or outdated values, system configurations need to be updated, or data needs to be aligned with new business logic.

Why Use Hooks for Data Patching?

Hooks are designed to execute automatically at specific stages of a module's lifecycle, such as during installation or upgrade. This makes them highly suitable for applying data patches at the exact moment when changes are required. Instead of relying on manual updates or external scripts, hooks allow developers to embed data correction logic directly into the module. This ensures that whenever the module is installed or updated, the required data changes are applied consistently across the system.

Hooks Used for Data Patching

Odoo provides different types of hooks that execute at specific stages of a module lifecycle. In Odoo 19, all hooks receive env directly as a parameter, giving full access to the ORM and database cursor.

Setting Up the Model

Before writing any hooks, the first step is to define the field that the hooks will work with. In this example, we are adding a priority field to the existing res.partner model in Odoo. The res.partner model is the built-in model for all contacts including customers, vendors, and companies. We extend it using _inherit, which lets us add new fields and logic without touching Odoo's core code.

The priority field is what the hooks will operate on. The pre_init_hook creates its database column before installation, and the post_init_hook assigns default values to all existing partners after installation.

Using pre_init_hook

This hook runs before the module is installed. It checks if the priority column already exists in the res_partner table. If it does not exist, it creates the column directly using SQL to prepare the database safely before the ORM loads.

What happens when the module installs: Odoo checks the res_partner table in the database. If the priority column does not exist, it is created immediately using SQL before the ORM tries to load the model. This prevents any migration errors on existing databases.

Using post_init_hook

This hook runs after the module is fully installed. It finds all existing partner records that have no priority set and automatically assigns them a default value of normal. This ensures all existing data is consistent from day one.

What happens when the module installs: Odoo searches for all partner records where priority is empty. It updates them in batches of 100 at a time, writing normal as the priority value. Once complete, every existing partner in the system has a priority value without any manual work. It also saves a system parameter with the key partner_priority_update.default_priority so the uninstall_hook can find and remove it later.

Using uninstall_hook

This hook runs when the module is uninstalled. It removes the configuration data that was created during installation so no leftover data remains in the database after the module is removed.

What happens when the module uninstalls: Odoo searches for the config parameter with the key partner_priority_update.default_priority that was stored during installation. If it finds it, it deletes it. This keeps the database clean with no leftover data after the module is removed.

You can verify this by going to Settings > Technical > Parameters > System Parameters and searching for partner_priority_update. It will be visible before uninstall and gone after.

When Not to Use Hooks

Using hooks for data patching in Odoo 19 provides a powerful and automated way to maintain data consistency across modules. By leveraging hooks like pre_init_hook, post_init_hook, and uninstall_hook, developers can ensure that existing records, configurations, and system data are properly updated during installation without any manual effort. This approach not only improves efficiency but also guarantees that every deployment remains consistent and reliable. When used correctly with proper checks and optimized logic, hooks help build robust Odoo modules that are easier to maintain, scale, and deploy.