Toggle navigation
Inizia qui

Asynchronous Import

Production/Stable License: AGPL-3 OCA/queue Translate me on Weblate Try me on Runboat

This module extends the standard CSV import functionality to import files in the background using the OCA/queue framework.

Table of contents

Usage

The user is presented with a new checkbox in the import screen. When selected, the import is delayed in a background job.

This job in turn splits the CSV file in chunks of minimum 100 lines (or more to align with record boundaries). Each chunk is then imported in a separate background job.

When an import fails, the job is marked as such and the user can read the error in the job status. The CSV chunk being imported is stored as an attachment to the job, making it easy to download it, fix it and run a new import, possibly in synchronous mode since the chunks are small.

Any file that can be imported by the standard import mechanism can also be imported in the background.

This module’s scope is limited to making standard imports asynchronous. It does not attempt to transform the data nor automate ETL flows.

Other modules may benefit from this infrastructure in the following way (as illustrated in the test suite):

  1. create an instance of base_import.import and populate its fields (res_model, file, file_name),
  2. invoke the do method with appropriate options (header, encoding, separator, quoting, use_queue, chunk_size).

Known issues / Roadmap

  • There is currently no user interface to control the chunk size, which is currently 100 by default. Should this proves to be an issue, it is easy to add an option to extend the import screen.
  • Validation cannot be run in the background.

Changelog

12.0.2.0.0 (2020-01-06)

  • Add dependency with module “queue_job_batch”, allowing the user to display the progress of the import from the top bar.

12.0.1.0.0 (2018-10-20)

  • [MIGRATION] from 11.0 branched at rev. b0945be

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Akretion
  • ACSONE SA/NV

Contributors

Sébastien Beau (Akretion) authored the initial prototype.

Stéphane Bidoul (ACSONE) extended it to version 1.0 to support multi-line records, store data to import as attachments and let the user control the asynchronous behaviour.

Other contributors include:

  • Anthony Muschang (ACSONE)
  • David Béal (Akretion)
  • Jonathan Nemry (ACSONE)
  • Laurent Mignon (ACSONE)
  • Dennis Sluijk (Onestein)

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/queue project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.