Skip to content

Commit c1adf81

Browse files
renetapopovarenetapopova
committed
Document --multiline-fields-format option (neo4j#1935)
1 parent e989f11 commit c1adf81

File tree

1 file changed

+33
-24
lines changed

1 file changed

+33
-24
lines changed

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

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,18 @@ The syntax for importing a set of CSV files is:
8585
----
8686
neo4j-admin database import full [-h] [--expand-commands] [--verbose] [--auto-skip-subsequent-headers[=true|false]]
8787
[--ignore-empty-strings[=true|false]] [--ignore-extra-columns[=true|false]]
88-
[--legacy-style-quoting[=true|false]] [--multiline-fields[=true|false]]
89-
[--normalize-types[=true|false]] [--overwrite-destination[=true|false]]
90-
[--skip-bad-entries-logging[=true|false]] [--skip-bad-relationships[=true|false]]
91-
[--skip-duplicate-nodes[=true|false]] [--strict[=true|false]] [--trim-strings[=true|false]]
92-
[--additional-config=<file>] [--array-delimiter=<char>] [--bad-tolerance=<num>]
93-
[--delimiter=<char>] [--format=<format>] [--high-parallel-io=on|off|auto]
94-
[--id-type=string|integer|actual] [--input-encoding=<character-set>]
95-
[--input-type=csv|parquet] [--max-off-heap-memory=<size>] [--quote=<char>]
96-
[--read-buffer-size=<size>] [--report-file=<path>] [--schema=<path>] [--threads=<num>]
97-
--nodes=[<label>[: <label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]...
98-
[--relationships=[<type>=]<files>...]... <database>
88+
[--legacy-style-quoting[=true|false]] [--normalize-types[=true|false]]
89+
[--overwrite-destination[=true|false]] [--skip-bad-entries-logging[=true|false]]
90+
[--skip-bad-relationships[=true|false]] [--skip-duplicate-nodes[=true|false]] [--strict
91+
[=true|false]] [--trim-strings[=true|false]] [--additional-config=<file>]
92+
[--array-delimiter=<char>] [--bad-tolerance=<num>] [--delimiter=<char>]
93+
[--format=<format>] [--high-parallel-io=on|off|auto] [--id-type=string|integer|actual]
94+
[--input-encoding=<character-set>] [--input-type=csv|parquet]
95+
[--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>]
96+
[--report-file=<path>] [--schema=<path>] [--threads=<num>] --nodes=[<label>[:
97+
<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]...
98+
[--relationships=[<type>=]<files>...]... [--multiline-fields=true|false|<path>[,
99+
<path>] [--multiline-fields-format=v1|v2]] <database>
99100
----
100101

101102
=== Description
@@ -256,9 +257,9 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
256257
It can also be specified as a percentage of the available memory, for example `70%`.
257258
|90%
258259

259-
|--multiline-fields[=true\|false]
260-
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
261-
| null
260+
|--multiline-fields=true\|false\|<path>[,<path>]
261+
|label:changed[Changed in 5.26] In v1, whether or not fields from an input source can span multiple lines, i.e. contain newline characters. Setting `--multiline-fields=true` can severely degrade the performance of the importer. Therefore, use it with care, especially with large imports. In v2, this option will specify the list of files that contain multiline fields. Files can also be specified using regular expressions.
262+
|null
262263

263264
|--multiline-fields-format=v1\|v2
264265
|label:new[Introduced in 5.26] Controls the parsing of input source that can span multiple lines, i.e. contain newline characters. When set to v1, the value for `--multiline-fields` can only be true or false. When set to v2, the value for `--multiline-fields` should be the list of files that contain multiline fields.
@@ -611,13 +612,21 @@ The syntax for importing a set of CSV files incrementally is:
611612

612613
[source, syntax, role="nocopy"]
613614
----
614-
neo4j-admin database import incremental [-h] [--expand-commands] --force [--verbose] [--auto-skip-subsequent-headers[=true|false]]
615-
[--ignore-empty-strings[=true|false]] [--ignore-extra-columns[=true|false]]
616-
[--legacy-style-quoting[=true|false]] [--multiline-fields[=true|false]] [--normalize-types[=true|false]] [--skip-bad-entries-logging[=true|false]] [--skip-bad-relationships[=true|false]]
617-
[--skip-duplicate-nodes[=true|false]] [--strict[=true|false]] [--trim-strings[=true|false]]
618-
[--additional-config=<file>] [--array-delimiter=<char>] [--bad-tolerance=<num>] [--delimiter=<char>]
619-
[--high-parallel-io=on|off|auto] [--id-type=string|integer|actual] [--input-encoding=<character-set>]
620-
[--input-type=csv|parquet] [--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>] [--report-file=<path>] [--schema=<path>] [--stage=all|prepare|build|merge] [--threads=<num>] --nodes=[<label>[: <label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]... [--relationships=[<type>=]<files>...]... <database>
615+
neo4j-admin database import incremental [-h] [--expand-commands] --force [--verbose] [--auto-skip-subsequent-headers
616+
[=true|false]] [--ignore-empty-strings[=true|false]] [--ignore-extra-columns
617+
[=true|false]] [--legacy-style-quoting[=true|false]] [--normalize-types
618+
[=true|false]] [--skip-bad-entries-logging[=true|false]]
619+
[--skip-bad-relationships[=true|false]] [--skip-duplicate-nodes[=true|false]]
620+
[--strict[=true|false]] [--trim-strings[=true|false]]
621+
[--additional-config=<file>] [--array-delimiter=<char>] [--bad-tolerance=<num>]
622+
[--delimiter=<char>] [--high-parallel-io=on|off|auto]
623+
[--id-type=string|integer|actual] [--input-encoding=<character-set>]
624+
[--input-type=csv|parquet] [--max-off-heap-memory=<size>] [--quote=<char>]
625+
[--read-buffer-size=<size>] [--report-file=<path>] [--schema=<path>]
626+
[--stage=all|prepare|build|merge] [--threads=<num>] --nodes=[<label>[:
627+
<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]...
628+
[--relationships=[<type>=]<files>...]... [--multiline-fields=true|false|<path>[,
629+
<path>] [--multiline-fields-format=v1|v2]] <database>
621630
----
622631

623632
=== Description
@@ -795,9 +804,9 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
795804
It can also be specified as a percentage of the available memory, for example `70%`.
796805
|90%
797806

798-
|--multiline-fields[=true\|false]
799-
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
800-
| null
807+
|--multiline-fields=true\|false\|<path>[,<path>]
808+
|label:changed[Changed in 5.26] In v1, whether or not fields from an input source can span multiple lines, i.e. contain newline characters. Setting `--multiline-fields=true` can severely degrade the performance of the importer. Therefore, use it with care, especially with large imports. In v2, this option will specify the list of files that contain multiline fields. Files can also be specified using regular expressions.
809+
|null
801810

802811
|--multiline-fields-format=v1\|v2
803812
|label:new[Introduced in 5.26] Controls the parsing of input source that can span multiple lines, i.e. contain newline characters. When set to v1, the value for `--multiline-fields` can only be true or false. When set to v2, the value for `--multiline-fields` should be the list of files that contain multiline fields.

0 commit comments

Comments
 (0)