Skip to main content

Import CSV files in the background

Project description

Beta License: AGPL-3 OCA/queue Translate me on Weblate Try me on Runbot

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

11.0.1.0.0 (2018-06-26)

  • [BREAKING] In the do method the use_connector option has changed to use_queue.

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 smashing 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.

Project details


Release history Release notifications

This version
History Node

11.0.1.0.0.99.dev3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
odoo11_addon_base_import_async-11.0.1.0.0.99.dev3-py2.py3-none-any.whl (22.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 27, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page