Skip to main content

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
ArgumentDescription
INPUT_FILEPath to input file. (required)
OptionDescriptionDefault
-o, --output TEXTOptional output file path. If not specified, prints to stdout.
--field TEXTField name for the generated values (default: 'row_id').row_id
--type TEXTType of value: 'number' (default), 'uuid', or 'constant'.number
--start INTEGERStarting number for numeric enumeration (default: 1).1
--value TEXTConstant value to use when type is 'constant'.
-d, --delimiter TEXTCSV delimiter character (auto-detected when omitted).
--quotechar TEXTCSV quote character (iterabledata default '"' when omitted).
--encoding TEXTFile encoding (e.g., 'utf8', 'latin1').
--verbose / --no-verboseEnable verbose logging output.--no-verbose
-F, --format-in TEXTOverride input file format detection (e.g., 'csv', 'jsonl').
--table, --sheet TEXTTable or sheet name for multi-table sources (Excel, SQLite, lakehouse).
--start-page INTEGERSheet index (0-based) for Excel files.0
--trustAcknowledge pickle deserialization risk when reading pickle sources.
--on-error TEXTParse-error policy: raise (default), skip, or warn.
--error-log TEXTAppend parse errors as JSONL (use with --on-error skip or warn).
--flatten-nestedUnfold nested dict / array-of-dict fields into dotted paths (e.g. city.lat).
--max-nested-depth INTEGERWith --flatten-nested, maximum nest depth to unfold (engine default 5).
--keep-nested-parents / --no-keep-nested-parentsWith --flatten-nested, keep parent dict/array fields alongside dotted children.--keep-nested-parents
-O, --format-out TEXTOutput format (e.g. csv, jsonl, parquet). Defaults to the --output extension, or to the input's text format on stdout.

See also shared options.