How to Apply Length Constraints on a Character Field in Odoo

In Odoo development, you may need to ensure that users enter a minimum number of characters in a character field. For example, a name field should contain at least two characters instead of accepting a single character.

You can enforce this rule at the database level using an SQL constraint in your Odoo model. This helps maintain data consistency and prevents invalid records from being stored.

Why Are Length Constraints Useful?

Applying character-length constraints helps you:

• Maintain data quality: Prevent records with insufficient characters from being saved.
• Enforce business rules: Ensure that field values meet your application’s requirements.
• Protect database integrity: Apply validation at the database level, including when records are created or updated through different entry points.
• Reduce invalid data: Avoid incomplete or incorrectly entered values.

How to Apply a Character-Length Constraint in Odoo

You can define an SQL constraint in your model using the _sql_constraints attribute.

Example: Require at Least Two Characters

Suppose you have a name field and want to ensure that its value contains at least two characters.

from odoo import models, fields


class CustomModel(models.Model):
    _name = 'custom.model'
    _description = 'Custom Model'

    name = fields.Char(string='Name')

    _sql_constraints = [
        (
            'check_name_length',
            'CHECK(char_length(name) >= 2)',
            'Name must contain at least 2 characters.',
        ),
    ]

Key Takeaway

Using _sql_constraints is a straightforward way to enforce minimum character-length rules at the database level in Odoo. It helps maintain consistent data and ensures that the validation is not limited to the user interface.