enum
Adds row numbers, UUIDs, or constant values to records. Useful for adding unique identifiers or sequential numbers.
Write with --output. A trailing path is not a positional argument.
# Add row numbers (default field: row_id, starts at 1)
undatum enum data.csv --output output.csv
# Add UUIDs
undatum enum data.jsonl --field id --type uuid --output output.jsonl
# Add constant value
undatum enum data.csv --field status --type constant --value "active" --output output.csv
# Custom starting number
undatum enum data.jsonl --field sequence --start 100 --output output.jsonl
undatum enum workbook.xlsx --table Sheet2 --field row_id --output out.jsonl
Reference
Reads: any readable format · Writes: any writable format; CSV/TSV/JSON/JSON Lines on stdout · Memory: streaming · Engines: python
undatum enum [OPTIONS] INPUT_FILE
| Argument | Description |
|---|---|
INPUT_FILE | Path to input file. (required) |
| Option | Description | Default |
|---|---|---|
-o, --output TEXT | Optional output file path. If not specified, prints to stdout. | |
--field TEXT | Field name for the generated values (default: 'row_id'). | row_id |
--type TEXT | Type of value: 'number' (default), 'uuid', or 'constant'. | number |
--start INTEGER | Starting number for numeric enumeration (default: 1). | 1 |
--value TEXT | Constant value to use when type is 'constant'. | |
-d, --delimiter TEXT | CSV delimiter character (auto-detected when omitted). | |
--quotechar TEXT | CSV quote character (iterabledata default '"' when omitted). | |
--encoding TEXT | File encoding (e.g., 'utf8', 'latin1'). | |
--verbose / --no-verbose | Enable verbose logging output. | --no-verbose |
-F, --format-in TEXT | Override input file format detection (e.g., 'csv', 'jsonl'). | |
--table, --sheet TEXT | Table or sheet name for multi-table sources (Excel, SQLite, lakehouse). | |
--start-page INTEGER | Sheet index (0-based) for Excel files. | 0 |
--trust | Acknowledge pickle deserialization risk when reading pickle sources. | |
--on-error TEXT | Parse-error policy: raise (default), skip, or warn. | |
--error-log TEXT | Append parse errors as JSONL (use with --on-error skip or warn). | |
--flatten-nested | Unfold nested dict / array-of-dict fields into dotted paths (e.g. city.lat). | |
--max-nested-depth INTEGER | With --flatten-nested, maximum nest depth to unfold (engine default 5). | |
--keep-nested-parents / --no-keep-nested-parents | With --flatten-nested, keep parent dict/array fields alongside dotted children. | --keep-nested-parents |
-O, --format-out TEXT | Output format (e.g. csv, jsonl, parquet). Defaults to the --output extension, or to the input's text format on stdout. |
See also shared options.