Skip to content
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

Add missing options of the copy and incremental import commands #2068

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
+28 −23
Open

Add missing options of the copy and incremental import commands #2068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a4aef88
Add missing options of the copy and incremental import commands
NataliaIvakina Jan 21, 2025
9706425
Apply suggestions from code review
NataliaIvakina Jan 21, 2025
4d18968
Update neo4j-admin-import.adoc
NataliaIvakina Jan 21, 2025
93840db
Update modules/ROOT/pages/backup-restore/copy-database.adoc
NataliaIvakina Jan 21, 2025
f139bb6
Fix mismatches in the usage section
NataliaIvakina Jan 21, 2025
c8a694a
Add labels, fix the test failures
NataliaIvakina Jan 21, 2025
566ca58
Update modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
NataliaIvakina Jan 21, 2025
a01eb2d
Remove --from-pagecache from the options list
NataliaIvakina Jan 24, 2025
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
16 changes: 8 additions & 8 deletions modules/ROOT/pages/backup-restore/copy-database.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ For more information, see <<copy-estimating-iops, Estimating the processing time
[source,role=noheader]
----
neo4j-admin database copy [-h] [--copy-schema] [--expand-commands] [--force] [--verbose] [--compact-node-store[=true|false]]
[--additional-config=<file>] [--from-pagecache=<size>] [--temp-path=<path>] [--to-format=<format>]
[--additional-config=<file>] [--from-pagecache, --max-off-heap-memory=<size>]
[--temp-path=<path>] [--to-format=<format>]
[--to-path-schema=<path>] [--copy-only-node-properties=<label.property>[,<label.property>...]]...
[--copy-only-nodes-with-labels=<label>[,<label>...]]... [--copy-only-relationship-properties=<relationship.
property>[,<relationship.property>...]]... [--copy-only-relationships-with-types=<type>[,<type>...]]...
Expand Down Expand Up @@ -123,13 +124,6 @@ The indexes will be built the first time the database is started.
|Force the command to run even if the integrity of the database cannot be verified.
|

|--from-pagecache=<size>
|The size of the page cache to use for reading.
[TIP]
You can use the `--from-pagecache` option to speed up the copy operation by specifying how much cache to allocate when reading the source.
The `--from-pagecache` should be assigned whatever memory you can spare since Neo4j does random reads from the source.
|8m

|--from-path-data=<path>
|Path to the databases directory, containing the database directory to source from.
It can be used to target databases outside of the installation.
Expand All @@ -155,6 +149,12 @@ relationship types will not be included in the copy.
Cannot be combined with `--copy-only-relationships-with-types`.
|

|--from-pagecache, --max-off-heap-memory=<size>
|label:new[Introduced in 2025.01] Maximum memory that neo4j-admin can use for various data structures and caching to improve performance.
Values can be plain numbers, such as 10000000, or 20G for 20 gigabytes.
It can also be specified as a percentage of the available memory, for example 70%.
|90%

|--skip-labels=<label>[,<label>...]
|A comma-separated list of labels to ignore.
|
Expand Down
35 changes: 20 additions & 15 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 @@ -595,21 +595,22 @@ The syntax for importing a set of CSV files incrementally is:

[source, syntax, role="nocopy"]
----
neo4j-admin database import incremental [-h] [--expand-commands] --force [--verbose] [--auto-skip-subsequent-headers
[=true|false]] [--ignore-empty-strings[=true|false]] [--ignore-extra-columns
[=true|false]] [--legacy-style-quoting[=true|false]] [--normalize-types
[=true|false]] [--skip-bad-entries-logging[=true|false]]
[--skip-bad-relationships[=true|false]] [--skip-duplicate-nodes[=true|false]]
[--strict[=true|false]] [--trim-strings[=true|false]]
[--additional-config=<file>] [--array-delimiter=<char>] [--bad-tolerance=<num>]
[--delimiter=<char>] [--high-parallel-io=on|off|auto]
[--id-type=string|integer|actual] [--input-encoding=<character-set>]
[--input-type=csv|parquet] [--max-off-heap-memory=<size>] [--quote=<char>]
[--read-buffer-size=<size>] [--report-file=<path>] [--schema=<path>]
[--stage=all|prepare|build|merge] [--threads=<num>] --nodes=[<label>[:
<label>]...=]<files>... [--nodes=[<label>[:<label>]...=]<files>...]...
[--relationships=[<type>=]<files>...]... [--multiline-fields=true|false|<path>[,
<path>] [--multiline-fields-format=v1|v2]] <database>
neo4j-admin database import incremental [-h] [--expand-commands] --force [--update-all-matching-relationships]
[--verbose] [--auto-skip-subsequent-headers[=true|false]]
[--ignore-empty-strings[=true|false]] [--ignore-extra-columns[=true|false]]
[--legacy-style-quoting[=true|false]] [--normalize-types[=true|false]]
[--skip-bad-entries-logging[=true|false]] [--skip-bad-relationships
[=true|false]] [--skip-duplicate-nodes[=true|false]] [--strict[=true|false]]
[--trim-strings[=true|false]] [--additional-config=<file>]
[--array-delimiter=<char>] [--bad-tolerance=<num>] [--delimiter=<char>]
[--high-parallel-io=on|off|auto] [--id-type=string|integer|actual]
[--input-encoding=<character-set>] [--input-type=csv|parquet]
[--max-off-heap-memory=<size>] [--quote=<char>] [--read-buffer-size=<size>]
[--report-file=<path>] [--schema=<path>] [--stage=all|prepare|build|merge]
[--threads=<num>] --nodes=[<label>[:<label>]...=]<files>... [--nodes=[<label>[:
<label>]...=]<files>...]... [--relationships=[<type>=]<files>...]...
[--multiline-fields=true|false|<path>[,<path>]
[--multiline-fields-format=v1|v2]] <database>
----

=== Description
Expand Down Expand Up @@ -878,6 +879,10 @@ performance, this value should not be greater than the number of available proce
|Whether or not strings should be trimmed for whitespaces.
|false

|--update-all-matching-relationships
|label:new[Introduced in 2025.01] If one relationship data entry matches multiple existing relationships, this decides whether to update all matching, or to instead log as error.
|false

|--verbose
|Enable verbose output.
|
Expand Down
Loading