Skip to content

Commit 97be984

Browse files
committed
fixed about_transform_help text
Signed-off-by: Srthkdb <[email protected]>
1 parent 32cce1b commit 97be984

File tree

1 file changed

+19
-21
lines changed

1 file changed

+19
-21
lines changed
Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,44 @@
1-
21
A transform configuration file is used to describe which transformations and
32
validations to apply to a source CSV file. This is a simple text file using YAML
43
format, using the same format as an .ABOUT file.
54

65
The attributes that can be set in a configuration file are:
76

87
* field_renamings:
9-
An optional map of source CSV column name to target CSV new column name that
10-
is used to rename CSV columns.
8+
An optional map of source CSV or JSON field name to target CSV/JSON new field name that
9+
is used to rename CSV fields.
1110

12-
For instance with this configuration the columns "Directory/Location" will be
11+
For instance with this configuration the fields "Directory/Location" will be
1312
renamed to "about_resource" and "foo" to "bar":
1413
field_renamings:
1514
'Directory/Location' : about_resource
1615
foo : bar
1716

1817
The renaming is always applied first before other transforms and checks. All
19-
other column names referenced below are these that exist AFTER the renamings
20-
have been applied to the existing column names.
18+
other field names referenced below are these that exist AFTER the renamings
19+
have been applied to the existing field names.
2120

2221
* required_fields:
23-
An optional list of required column names that must have a value, beyond the
24-
standard columns names. If a source CSV does not have such a column or a row is
25-
missing a value for a required column, an error is reported.
22+
An optional list of required field names that must have a value, beyond the
23+
standard fields names. If a source CSV/JSON does not have such a field or a row is
24+
missing a value for a required field, an error is reported.
2625

27-
For instance with this configuration an error will be reported if the columns
26+
For instance with this configuration an error will be reported if the fields
2827
"name" and "version" are missing or if any row does not have a value set for
29-
these columns:
28+
these fields:
3029
required_fields:
3130
- name
3231
- version
3332

3433
* field_filters:
35-
An optional list of column names that should be kept in the transformed CSV. If
36-
this list is provided, all the columns from the source CSV that should be kept
37-
in the target CSV must be listed be even if they are standard or required
38-
columns. If this list is not provided, all source CSV columns are kept in the
39-
transformed target CSV.
40-
41-
For instance with this configuration the target CSV will only contains the "name"
42-
and "version" columns and no other column:
34+
An optional list of field names that should be kept in the transformed CSV/JSON. If
35+
this list is provided, all the fields from the source CSV/JSON that should be kept
36+
in the target CSV/JSON must be listed be even if they are standard or required
37+
fields. If this list is not provided, all source CSV/JSON fields are kept in the
38+
transformed target CSV/JSON.
39+
40+
For instance with this configuration the target CSV/JSON will only contains the "name"
41+
and "version" fields and no other field:
4342
field_filters:
4443
- name
45-
- version
46-
44+
- version

0 commit comments

Comments
 (0)