{"id":409688,"date":"2023-11-15T05:12:05","date_gmt":"2023-11-15T05:12:05","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=409688"},"modified":"2023-11-15T05:12:12","modified_gmt":"2023-11-15T05:12:12","slug":"database-population-using-odoo-cli","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/database-population-using-odoo-cli\/","title":{"rendered":"Database Population using ODOO CLI"},"content":{"rendered":"\n
\"database-population-using-odoo-cli\"<\/figure>\n\n\n\n

Odoo CLI supports Database Population.<\/p>\n\n\n\n

This article gives an overview of how we can work with the Database Population in Odoo as a developer.<\/p>\n\n\n\n

Before starting this tutorial, you should have a basic idea of CLI in Odoo. Besides, If you don\u2019t have basic knowledge of Odoo CLI, read a beginner guide to Odoo CLI<\/a>.<\/strong><\/p>\n\n\n\n

Why do we need a Database Population in Odoo CLI?<\/strong><\/h2>\n\n\n\n

You can test your modules in the database by automatic data generation of the model\u2019s records<\/p>\n\n\n\n

Before moving ahead, check out our Odoo development<\/a> services & an extensive range of quality Odoo Apps<\/a>.<\/em><\/p>\n\n\n\n

How does Database Population work in Odoo CLI?<\/strong><\/h2>\n\n\n\n

Syntax<\/strong>:-<\/p>\n\n\n\n

odoo-bin populate \u2013-models product.category,product.template \u2013-size small -d demo \u2013-db_user odoo --db_password=webkul<\/pre>\n\n\n\n
Output for upper command<\/strong><\/p>\n\n\n\n
\"database-population-code\"<\/figure>\n\n\n\n
\"populated-database-odoo\"<\/figure>\n\n\n\n
Parameters<\/strong>:-<\/p>\n\n\n\n
– -models<\/strong><\/p>\n\n\n\n
list of models for which the database should be filled.<\/p>\n\n\n\n
– -size(small | medium | large)<\/strong><\/p>\n\n\n\n
The total number of the records to be created is depends on the model\u2019s populate_size<\/strong> attribute<\/p>\n\n\n\n
The generated records content is specified by the _populate_factories()<\/strong> method of a given model.<\/p>\n\n\n\n
-d<\/strong><\/p>\n\n\n\n
Name of the db<\/p>\n\n\n\n
–db_user<\/strong><\/p>\n\n\n\n
Name of the DB User<\/p>\n\n\n\n
–db_password<\/strong><\/p>\n\n\n\n
Password for the DB User<\/p>\n\n\n\n
Implement Features on a Given Model<\/strong><\/h2>\n\n\n\n
Define the following methods and attributes to populate a given model:-<\/strong><\/p>\n\n\n\n
i)<\/strong> Model._populate_sizes<\/strong><\/p>\n\n\n\n
The default population sizes are:<\/p>\n\n\n\n
Small: 10<\/p>\n\n\n\n
Medium: 100<\/p>\n\n\n\n
Large: 1000<\/p>\n\n\n\n
populate sizes are the number of records that _populate()<\/strong> should create.<\/p>\n\n\n\n
ii)<\/strong> Model._populate_dependencies<\/strong><\/p>\n\n\n\n
Return the list of models which have to be populated before the current one.<\/p>\n\n\n\n
iii)<\/strong> Model._populate(size)<\/strong><\/p>\n\n\n\n
Create records to populate this model.<\/p>\n\n\n\n
iv) Model._populate_factories()<\/strong><\/p>\n\n\n\n
Generates a factory for the different fields of the model.<\/p>\n\n\n\n
factory<\/code> is a generator of values (dict of field values).<\/p>\n\n\n\n
Factory skeleton:<\/p>\n\n\n\n
def generator(iterator, field_name, model_name):\n    for counter, values in enumerate(iterator):\n        # values.update(dict())\n        yield values<\/pre>\n\n\n\n
Note<\/strong>*: You have to define at least _populate()<\/strong> or _populate_factories()<\/strong> on the model to enable database population.<\/p>\n\n\n\n
Example:<\/strong><\/p>\n\n\n\n
from odoo.tools import populate\n\nclass WebkulModel(models.Model)\n    _inherit = "webkul.some_model"\n    _populate_sizes = {"small": 100, "medium": 2000, "large": 10000}\n    _populate_dependencies = ["webkul.some_other_model"]\n\n    def _populate_factories(self):\n        # Record ids of previously populated models are accessible in the registry\n        some_other_ids = self.env.registry.populated_models["webkul.some_other_model"]\n\n        def get_some_field(values=None, random=None, **kwargs):\n            """ Choose a value for some_field depending on other fields values.\n\n            :param dict values:\n            :param random: seeded :class:`random.Random` object\n            """\n            field_1 = values['field_1']\n            if field_1 in [value2, value3]:\n                return random.choice(some_field_values)\n            return False\n\n        return [\n            ("field_1", populate.randomize([value1, value2, value3])),\n            ("field_2", populate.randomize([value_a, value_b], [0.5, 0.5])),\n            ("some_other_id", populate.randomize(some_other_ids)),\n            ("some_field", populate.compute(get_some_field, seed="some_field")),\n            ('active', populate.cartesian([True, False])),\n        ]\n\n    def _populate(self, size):\n        records = super()._populate(size)\n\n        # If you want to update the generated records\n        # E.g setting the parent-child relationships\n        records.do_something()\n\n        return records<\/pre>\n\n\n\n
<\/p>\n\n\n\n
Population Tools<\/strong><\/h3>\n\n\n\n
Multiple population tools are available to easily create the needed data generators.<\/p>\n\n\n\n
i) odoo.tools.populate.cartesian(vals, weights=None, seed=False, formatter=<function format_str>, then=None)<\/strong><\/p>\n\n\n\n
Return a factory for an iterator of values dicts that combines all vals<\/code> for the field with the other field values in input.<\/p>\n\n\n\n
Parameters<\/em><\/strong>:<\/p>\n\n\n\n