The Neo4j Manual v2.3-SNAPSHOTneo4j-backup

Name

neo4j-backup
— Neo4j Backup Tool

Synopsis

neo4j-backup -host <host> [-port <port>] -to target_directory

DESCRIPTION

A tool to perform live backups over the network from a running Neo4j graph database onto a local filesystem.
Backups can be either full or incremental.
The first backup must be a full backup, after that incremental backups can be performed.

The source(s) are given as host:port pairs, the target is a filesystem location.

BACKUP TYPE

-full

copies the entire database to a directory.

-incremental

copies the changes that have taken place since the last full or
incremental backup to an existing backup store.

The backup tool will automatically detect whether it needs to do a full or an incremental backup.

SOURCE ADDRESS

Backup sources are given in the following format:
*-host <host> [-port <port>]*
*host*::
In single mode, the host of a source database; in HA mode, the cluster address of a cluster member.
*port*::
In single mode, the port of a source database backup service; in HA mode, the port of a cluster instance. If not given, the default value `6362` will be used for single mode, `5001` for HA.
[[neo4j-backup-manpage-usage-important]]
IMPORTANT

Backups can only be performed on databases which have the configuration parameter enable_online_backup=true set.
That will make the backup service available on the default port (6362).
To enable the backup service on a different port use for example enable_online_backup=port=9999 instead.