doc/api/dataimport.rst
author Laurent Peuch <cortex@worlddomination.be>
Tue, 21 May 2019 16:36:12 +0200
changeset 12685 84a8a8915512
parent 10495 5bd914ebf3ae
child 12814 75e0377ed3c2
permissions -rw-r--r--
[cubicweb-ctl] move to accepting only once instance name per command The rationals behind this decision are: - while in the past managing all instances sytem wide made a lot of sens, pratices have evolved today and we've moved to managing one instance by one - this makes things easier to debug since commands since using them on several instances were making this harder (errors hidden in the middle) - also solve the problem of the return code to have, before it was always 0 which prevented to do things like: ipython --pdb $(which cubicweb-ctl) $command $instance or shell scripts that used it - this simplify the code and is always good to take

.. _dataimport_module:

:mod:`cubicweb.dataimport`
==========================

.. automodule:: cubicweb.dataimport

    Utilities
    ---------

    .. autofunction:: count_lines

    .. autofunction:: ucsvreader_pb

    .. autofunction:: ucsvreader

    .. autofunction:: callfunc_every

    .. autofunction:: lazytable

    .. autofunction:: lazydbtable

    .. autofunction:: mk_entity

    Sanitizing/coercing functions
    -----------------------------

    .. autofunction:: optional
    .. autofunction:: required
    .. autofunction:: todatetime
    .. autofunction:: call_transform_method
    .. autofunction:: call_check_method

    Integrity functions
    -------------------

    .. autofunction:: check_doubles
    .. autofunction:: check_doubles_not_none

    Object Stores
    -------------

    .. autoclass:: ObjectStore
        :members:

    .. autoclass:: RQLObjectStore
        :show-inheritance:
        :members:

    .. autoclass:: NoHookRQLObjectStore
        :show-inheritance:
        :members:

    .. autoclass:: SQLGenObjectStore
        :show-inheritance:
        :members:

    Import Controller
    -----------------

    .. autoclass:: CWImportController
        :show-inheritance:
        :members: