Document new kgtk implode feature to add id values.
@@ -23,7 +23,9 @@ usage: kgtk implode [-h] [-o OUTPUT_KGTK_FILE] [--reject-file REJECT_KGTK_FILE]
[--remove-prefixed-columns [REMOVE_PREFIXED_COLUMNS]]
[--ignore-unselected-types [IGNORE_UNSELECTED_TYPES]]
[--retain-unselected-types [RETAIN_UNSELECTED_TYPES]]
- [--show-data-types [SHOW_DATA_TYPES]] [-v]
+ [--build-id [BUILD_ID]] [--show-data-types [SHOW_DATA_TYPES]]
+ [--overwrite-id [optional true|false]]
+ [--verify-id-unique [optional true|false]] [-v]
[input_kgtk_file]
Copy a KGTK file, building one column (usually node2) from seperate columns for each subfield.
@@ -47,7 +49,8 @@ optional arguments:
The KGTK file into which to write rejected records
(default=None).
--column COLUMN_NAME The name of the column to explode. (default=node2).
- --prefix PREFIX The prefix for exploded column names. (default=node2;kgtk:).
+ --prefix PREFIX The prefix for exploded column names.
+ (default=node2;kgtk:).
--types [{empty,list,number,quantity,string,language_qualified_string,location_coordinates,date_and_times,extension,boolean,symbol} [{empty,list,number,quantity,string,language_qualified_string,location_coordinates,date_and_times,extension,boolean,symbol} ...]]
The KGTK data types for which fields should be imploded.
(default=['empty', 'list', 'number', 'quantity', 'string',
@@ -64,21 +67,35 @@ optional arguments:
When true, pipe characters (|) need to be escaped (\|) per
KGTK file format. (default=False).
--quantities-include-numbers [QUANTITIES_INCLUDE_NUMBERS]
- When true, numbers are acceptable quantities. (default=True).
+ When true, numbers are acceptable quantities.
+ (default=True).
--general-strings [GENERAL_STRINGS]
When true, strings may include language qualified strings.
(default=True).
--remove-prefixed-columns [REMOVE_PREFIXED_COLUMNS]
- When true, remove all columns beginning with the prefix from
- the output file. (default=False).
+ When true, remove all columns beginning with the prefix
+ from the output file. (default=False).
--ignore-unselected-types [IGNORE_UNSELECTED_TYPES]
- When true, input records with valid but unselected data types
- will be passed through to output. (default=True).
+ When true, input records with valid but unselected data
+ types will be passed through to output. (default=True).
--retain-unselected-types [RETAIN_UNSELECTED_TYPES]
- When true, input records with valid but unselected data types
- will be retain existing data on output. (default=True).
+ When true, input records with valid but unselected data
+ types will be retain existing data on output.
+ (default=True).
+ --build-id [BUILD_ID]
+ Build id values in an id column. (default=False).
--show-data-types [SHOW_DATA_TYPES]
Print the list of data types and exit. (default=False).
+ --overwrite-id [optional true|false]
+ When true, replace existing ID values. When false, copy
+ existing ID values. When --overwrite-id is omitted, it
+ defaults to False. When --overwrite-id is supplied without
+ an argument, it is True.
+ --verify-id-unique [optional true|false]
+ When true, verify ID uniqueness using an in-memory set of
+ IDs. When --verify-id-unique is omitted, it defaults to
+ False. When --verify-id-unique is supplied without an
+ argument, it is True.
-v, --verbose Print additional progress messages (default=False).
```
