diff doc/admin_guide.txt @ 7667:08e4399c3ae4

doc: document the messages generated from import/export The numbers reported when exporting/importing don't make sense unless you know how they are generated and used. Document that. Norbert Schlemmer asked about it while debugging an import issue with postgresql. So document it since I did the work.
author John Rouillard <rouilj@ieee.org>
date Thu, 19 Oct 2023 14:07:56 -0400
parents 60fc16b6a1cc
children 5b41018617f2
line wrap: on
line diff
--- a/doc/admin_guide.txt	Wed Oct 18 18:56:19 2023 -0400
+++ b/doc/admin_guide.txt	Thu Oct 19 14:07:56 2023 -0400
@@ -1475,6 +1475,73 @@
 Remember the roundup commands that accept multiple designators accept
 them ',' separated so using '-dc' is almost always required.
 
+A Note on Import and Export
+---------------------------
+
+This is a little in the weeds, but I have noticed this and was asked
+about it so I am documenting it for the future.
+
+Running ``roundup-admin`` with ``-V`` to get additional info when
+importing/exporting the tracker generates three types of messages.
+
+For example::
+
+   $ roundup-admin -i tracker -V export ./myExport
+   Exporting priority - 5
+   Exporting Journal for priority
+   Exporting status - 1
+   Exporting Journal for status
+   [...]
+
+
+   $ roundup-admin -i tracker -V import ./myExport
+   Importing priority - 7
+   setting priority 8
+   Importing status - 8
+   setting status 9
+   [...]
+
+Note the numbers for status. Exported ends up at 1, Imported ends up
+at 8 and setting chooses 9. These numbers are derived differently and
+used differently. You can't directly compare them.
+
+``Exporting issue - XXX``:
+
+   ``XXX`` is the id number of the node being exported/processed from
+   the database. The order is determined by sorting by the key of the
+   class (as set by sortkey). If the class key is 'id', then it's a
+   string sort so '9' comes before '1009'. You might notice if the
+   export is slow the numbers jumping around.
+
+   It does not usually end up as the total number of nodes
+   exported. However if it crashes, you know what node it was
+   processing at the time.
+
+   In the example above, the status node with id 1 was the last one
+   when sorted alphabetically by name.
+
+``Importing <class> - XXX``:
+
+    ``XXX`` is the number of the node (not the node id) being
+    imported/currently processed at line XXX+1 in the file. It is an
+    incrementing number starting at 0 and never jumps around. Value 0
+    is consumed when reading the header and not displayed. The final
+    value is the same as the number of objects and one less then the
+    number of lines in the file. If it crashes, you were processing
+    the line at XXX+1.
+
+``setting <class> XXX``:
+
+    ``XXX`` in the setting line should always be one more than the
+    number of imported objects. The setting value is the id for the
+    next created object of that type. So in theory the Importing
+    number should be one less than the setting number.
+
+    However under certain circumstances, Roundup can skip an id
+    number. This can lead to a difference of more than 1 between the
+    Importing and setting numbers. It's not a problem. However setting
+    can (and must) always be higher than the Importing number.
+
 
 .. _`customisation documentation`: customizing.html
 .. _`reference documentation`: reference.html

Roundup Issue Tracker: http://roundup-tracker.org/