Skip to content

Commit f6dd8d9

Browse files
fbivillerenetapopova
authored andcommitted
Preserve parameter name in tables
Move unsupported parameters by the Parquet importer to their own section.
1 parent f1de271 commit f6dd8d9

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,15 @@ The additional parameter `--input-type [csv|parquet]` is introduced to explicitl
136136
Its value defaults to CSV if it is not defined.
137137
138138
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
139-
There are indicators in the <<full-import-options-table, `neo4j-admin database import full` options>> table to point out which parameters are not supported.
139+
The following parameters are not supported (see <<full-import-options-table, `neo4j-admin database import full` options>> table for more details):
140+
141+
- `--auto-skip-subsequent-headers`
142+
- `--delimiter`
143+
- `--ignore-extra-columns`
144+
- `--input-encoding`
145+
- `--multiline-fields`
146+
- `--quote`
147+
- `--trim-strings`
140148
141149
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
142150
====
@@ -168,15 +176,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
168176
Unicode character ID can be used if prepended by `\`.
169177
|;
170178

171-
| --auto-skip-subsequent-headers[=true\|false]^1^
179+
| --auto-skip-subsequent-headers[=true\|false]
172180
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
173181
|false
174182

175183
|--bad-tolerance=<num>
176184
|Number of bad entries before the import is aborted. The import process is optimized for error-free data. Therefore, cleaning the data before importing it is highly recommended. If you encounter any bad entries during the import process, you can set the number of bad entries to a specific value that suits your needs. However, setting a high value may affect the performance of the tool.
177185
|1000
178186

179-
|--delimiter=<char>^1^
187+
|--delimiter=<char>
180188
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
181189

182190
====
@@ -225,11 +233,11 @@ Possible values are:
225233
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
226234
|false
227235

228-
|--ignore-extra-columns[=true\|false]^1^
236+
|--ignore-extra-columns[=true\|false]
229237
|If unspecified columns should be ignored during the import.
230238
|false
231239

232-
|--input-encoding=<character-set>^1^
240+
|--input-encoding=<character-set>
233241
|Character set that input data is encoded in.
234242
|UTF-8
235243

@@ -249,7 +257,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
249257
It can also be specified as a percentage of the available memory, for example `70%`.
250258
|90%
251259

252-
|--multiline-fields[=true\|false]^1^
260+
|--multiline-fields[=true\|false]
253261
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
254262

255263
Setting `--multiline-fields=true` can severely degrade the performance of the importer.
@@ -277,7 +285,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
277285
|Delete any existing database files prior to the import.
278286
|false
279287

280-
|--quote=<char>^1^
288+
|--quote=<char>
281289
|Character to treat as quotation character for values in CSV data.
282290

283291
Quotes can be escaped as per link:{rfc-4180}[RFC 4180] by doubling them, for example `""` would be interpreted as a literal `"`.
@@ -352,7 +360,7 @@ If enabled all those relationships will be found but at the cost of lower perfor
352360
performance, this value should not be greater than the number of available processors.
353361
|20
354362

355-
|--trim-strings[=true\|false]^1^
363+
|--trim-strings[=true\|false]
356364
|Whether or not strings should be trimmed for whitespaces.
357365
|false
358366

@@ -361,8 +369,6 @@ performance, this value should not be greater than the number of available proce
361369
|
362370
|===
363371

364-
^1^ __Ignored by Parquet import label:beta[].__ +
365-
366372
[NOTE]
367373
.Heap size for the import
368374
====
@@ -676,7 +682,15 @@ The additional parameter `--input-type [csv|parquet]` is introduced to explicitl
676682
Its value defaults to CSV if it is not defined.
677683
678684
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
679-
There are indicators in the <<incremental-import-options-table, `neo4j-admin database import incremental` options>> table to point out which parameters are not supported.
685+
The following parameters are not supported (see <<incremental-import-options-table, `neo4j-admin database import incremental` options>> table for more details):
686+
687+
- `--auto-skip-subsequent-headers`
688+
- `--delimiter`
689+
- `--ignore-extra-columns`
690+
- `--input-encoding`
691+
- `--multiline-fields`
692+
- `--quote`
693+
- `--trim-strings`
680694
681695
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
682696
====
@@ -708,15 +722,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
708722
Unicode character ID can be used if prepended by `\`.
709723
|;
710724

711-
| --auto-skip-subsequent-headers[=true\|false]^1^
725+
| --auto-skip-subsequent-headers[=true\|false]
712726
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
713727
|false
714728

715729
|--bad-tolerance=<num>
716730
|Number of bad entries before the import is aborted. The import process is optimized for error-free data. Therefore, cleaning the data before importing it is highly recommended. If you encounter any bad entries during the import process, you can set the number of bad entries to a specific value that suits your needs. However, setting a high value may affect the performance of the tool.
717731
|1000
718732

719-
|--delimiter=<char>^1^
733+
|--delimiter=<char>
720734
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
721735

722736
====
@@ -763,11 +777,11 @@ Possible values are:
763777
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
764778
|false
765779

766-
|--ignore-extra-columns[=true\|false]^1^
780+
|--ignore-extra-columns[=true\|false]
767781
|If unspecified columns should be ignored during the import.
768782
|false
769783

770-
|--input-encoding=<character-set>^1^
784+
|--input-encoding=<character-set>
771785
|Character set that input data is encoded in.
772786
|UTF-8
773787

@@ -787,7 +801,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
787801
It can also be specified as a percentage of the available memory, for example `70%`.
788802
|90%
789803

790-
|--multiline-fields[=true\|false]^1^
804+
|--multiline-fields[=true\|false]
791805
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
792806

793807
Setting `--multiline-fields=true` can severely degrade the performance of the importer.
@@ -811,7 +825,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
811825
|When `true`, non-array property values are converted to their equivalent Cypher types. For example, all integer values will be converted to 64-bit long integers.
812826
| true
813827

814-
|--quote=<char>^1^
828+
|--quote=<char>
815829
|Character to treat as quotation character for values in CSV data.
816830

817831
Quotes can be escaped as per link:{rfc-4180}[RFC 4180] by doubling them, for example `""` would be interpreted as a literal `"`.
@@ -895,7 +909,7 @@ If enabled all those relationships will be found but at the cost of lower perfor
895909
performance, this value should not be greater than the number of available processors.
896910
|20
897911

898-
|--trim-strings[=true\|false]^1^
912+
|--trim-strings[=true\|false]
899913
|Whether or not strings should be trimmed for whitespaces.
900914
|false
901915

@@ -904,8 +918,6 @@ performance, this value should not be greater than the number of available proce
904918
|
905919
|===
906920

907-
^1^ __Ignored by Parquet import label:beta[].__ +
908-
909921
[NOTE]
910922
.Using both a multi-value option and a positional parameter
911923
====

0 commit comments

Comments
 (0)