The Neo4j Operations Manual v5

This is the Neo4j Operations Manual, which includes all the operational details and instructions for installing and deploying Neo4j in a self-hosted environment or in the cloud.

For information on upgrading and migrating Neo4j, see Neo4j Upgrade and Migration Guide.

Neo4j AuraDB is a fully managed Neo4j database, hosted in the cloud and requires no installation. For more information, see the AuraDB product page and AuraDB documentation.

The latest version of Neo4j is 5.2.

Documentation updates for Neo4j 5

Documentation for running Neo4j v5 in a Docker container, and for running Neo4j v5 on Kubernetes, are coming soon.

  • Restructured chapter on clustering.

    The new clustering infrastructure decouples servers from databases, improving scalability and cloud-readiness. As such, the documentation has been restructured and rewritten. For a detailed description and instructions on how to set up clustering, see Clustering.

  • Composite databases.

    Fabric technology is used to improve the setting and management of sharded and federated databases with dynamic compositions of databases. A new surface to administer Fabric databases, named composite databases, is new in 5.0. Configuration settings have been removed and composite databases are now administered via Cypher commands. For more information, see the new chapter on Composite databases, which replaces the Fabric chapter from previous versions.

  • neo4j-admin refresh.

    All admin functionalities have been consolidated into a single tool, and all commands have been grouped by scope. There is an optional neo4j-admin conf file and individual conf files for each command so that there is more control over values provided for each command. Improved features, more control, and a consistent set of arguments for the database administrator.
    See Neo4j Admin and Neo4j CLI for details.

  • A major overhaul of backup and restore.

    The new backup subsystem provides:

    • Full and differential backup to an immutable file, and aggregation to compile a chain of backups into a full backup.

    • Differential backup reduces storage requirements and provides point-in-time restore on timestamps or transaction IDs.

    • A new backup API for backup management and operability and target multiple URIs in a single backup command to support Autonomous Clusters.

    The Backup subsystem from Neo4j 4.x is available as neo4j-admin database legacy-backup and legacy-restore.
    See Backup and restore section for detailed descriptions and instructions.

  • Incremental offline import.

    The neo4j-admin import command can now add more data to existing databases.
    Import chapter has been updated. You can find more details there.

  • Log4j integration completion.

    The logging framework is fully integrated with Log4j, providing more functionality and better control of all the database logs.
    Configuration settings are located in the $NEO4J_HOME/conf folder in the user-logs.xml used for neo4j.log and server-logs.xml used for debug.log, security.log, http.log, and query.log. Query log uses the same format as neo4j.log.
    Users are able to use/modify Log4j XML files.
    See the section on the logging mechanisms in Neo4j for more details.

  • Updates in the Cypher Shell section.

    • Cypher Shell supports impersonation.

      Cypher Shell users can impersonate other users via --impersonate or the command :impersonate (requires IMPERSONATE privileges).
      Visit Cypher Shell page for more details.

    • Cypher Shell logging.

      New option --log is introduced to enable Java Driver logging to the specified file. When users report problems with Java Driver/Bolt, now they can use Cypher Shell to try and replicate the issue without having to edit the client app that uses the driver.
      You can find more information in the Cypher Shell section.

  • Immutable privileges.

    Immutable privileges are useful for restricting the actions of users who themselves are able to administer privileges.
    Cloud operators can use sidecar design pattern to control RBAC-based permissions.
    You can find a tutorial on how to administer immutable privileges.

  • Changes to Neo4j indexes

    • The B-tree index type has been removed.

    • New Range and Point index types are available now.

    • Neo4j 5.1 introduces an improved index provider, text-2.0, for enhanced performance. New Text indexes will use the text-2.0 provider by default.

    • Full-text indexes can now index lists of strings.

      See Index configuration for more details.

© 2022 Neo4j, Inc.

Documentation license: Creative Commons 4.0