Skip to content

Commit

Permalink
Documented reserved column names, refs #8
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw committed Nov 12, 2021
1 parent de78320 commit 772c0c0
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ Additional options:
- `--import TEXT` - Python modules to import for `--convert`.
- `--ignore-duplicate-ids` - if a single version of a file has the same ID in it more than once, the tool will exit with an error. Use this option to ignore this and instead pick just the first of the two duplicates.

Note that `id`, `item`, `version` and `commit` are reserved column names that are used by this tool. If your data contains any of these they will be renamed to `id_`, `item_`, `version_` or `commit_` to avoid clashing with the reserved columns.

There is one exception: if you have an `id` column and use `--id id` without specifying more than one ID column, your ìd` column will be used as the item ID but will not be renamed.

### Custom conversions using --convert

This tool expects each version of the stored file to be a JSON file that looks something like this:
Expand Down

0 comments on commit 772c0c0

Please sign in to comment.