Skip to content

Commit 42dc21c

Browse files
authored
Document --temp-path for import (#2262)
1 parent f00061f commit 42dc21c

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

modules/ROOT/pages/import.adoc

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:rfc-4180: https://tools.ietf.org/html/rfc4180
66

77
`neo4j-admin database import` writes CSV data into Neo4j's native file format as fast as possible. +
8-
Starting with version 5.26, Neo4j also provides support for the Parquet file format.
8+
It also provides support for the Parquet file format.
99

1010
You should use this tool when:
1111

@@ -93,8 +93,8 @@ neo4j-admin database import full [-h] [--expand-commands] [--verbose] [--auto-sk
9393
[--format=<format>] [--high-parallel-io=on|off|auto] [--id-type=string|integer|actual]
9494
[--input-encoding=<character-set>] [--input-type=csv|parquet]
9595
[--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>...]...
96+
[--report-file=<path>] [--schema=<path>] [--temp-path=<path>] [--threads=<num>]
97+
--nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]...
9898
[--relationships=[<type>=]<files>...]... [--multiline-fields=true|false|<path>[,
9999
<path>] [--multiline-fields-format=v1|v2]] <database>
100100
----
@@ -276,7 +276,7 @@ It can also be specified as a percentage of the available memory, for example `7
276276
| {check-mark}
277277

278278
|--multiline-fields=true\|false\|<path>[,<path>]
279-
|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.
279+
|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.
280280
|null
281281
| {check-mark}
282282
|
@@ -398,7 +398,14 @@ Skipped nodes will be logged if they are within the limit of entities specified
398398
| Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
399399
If disabled, most but not all relationships referring to non-existent nodes will be detected.
400400
If enabled all those relationships will be found but at the cost of lower performance.
401-
|false label:changed[Changed in 5.8]
401+
|false
402+
| {check-mark}
403+
| {check-mark}
404+
405+
|--temp-path=<path> label:new[Introduced in 2025.04]
406+
|Provide a path where to store temporary files that are created and deleted during import.
407+
If not specifically provided, the default temp path will be created inside the database directory of the imported database.
408+
|
402409
| {check-mark}
403410
| {check-mark}
404411

@@ -644,8 +651,8 @@ neo4j-admin database import incremental [-h] [--expand-commands] --force [--upda
644651
[--input-encoding=<character-set>] [--input-type=csv|parquet]
645652
[--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>]
646653
[--report-file=<path>] [--schema=<path>] [--stage=all|prepare|build|merge]
647-
[--threads=<num>] --nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:
648-
<label>]...=]<files>...]... [--relationships=[<type>=]<files>...]...
654+
[--temp-path=<path>] [--threads=<num>] --nodes=[<label>[:<label>]...=]<files>...
655+
[--nodes=[<label>[: <label>]...=]<files>...]... [--relationships=[<type>=]<files>...]...
649656
[--multiline-fields=true|false|<path>[,<path>]
650657
[--multiline-fields-format=v1|v2]] <database>
651658
----
@@ -846,7 +853,7 @@ It can also be specified as a percentage of the available memory, for example `7
846853
| {check-mark}
847854

848855
|--multiline-fields=true\|false\|<path>[,<path>]
849-
|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.
856+
|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.
850857
|null
851858
| {check-mark}
852859
|
@@ -972,7 +979,14 @@ For semi-online incremental import run `prepare` (on a stopped database) followe
972979
| Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
973980
If disabled, most but not all relationships referring to non-existent nodes will be detected.
974981
If enabled all those relationships will be found but at the cost of lower performance.
975-
|false label:changed[Changed in 5.8]
982+
|false
983+
| {check-mark}
984+
| {check-mark}
985+
986+
|--temp-path=<path> label:new[Introduced in 2025.04]
987+
|Provide a path where to store temporary files that are created and deleted during import.
988+
If not specifically provided, the default temp path will be created inside the database directory of the imported database.
989+
|
976990
| {check-mark}
977991
| {check-mark}
978992

0 commit comments

Comments
 (0)