Skip to content

Commit b7c13e8

Browse files
committed
Document --schema option for incremental import
1 parent 1032966 commit b7c13e8

File tree

1 file changed

+49
-36
lines changed

1 file changed

+49
-36
lines changed

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

Lines changed: 49 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -444,41 +444,6 @@ bin/neo4j-admin database import full --nodes import/movies_header.csv,import/mov
444444
--relationships import/roles_header.csv,import/roles.csv
445445
----
446446

447-
[role=label--enterprise-edition]
448-
[[indexes-constraints-import]]
449-
==== Provide indexes and constraints during import
450-
451-
You can use the `--schema` option to create indexes/constraints during the initial import process.
452-
It currently only works for the block format and full import.
453-
454-
You should have a Cypher script containing only `CREATE INDEX|CONSTRAINT` commands to be parsed and executed.
455-
This file uses ';' as the separator.
456-
457-
For example:
458-
459-
[source, cypher, role=nocopy]
460-
----
461-
CREATE INDEX PersonNameIndex FOR (i:Person) ON (i.name);
462-
CREATE CONSTRAINT PersonAgeConstraint FOR (c:Person) REQUIRE c.age IS :: INTEGER
463-
----
464-
465-
List of supported indexes and constraints that can be created by the import tool:
466-
467-
* RANGE
468-
* LOOKUP
469-
* POINT
470-
* TEXT
471-
* FULL-TEXT
472-
* VECTOR
473-
474-
For example:
475-
476-
[source, shell, role=noplay]
477-
----
478-
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
479-
----
480-
481-
482447
[[import-tool-multiple-input-files-regex-example]]
483448
==== Import data from CSV files using regular expression
484449

@@ -838,7 +803,7 @@ If you need to debug the import, it might be useful to collect the stack trace.
838803
This is done by using the `--verbose` option.
839804
|import.report
840805

841-
|--schema=<path>footnote:[The `--schema` option is available in this version but not yet supported. It will be functional in a future release.]
806+
|--schema=<path> label:new[Available from 2025.02]
842807
|Path to the file containing the Cypher commands for creating indexes and constraints during data import.
843808
|
844809

@@ -1570,6 +1535,54 @@ bin/neo4j-admin database import --nodes import/movies-header.csv,import/movies.c
15701535
----
15711536
====
15721537

1538+
[role=label--enterprise-edition]
1539+
[[indexes-constraints-import]]
1540+
== Provide indexes and constraints during import
1541+
1542+
You can use the `--schema` option to create indexes/constraints during the import process.
1543+
It works for the block format and both full and incremental import.
1544+
For incremental import, this functionality is available from 2025.02.
1545+
1546+
You should have a Cypher script containing only `CREATE INDEX|CONSTRAINT` commands to be parsed and executed.
1547+
This file uses ';' as the separator.
1548+
1549+
For example:
1550+
1551+
[source, cypher, role=nocopy]
1552+
----
1553+
CREATE INDEX PersonNameIndex FOR (i:Person) ON (i.name);
1554+
CREATE CONSTRAINT PersonAgeConstraint FOR (c:Person) REQUIRE c.age IS :: INTEGER
1555+
----
1556+
1557+
List of supported indexes and constraints that can be created by the import tool:
1558+
1559+
* RANGE
1560+
* LOOKUP
1561+
* POINT
1562+
* TEXT
1563+
* FULL-TEXT
1564+
* VECTOR
1565+
1566+
For example:
1567+
1568+
.Create indexes and constraints during full import
1569+
[source, shell, role=noplay]
1570+
----
1571+
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
1572+
----
1573+
1574+
.Create indexes and constraints during incremental import
1575+
[source, shell, role=noplay]
1576+
----
1577+
bin/neo4j-admin database import incremental --stage=all --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
1578+
----
1579+
1580+
[NOTE]
1581+
====
1582+
You must stop your database, if you want to perform the incremental import within one command.
1583+
If you cannot afford a full downtime of your database, split the operation into several stages.
1584+
For details, see <<incremental-import-stages>>.
1585+
====
15731586

15741587
[role=label--enterprise-edition]
15751588
[[import-tool-resume]]

0 commit comments

Comments
 (0)