Skip to content

Commit 48f6158

Browse files
committed
editorial changes
1 parent f09ee2f commit 48f6158

File tree

1 file changed

+43
-19
lines changed

1 file changed

+43
-19
lines changed

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

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
:rfc-4180: https://tools.ietf.org/html/rfc4180
66

7-
`neo4j-admin database import` writes CSV data into Neo4j's native file format as fast as possible. You should use this tool when:
7+
`neo4j-admin database import` writes CSV data into Neo4j's native file format as fast as possible. +
8+
From Neo4j 5.25, Neo4j also provides support for the Parquet file format in a public beta version.
9+
10+
You should use this tool when:
811

912
* Import performance is important because you have a large amount of data (millions/billions of entities).
1013
* The database can be taken offline and you have direct access to one of the servers hosting your Neo4j DBMS.
@@ -25,17 +28,6 @@ Change Data Capture does **not** capture any data changes resulting from the use
2528
See link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#non-tx-log-changes/[Change Data Capture -> Key considerations] for more information.
2629
====
2730

28-
[role=label--beta]
29-
== Parquet file support
30-
Starting with Neo4j 5.24, Neo4j provides support for the Parquet file format in a public beta version.
31-
The additional parameter `--input-type [csv|parquet]` was introduced to explicitly tell the importer to use either CSV or Parquet.
32-
Its value defaults to CSV if it is not defined.
33-
34-
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
35-
There are indicators in the parameter overview to point out which parameters are supported.
36-
37-
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
38-
3931
== Overview
4032

4133
The `neo4j-admin database import` command has two modes both used for initial data import:
@@ -99,8 +91,9 @@ neo4j-admin database import full [-h] [--expand-commands] [--verbose] [--auto-sk
9991
[=true|false]] [--additional-config=<file>] [--array-delimiter=<char>]
10092
[--bad-tolerance=<num>] [--delimiter=<char>] [--format=<format>]
10193
[--high-parallel-io=on|off|auto] [--id-type=string|integer|actual]
102-
[--input-encoding=<character-set>] [--max-off-heap-memory=<size>] [--quote=<char>]
103-
[--read-buffer-size=<size>] [--report-file=<path>] [--schema=<path>] [--threads=<num>]
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>]
10497
--nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]
10598
<files>...]... [--relationships=[<type>=]<files>...]... <database>
10699
----
@@ -134,6 +127,21 @@ For more information, please contact Neo4j Professional Services.
134127

135128
=== Options
136129

130+
[role=label--beta]
131+
.Parquet file support
132+
[NOTE]
133+
====
134+
Starting with Neo4j 5.25, Neo4j provides support for the Parquet file format in a public beta version.
135+
The additional parameter `--input-type [csv|parquet]` is introduced to explicitly tell the importer to use either CSV or Parquet.
136+
Its value defaults to CSV if it is not defined.
137+
138+
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.
140+
141+
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
142+
====
143+
144+
[[full-import-options-table]]
137145
.`neo4j-admin database import full` options
138146
[options="header", cols="5m,10a,2m"]
139147
|===
@@ -227,7 +235,7 @@ Possible values are:
227235

228236
|--input-type[=csv\|parquet]
229237
label:beta[]
230-
|File type to import.
238+
|File type to import from. Can be csv or parquet. Defaults to csv.
231239
|csv
232240

233241
|--legacy-style-quoting[=true\|false]
@@ -473,7 +481,7 @@ For example:
473481

474482
[source, shell, role=noplay]
475483
----
476-
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
484+
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
477485
----
478486

479487

@@ -600,8 +608,9 @@ neo4j-admin database import incremental [-h] [--expand-commands] --force [--verb
600608
[--additional-config=<file>] [--array-delimiter=<char>] [--bad-tolerance=<num>]
601609
[--delimiter=<char>] [--high-parallel-io=on|off|auto]
602610
[--id-type=string|integer|actual] [--input-encoding=<character-set>]
603-
[--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>]
604-
[--report-file=<path>] [--stage=all|prepare|build|merge] [--threads=<num>]
611+
[--input-type[=csv\|parquet]] [--max-off-heap-memory=<size>]
612+
[--quote=<char>] [--read-buffer-size=<size>] [--report-file=<path>]
613+
[--stage=all|prepare|build|merge] [--threads=<num>]
605614
--nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]
606615
<files>...]... [--relationships=[<type>=]<files>...]... <database>
607616
----
@@ -654,6 +663,21 @@ If the database into which you import does not exist prior to importing, you mus
654663

655664
=== Options
656665

666+
[role=label--beta]
667+
.Parquet file support
668+
[NOTE]
669+
====
670+
Starting with Neo4j 5.25, Neo4j provides support for the Parquet file format in a public beta version.
671+
The additional parameter `--input-type [csv|parquet]` is introduced to explicitly tell the importer to use either CSV or Parquet.
672+
Its value defaults to CSV if it is not defined.
673+
674+
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
675+
There are indicators in the <<incremental-import-options-table, `neo4j-admin database import incremental` options>> table to point out which parameters are not supported.
676+
677+
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
678+
====
679+
680+
[[incremental-import-options-table]]
657681
.`neo4j-admin database import incremental` options
658682
[options="header", cols="5m,10a,2m"]
659683
|===
@@ -745,7 +769,7 @@ Possible values are:
745769

746770
|--input-type[=csv\|parquet]
747771
label:beta[]
748-
|File type to import.
772+
|File type to import from. Can be csv or parquet. Defaults to csv.
749773
|csv
750774

751775
|--legacy-style-quoting[=true\|false]

0 commit comments

Comments
 (0)