Skip to content

Add footnote that --schema is not supported in 5.24 #1870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 16, 2024
Merged

Add footnote that --schema is not supported in 5.24 #1870

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
084125c
Add footnote that --schema is not supported in 5.24
renetapopova Oct 16, 2024
05c4709
add the schema option to incremental and move the labels in the descr…
renetapopova Oct 16, 2024
309fb5f
move schema option after report
renetapopova Oct 16, 2024
14d0f30
Update modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
renetapopova Oct 16, 2024
f71616d
Update modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
renetapopova Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,8 @@ If you need to debug the import, it might be useful to collect the stack trace.
This is done by using the `--verbose` option.
|import.report

|--schema=<path> label:new[Introduced in 5.24] label:enterprise[Enterprise edition]
|Path to the file containing the Cypher commands for creating indexes and constraints during data import.
|--schema=<path>
|label:new[Introduced in 5.24] label:enterprise[Enterprise edition] Path to the file containing the Cypher commands for creating indexes and constraints during data import.
|

|--skip-bad-entries-logging[=true\|false]
Expand All @@ -317,8 +317,8 @@ In the event of multiple nodes within the same group having the same ID, the fir
Skipped nodes will be logged, containing at most the number of entities specified by `--bad-tolerance`, unless otherwise specified by the `--skip-bad-entries-logging` option.
|false

|--strict[=true\|false] label:new[Introduced in 5.6]
| Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
|--strict[=true\|false]
| label:new[Introduced in 5.6] Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
If disabled, most but not all relationships referring to non-existent nodes will be detected.
If enabled all those relationships will be found but at the cost of lower performance.
|false label:changed[Changed in 5.8]
Expand All @@ -337,6 +337,7 @@ performance, this value should not be greater than the number of available proce
|
|===


[NOTE]
.Heap size for the import
====
Expand Down Expand Up @@ -459,7 +460,7 @@ For example:

[source, shell, role=noplay]
----
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
bin/neo4j-admin database import full neo4j --nodes=import/movies.csv --nodes=import/actors.csv --relationships=import/roles.csv --schema=import/schema.cypher
----


Expand Down Expand Up @@ -587,9 +588,9 @@ neo4j-admin database import incremental [-h] [--expand-commands] --force [--verb
[--delimiter=<char>] [--high-parallel-io=on|off|auto]
[--id-type=string|integer|actual] [--input-encoding=<character-set>]
[--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>]
[--report-file=<path>] [--stage=all|prepare|build|merge] [--threads=<num>]
--nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]
<files>...]... [--relationships=[<type>=]<files>...]... <database>
[--report-file=<path>] [--schema=<path>] [--stage=all|prepare|build|merge]
[--threads=<num>] --nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>
[:<label>]...=]<files>...]... [--relationships=[<type>=]<files>...]... <database>
----

=== Description
Expand Down Expand Up @@ -806,6 +807,10 @@ If you need to debug the import, it might be useful to collect the stack trace.
This is done by using the `--verbose` option.
|import.report

|--schema=<path> footnote:[The optional `--schema` option is available in this version but not yet supported. It will be functional in a future release.]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be picky. But is it clear when we say 'the ... option is available but not supported'?
Could we just say that this option doesn't work with the incremental import command? Or - 'The incremental import command currently doesn't support the --schema option. It will be functional in a future release'?

Copy link
Collaborator Author

@renetapopova renetapopova Oct 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be the best, but I didn't want to say that. I wanted to say it more nicely 😄. If we say, "The incremental import command currently doesn't support the—-schema option,", that is not true because we display it. I would say that incremental import supports it, but it doesn't work 😄 😄. It's a tricky one. I am open to more variations.

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Oct 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do you think about:

The --schema option is available in this version but not yet supported. It will be functional in a future release.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we don't need the "optional" part.

|label:new[Introduced in 5.24] Path to the file containing the Cypher commands for creating indexes and constraints during data import.
|

|--skip-bad-entries-logging[=true\|false]
|When set to `true`, the details of bad entries are not written in the log. Disabling logging can improve performance when the data contains lots of faults. Cleaning the data before importing it is highly recommended because faults dramatically affect the tool's performance even without logging.
|false
Expand Down Expand Up @@ -833,8 +838,8 @@ For incremental import into an existing database use `all` (which requires the d
For semi-online incremental import run `prepare` (on a stopped database) followed by `build` (on a potentially running database) and finally `merge` (on a stopped database).
|all

|--strict[=true\|false] label:new[Introduced in 5.6]
| Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
|--strict[=true\|false]
| label:new[Introduced in 5.6] Whether or not the lookup of nodes referred to from relationships needs to be checked strict.
If disabled, most but not all relationships referring to non-existent nodes will be detected.
If enabled all those relationships will be found but at the cost of lower performance.
|false label:changed[Changed in 5.8]
Expand Down