Skip to content

Commit e01d724

Browse files
committed
remove beta label and add a footnote for the ignored arguments
1 parent f661f5a commit e01d724

File tree

1 file changed

+23
-62
lines changed

1 file changed

+23
-62
lines changed

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

Lines changed: 23 additions & 62 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-
From Neo4j 5.25, Neo4j also provides support for the Parquet file format in a public beta version.
8+
Starting with version 5.26, Neo4j also provides support for the Parquet file format.
99

1010
You should use this tool when:
1111

@@ -128,27 +128,10 @@ For more information, please contact Neo4j Professional Services.
128128

129129
=== Options
130130

131-
[role=label--beta]
132-
.Parquet file support
133-
[NOTE]
134-
====
135-
Starting with Neo4j 5.25, Neo4j provides support for the Parquet file format in a public beta version.
136-
The additional parameter `--input-type [csv|parquet]` is introduced to explicitly tell the importer to use either CSV or Parquet.
137-
Its value defaults to CSV if it is not defined.
138-
139-
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
140-
The following parameters are not supported (see <<full-import-options-table, `neo4j-admin database import full` options>> table for more details):
141-
142-
- `--auto-skip-subsequent-headers`
143-
- `--delimiter`
144-
- `--ignore-extra-columns`
145-
- `--input-encoding`
146-
- `--multiline-fields`
147-
- `--quote`
148-
- `--trim-strings`
149-
131+
Starting from Neo4j 5.26, the importer also supports the Parquet file format.
132+
An additional parameter `--input-type=csv|parquet` has been introduced to explicitly specify whether to use CSV or Parquet for the importer.
133+
If not defined, the default value will be CSV.
150134
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
151-
====
152135

