You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
+34-14Lines changed: 34 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,17 @@ Change Data Capture does **not** capture any data changes resulting from the use
25
25
See link:{neo4j-docs-base-uri}/cdc/current/get-started/self-managed/#non-tx-log-changes/[Change Data Capture -> Key considerations] for more information.
26
26
====
27
27
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
+
28
39
== Overview
29
40
30
41
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`.
149
160
Unicode character ID can be used if prepended by `\`.
150
161
|;
151
162
152
-
| --auto-skip-subsequent-headers[=true\|false]
163
+
| --auto-skip-subsequent-headers[=true\|false]^1^
153
164
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
154
165
|false
155
166
156
167
|--bad-tolerance=<num>
157
168
|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.
158
169
|1000
159
170
160
-
|--delimiter=<char>
171
+
|--delimiter=<char>^1^
161
172
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
162
173
163
174
====
@@ -206,14 +217,19 @@ Possible values are:
206
217
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
207
218
|false
208
219
209
-
|--ignore-extra-columns[=true\|false]
220
+
|--ignore-extra-columns[=true\|false]^1^
210
221
|If unspecified columns should be ignored during the import.
211
222
|false
212
223
213
-
|--input-encoding=<character-set>
224
+
|--input-encoding=<character-set>^1^
214
225
|Character set that input data is encoded in.
215
226
|UTF-8
216
227
228
+
|--input-type[=csv\|parquet]
229
+
label:beta[]
230
+
|File type to import.
231
+
|csv
232
+
217
233
|--legacy-style-quoting[=true\|false]
218
234
|Whether or not a backslash-escaped quote e.g. \" is interpreted as an inner quote.
219
235
|false
@@ -225,7 +241,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
225
241
It can also be specified as a percentage of the available memory, for example `70%`.
226
242
|90%
227
243
228
-
|--multiline-fields[=true\|false]
244
+
|--multiline-fields[=true\|false]^1^
229
245
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
230
246
231
247
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>>.
251
267
|Delete any existing database files prior to the import.
252
268
|false
253
269
254
-
|--quote=<char>
270
+
|--quote=<char>^1^
255
271
|Character to treat as quotation character for values in CSV data.
256
272
257
273
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
324
340
performance, this value should not be greater than the number of available processors.
325
341
|20
326
342
327
-
|--trim-strings[=true\|false]
343
+
|--trim-strings[=true\|false]^1^
328
344
|Whether or not strings should be trimmed for whitespaces.
329
345
|false
330
346
@@ -333,6 +349,8 @@ performance, this value should not be greater than the number of available proce
333
349
|
334
350
|===
335
351
352
+
^1^ __Ignored by Parquet import label:beta[].__ +
353
+
336
354
[NOTE]
337
355
.Heap size for the import
338
356
====
@@ -662,15 +680,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
662
680
Unicode character ID can be used if prepended by `\`.
663
681
|;
664
682
665
-
| --auto-skip-subsequent-headers[=true\|false]
683
+
| --auto-skip-subsequent-headers[=true\|false]^1^
666
684
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
667
685
|false
668
686
669
687
|--bad-tolerance=<num>
670
688
|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.
671
689
|1000
672
690
673
-
|--delimiter=<char>
691
+
|--delimiter=<char>^1^
674
692
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
675
693
676
694
====
@@ -717,11 +735,11 @@ Possible values are:
717
735
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
718
736
|false
719
737
720
-
|--ignore-extra-columns[=true\|false]
738
+
|--ignore-extra-columns[=true\|false]^1^
721
739
|If unspecified columns should be ignored during the import.
722
740
|false
723
741
724
-
|--input-encoding=<character-set>
742
+
|--input-encoding=<character-set>^1^
725
743
|Character set that input data is encoded in.
726
744
|UTF-8
727
745
@@ -736,7 +754,7 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
736
754
It can also be specified as a percentage of the available memory, for example `70%`.
737
755
|90%
738
756
739
-
|--multiline-fields[=true\|false]
757
+
|--multiline-fields[=true\|false]^1^
740
758
|Whether or not fields from an input source can span multiple lines, i.e. contain newline characters.
741
759
742
760
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>>.
758
776
|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.
759
777
| true
760
778
761
-
|--quote=<char>
779
+
|--quote=<char>^1^
762
780
|Character to treat as quotation character for values in CSV data.
763
781
764
782
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
836
854
performance, this value should not be greater than the number of available processors.
837
855
|20
838
856
839
-
|--trim-strings[=true\|false]
857
+
|--trim-strings[=true\|false]^1^
840
858
|Whether or not strings should be trimmed for whitespaces.
841
859
|false
842
860
@@ -845,6 +863,8 @@ performance, this value should not be greater than the number of available proce
845
863
|
846
864
|===
847
865
866
+
^1^ __Ignored by Parquet import label:beta[].__ +
867
+
848
868
[NOTE]
849
869
.Using both a multi-value option and a positional parameter
0 commit comments