Skip to content

Commit bc1be17

Browse files
committed
Add neo4j-admin-import section and parameter details for Parquet.
1 parent 5e904eb commit bc1be17

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

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

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Change Data Capture does **not** capture any data changes resulting from the use
2525
See link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#non-tx-log-changes/[Change Data Capture -> Key considerations] for more information.
2626
====
2727

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+
2839
== Overview
2940

3041
The `neo4j-admin database import` command has two modes both used for initial data import:
@@ -149,15 +160,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
149160
Unicode character ID can be used if prepended by `\`.
150161
|;
151162

152-
| --auto-skip-subsequent-headers[=true\|false]
163+
| --auto-skip-subsequent-headers[=true\|false]^1^
153164
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
154165
|false
155166

156167
|--bad-tolerance=<num>
157168
|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.
158169
|1000
159170

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

163174
====
@@ -206,14 +217,19 @@ Possible values are:
206217
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
207218
|false
208219

209-
|--ignore-extra-columns[=true\|false]
220+
|--ignore-extra-columns[=true\|false]^1^
210221
|If unspecified columns should be ignored during the import.
211222
|false
212223

213-
|--input-encoding=<character-set>
224+
|--input-encoding=<character-set>^1^
214225
|Character set that input data is encoded in.
215226
|UTF-8
216227

228+
|--input-type[=csv\|parquet]
229+
label:beta[]
230+
|File type to import.
231+
|csv
232+
217233
|--legacy-style-quoting[=true\|false]
218234
|Whether or not a backslash-escaped quote e.g. \" is interpreted as an inner quote.
219235
|false
@@ -225,7 +241,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
225241
It can also be specified as a percentage of the available memory, for example `70%`.
226242
|90%
227243

228-
|--multiline-fields[=true\|false]
244+
|--multiline-fields[=true\|false]^1^
229245
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
230246

231247
Setting `--multiline-fields=true` can severely degrade the performance of the importer.
@@ -251,7 +267,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
251267
|Delete any existing database files prior to the import.
252268
|false
253269

254-
|--quote=<char>
270+
|--quote=<char>^1^
255271
|Character to treat as quotation character for values in CSV data.
256272

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

327-
|--trim-strings[=true\|false]
343+
|--trim-strings[=true\|false]^1^
328344
|Whether or not strings should be trimmed for whitespaces.
329345
|false
330346

@@ -333,6 +349,8 @@ performance, this value should not be greater than the number of available proce
333349
|
334350
|===
335351

352+
^1^ __Ignored by Parquet import label:beta[].__ +
353+
336354
[NOTE]
337355
.Heap size for the import
338356
====
@@ -662,15 +680,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
662680
Unicode character ID can be used if prepended by `\`.
663681
|;
664682

665-
| --auto-skip-subsequent-headers[=true\|false]
683+
| --auto-skip-subsequent-headers[=true\|false]^1^
666684
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
667685
|false
668686

669687
|--bad-tolerance=<num>
670688
|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.
671689
|1000
672690

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

676694
====
@@ -717,11 +735,11 @@ Possible values are:
717735
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
718736
|false
719737

720-
|--ignore-extra-columns[=true\|false]
738+
|--ignore-extra-columns[=true\|false]^1^
721739
|If unspecified columns should be ignored during the import.
722740
|false
723741

724-
|--input-encoding=<character-set>
742+
|--input-encoding=<character-set>^1^
725743
|Character set that input data is encoded in.
726744
|UTF-8
727745

@@ -736,7 +754,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
736754
It can also be specified as a percentage of the available memory, for example `70%`.
737755
|90%
738756

739-
|--multiline-fields[=true\|false]
757+
|--multiline-fields[=true\|false]^1^
740758
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
741759

742760
Setting `--multiline-fields=true` can severely degrade the performance of the importer.
@@ -758,7 +776,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
758776
|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.
759777
| true
760778

761-
|--quote=<char>
779+
|--quote=<char>^1^
762780
|Character to treat as quotation character for values in CSV data.
763781

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

839-
|--trim-strings[=true\|false]
857+
|--trim-strings[=true\|false]^1^
840858
|Whether or not strings should be trimmed for whitespaces.
841859
|false
842860

@@ -845,6 +863,8 @@ performance, this value should not be greater than the number of available proce
845863
|
846864
|===
847865

866+
^1^ __Ignored by Parquet import label:beta[].__ +
867+
848868
[NOTE]
849869
.Using both a multi-value option and a positional parameter
850870
====

0 commit comments

Comments
 (0)