153136
[[full-import-options-table]]
154137
.`neo4j-admin database import full` options
@@ -177,15 +160,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
177160
Unicode character ID can be used if prepended by `\`.
178161
|;
179162

180-
| --auto-skip-subsequent-headers[=true\|false]
163+
| --auto-skip-subsequent-headers[=true\|false] footnote:ingnoredByParquet1[Ignored by Parquet import.]
181164
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
182165
|false
183166

184167
|--bad-tolerance=<num>
185168
|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.
186169
|1000
187170

188-
|--delimiter=<char>
171+
|--delimiter=<char> footnote:ingnoredByParquet1[]
189172
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
190173

191174
====
@@ -234,16 +217,16 @@ Possible values are:
234217
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
235218
|false
236219

237-
|--ignore-extra-columns[=true\|false]
220+
|--ignore-extra-columns[=true\|false] footnote:ingnoredByParquet1[]
238221
|If unspecified columns should be ignored during the import.
239222
|false
240223

241-
|--input-encoding=<character-set>
224+
|--input-encoding=<character-set> footnote:ingnoredByParquet1[]
242225
|Character set that input data is encoded in.
243226
|UTF-8
244227

245228
|--input-type=csv\|parquet
246-
|label:beta[] File type to import from. Can be csv or parquet. Defaults to csv.
229+
|label:new[Introduced in 5.26] File type to import from. Can be csv or parquet. Defaults to csv.
247230
|csv
248231

249232
|--legacy-style-quoting[=true\|false]
@@ -257,11 +240,11 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
257240
It can also be specified as a percentage of the available memory, for example `70%`.
258241
|90%
259242

260-
|--multiline-fields=true\|false\|<path>[,<path>]
243+
|--multiline-fields=true\|false\|<path>[,<path>] footnote:ingnoredByParquet1[]
261244
|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.
262245
|null
263246

264-
|--multiline-fields-format=v1\|v2
247+
|--multiline-fields-format=v1\|v2 footnote:ingnoredByParquet1[]
265248
|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.
266249
|null
267250

@@ -286,7 +269,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
286269
|Delete any existing database files prior to the import.
287270
|false
288271

289-
|--quote=<char>
272+
|--quote=<char> footnote:ingnoredByParquet1[]
290273
|Character to treat as quotation character for values in CSV data.
291274

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

364-
|--trim-strings[=true\|false]
347+
|--trim-strings[=true\|false] footnote:ingnoredByParquet1[]
365348
|Whether or not strings should be trimmed for whitespaces.
366349
|false
367350

@@ -465,7 +448,7 @@ bin/neo4j-admin database import full --nodes import/movies_header.csv,import/mov
465448
[[indexes-constraints-import]]
466449
==== Provide indexes and constraints during import
467450

468-
Starting with Neo4j 5.24, you can use the `--schema` option that allows Cypher commands to be provided to create indexes/constraints during the initial import process.
451+
Starting from Neo4j 5.24, you can use the `--schema` option that allows Cypher commands to be provided to create indexes/constraints during the initial import process.
469452
It currently only works for the block format and full import.
470453

471454
You should have a Cypher script containing only `CREATE INDEX|CONSTRAINT` commands to be parsed and executed.
@@ -677,28 +660,6 @@ If the database into which you import does not exist prior to importing, you mus
677660

678661
=== Options
679662

680-
[role=label--beta]
681-
.Parquet file support
682-
[NOTE]
683-
====
684-
Starting with Neo4j 5.25, Neo4j provides support for the Parquet file format in a public beta version.
685-
The additional parameter `--input-type [csv|parquet]` is introduced to explicitly tell the importer to use either CSV or Parquet.
686-
Its value defaults to CSV if it is not defined.
687-
688-
Most of the parameters that can be used to configure the import are also valid for the Parquet format.
689-
The following parameters are not supported (see <<incremental-import-options-table, `neo4j-admin database import incremental` options>> table for more details):
690-
691-
- `--auto-skip-subsequent-headers`
692-
- `--delimiter`
693-
- `--ignore-extra-columns`
694-
- `--input-encoding`
695-
- `--multiline-fields`
696-
- `--quote`
697-
- `--trim-strings`
698-
699-
The xref:tools/neo4j-admin/neo4j-admin-import.adoc#import-tool-examples[examples] for CSV can also be used with Parquet.
700-
====
701-
702663
[[incremental-import-options-table]]
703664
.`neo4j-admin database import incremental` options
704665
[options="header", cols="5m,10a,2m"]
@@ -726,15 +687,15 @@ For horizontal tabulation (HT), use `\t` or the Unicode character ID `\9`.
726687
Unicode character ID can be used if prepended by `\`.
727688
|;
728689

729-
| --auto-skip-subsequent-headers[=true\|false]
690+
| --auto-skip-subsequent-headers[=true\|false] footnote:ingnoredByParquet2[Ignored by Parquet import.]
730691
|Automatically skip accidental header lines in subsequent files in file groups with more than one file.
731692
|false
732693

733694
|--bad-tolerance=<num>
734695
|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.
735696
|1000
736697

737-
|--delimiter=<char>
698+
|--delimiter=<char> footnote:ingnoredByParquet2[]
738699
|Delimiter character between values in CSV data. Also accepts `TAB` and e.g. `U+20AC` for specifying a character using Unicode.
739700

740701
====
@@ -781,16 +742,16 @@ Possible values are:
781742
|Whether or not empty string fields, i.e. "" from input source are ignored, i.e. treated as null.
782743
|false
783744

784-
|--ignore-extra-columns[=true\|false]
745+
|--ignore-extra-columns[=true\|false] footnote:ingnoredByParquet2[]
785746
|If unspecified columns should be ignored during the import.
786747
|false
787748

788-
|--input-encoding=<character-set>
749+
|--input-encoding=<character-set> footnote:ingnoredByParquet2[]
789750
|Character set that input data is encoded in.
790751
|UTF-8
791752

792753
|--input-type=csv\|parquet
793-
|label:beta[] File type to import from. Can be csv or parquet. Defaults to csv.
754+
|label:new[Introduced in 5.26]File type to import from. Can be csv or parquet. Defaults to csv.
794755
|csv
795756

796757
|--legacy-style-quoting[=true\|false]
@@ -804,11 +765,11 @@ Values can be plain numbers, such as `10000000`, or `20G` for 20 gigabytes.
804765
It can also be specified as a percentage of the available memory, for example `70%`.
805766
|90%
806767

807-
|--multiline-fields=true\|false\|<path>[,<path>]
768+
|--multiline-fields=true\|false\|<path>[,<path>] footnote:ingnoredByParquet2[]
808769
|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.
809770
|null
810771

811-
|--multiline-fields-format=v1\|v2
772+
|--multiline-fields-format=v1\|v2 footnote:ingnoredByParquet2[]
812773
|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.
813774
|null
814775

@@ -829,7 +790,7 @@ For an example, see <<import-tool-multiple-input-files-regex-example>>.
829790
|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.
830791
| true
831792

832-
|--quote=<char>
793+
|--quote=<char> footnote:ingnoredByParquet2[]
833794
|Character to treat as quotation character for values in CSV data.
834795

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

916-
|--trim-strings[=true\|false]
877+
|--trim-strings[=true\|false] footnote:ingnoredByParquet2[]
917878
|Whether or not strings should be trimmed for whitespaces.
918879
|false
919880

0 commit comments

Comments
 (0)