Changeset 4903 for waeup/trunk


Ignore:
Timestamp:
27 Jan 2010, 12:20:18 (15 years ago)
Author:
uli
Message:

Update docs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • waeup/trunk/src/waeup/utils/batching.txt

    r4902 r4903  
    2929* supports the mode 'create', 'update', 'remove'.
    3030
    31 * creates logs and failed-data csv files.
     31* creates log entries (optional)
     32
     33* creates csv files containing successful and not-successful processed
     34  data respectively.
    3235
    3336Output
    3437------
    3538
    36 The results of processing are written to logfiles. Beside this a new
    37 CSV file is created during processing, containing only those data
    38 sets, that could not be processed.
    39 
    40 This new CSV file is called like the input file, appended by mode and
    41 '.pending'. So, when the input file is named 'foo.csv' and something
    42 went wrong during processing, then a file 'foo.csv.create.pending'
    43 will be generated (if the operation mode was 'create'). The .pending
    44 file is a CSV file that contains the failed rows appended by a column
    45 ``--ERRROR--`` in which the reasons for processing failures are
    46 listed.
     39The results of processing are written to loggers, if a logger was
     40given. Beside this new CSV files are created during processing:
     41
     42* a pending CSV file, containing datasets that could not be processed
     43
     44* a finished CSV file, containing datasets successfully processed.
     45
     46The pending file is not created if everything works fine. The
     47respective path returned in that case is ``None``.
     48
     49The pending file (if created) is a CSV file that contains the failed
     50rows appended by a column ``--ERRROR--`` in which the reasons for
     51processing failures are listed.
     52
     53The complete paths of these files are returned. They will be in a
     54temporary directory created only for this purpose. It is the caller's
     55responsibility to remove the temporay directories afterwards (the
     56datacenters distProcessedFiles() method takes care for that).
    4757
    4858It looks like this::
     
    5666      | Mode +-->|         |                 -------+
    5767      |      |   |         +----outputs-+-> /       |
    58       |      |   +---------+            |  |.pending|
    59       +------+   ^                      |  |        |
    60                  |                      |  +--------+
     68      |  +----+->+---------+            |  |.pending|
     69      +--|Log |  ^                      |  |        |
     70         +----+  |                      |  +--------+
    6171           +-----++                     v
    62            |Inter-|                  -----+
    63            |face  |                 /     |
    64            +------+                | .msg |
    65                                    |      |
    66                                    +------+
     72           |Inter-|                  ----------+
     73           |face  |                 /          |
     74           +------+                | .finished |
     75                                   |           |
     76                                   +-----------+
    6777
    6878
Note: See TracChangeset for help on using the changeset viewer.