26.1. Introducing Backup

Backups are performed over the network, from a running Neo4j server and into a local copy of the database store (the backup). The backup is run using the neo4j-backup tool, which is provided alongside Neo4j Enterprise.

[Important]Important

Neo4j Server must be configured to run a backup service. This is enabled via the configuration parameter online_backup_enabled, and is enabled by default. The interface and port the backup service listens on is configured via the parameter online_backup_server and defaults to the loopback interface and port 6362. It is typical to reconfigure this to listen on an external interface, by setting online_backup_server=<my-host-ip-address>:6362. It can also be configured to listen on all interfaces by setting online_backup_server=0.0.0.0:6362.

Performing a backup requires specifying the target host, an optional port, and the backup location. The backup tool will automatically select a full or incremental backup, based on whether an existing backup is present at that location.

The relevant configuration settings are found below.

Online backup configuration settings

NameDescription

online_backup_enabled

Enable support for running online backups.

online_backup_server

Listening server for online backups.

online_backup_enabled

Description

Enable support for running online backups.

Valid values

online_backup_enabled is a boolean.

Default value

true

online_backup_server

Description

Listening server for online backups.

Valid values

online_backup_server is a hostname and port.

Default value

0.0.0.0:6362-6372

Consistency check configuration settings

NameDescription

consistency_check_execution_order

Execution order of store cross-checks to be used when running consistency check.

consistency_check_graph

Perform checks between nodes, relationships, properties, types and tokens.

consistency_check_indexes

Perform checks on indexes.

consistency_check_label_scan_store

Perform checks on the label scan store.

consistency_check_property_owners

Perform optional additional checking on property ownership.

consistency_check_report_file

File name for inconsistencies log file.

consistency_check_execution_order

Description

Execution order of store cross-checks to be used when running consistency check.

Valid values

consistency_check_execution_order is one of SINGLE_THREADED, MULTI_PASS.

Default value

MULTI_PASS

consistency_check_graph

Description

Perform checks between nodes, relationships, properties, types and tokens.

Valid values

consistency_check_graph is a boolean.

Default value

true

consistency_check_indexes

Description

Perform checks on indexes. Checking indexes is more expensive than checking the native stores, so it may be useful to turn off this check for very large databases.

Valid values

consistency_check_indexes is a boolean.

Default value

true

consistency_check_label_scan_store

Description

Perform checks on the label scan store. Checking this store is more expensive than checking the native stores, so it may be useful to turn off this check for very large databases.

Valid values

consistency_check_label_scan_store is a boolean.

Default value

true

consistency_check_property_owners

Description

Perform optional additional checking on property ownership. This can detect a theoretical inconsistency where a property could be owned by multiple entities. However, the check is very expensive in time and memory, so it is skipped by default.

Valid values

consistency_check_property_owners is a boolean.

Default value

false

consistency_check_report_file

Description

File name for inconsistencies log file. If not specified, logs to a file in the store directory.

Valid values

consistency_check_report_file is a path which is relative to store_dir.