Back up an offline database

The neo4j-admin database dump command can be used for performing a full backup of an offline database. It dumps a database into a single-file archive, called .dump, and stores it in the /data directory. Alternatively, neo4j-admin database dump can stream dump to standard output, enabling the output to be piped to another program, for example to neo4j-admin database load.

If the database is hosted in a cluster, make sure that the database is stopped on the server you are connected to. The command can be run only locally from an online or an offline Neo4j DBMS. It does not support SSL/TLS.

Dump a database into a single-file archive. The archive can be used by the load command. should be a directory (in which case a file called .dump will be created), or --to-stdout can be supplied to use standard output. If neither --to-path or --to-stdout is supplied server.directories.dumps.root setting will be used as a destination. It is not possible to dump a database that is mounted in a running Neo4j server.

Name of the database to dump. Can contain * and ? for globbing. Note that * and ? have special meaning in some shells and might need to be escaped or used with quotes.

The neo4j-admin database dump command has the following options:

--additional-config=

Configuration file with additional configuration.

--expand-commands

Allow command expansion in config value evaluation.

-h, --help

Show this help message and exit.

--overwrite-destination[=true|false]

Overwrite any existing dump file in the destination folder.

false

--to-path=

Destination folder of a database dump.

--to-stdout

Use standard output as the destination for the database dump.

--verbose

Enable verbose output.