The Neo4j Manual v1.3

License: Creative Commons 3.0
Revision History

Table of Contents

Introduction
1. Who should read this
2. Neo4j highlights
I. Reference Documentation
1. Installation & Deployment
1.1. Deployment Scenarios
1.2. System Requirements
1.3. Installation
1.4. Upgrading
1.5. Usage Data Collector
2. Configuration & Performance
2.1. Caches in Neo4j
2.2. JVM Settings
2.3. Compressed storage of short strings
3. Transaction management
3.1. Interaction cycle
3.2. Isolation levels
3.3. Default locking behavior
3.4. Deadlocks
3.5. Delete semantics
4. Neo4j Server
4.1. Server Installation
4.2. Server Configuration
4.3. Setup for remote debugging
4.4. Starting the Neo4j server in high availability mode
4.5. Server Plugins
4.6. Tuning the server performance
4.7. Unmanaged Extensions
5. Indexing
5.1. Introduction
5.2. Create
5.3. Delete
5.4. Add
5.5. Remove
5.6. Update
5.7. Search
5.8. Relationship indices
5.9. Scores
5.10. Configuration and fulltext indices
5.11. Extra features for Lucene indices
5.12. Batch insertion
6. Graph Algorithms
6.1. Introduction
6.2. Path finding examples
7. High Availability
7.1. Architecture
7.2. Setup and configuration
7.3. How Neo4j HA operates
8. Operations
8.1. Backup
8.2. Security
8.3. Monitoring
II. Tools
9. Web Administration
9.1. Dashboard tab
9.2. Data tab
9.3. Console tab
9.4. The JMX tab
10. Neo4j Shell
10.1. Starting the shell
10.2. Passing options and arguments
10.3. Enum options
10.4. Filters
10.5. Node titles
10.6. How to use (individual commands)
10.7. Extending the shell: Adding your own commands
III. Troubleshooting
11. Troubleshooting guide
12. Community support
A. Manpages
neo4j — Neo4j Server control and management
neo4j-shell — a command-line tool for exploring and manipulating a graph database
neo4j-coordinator — Neo4j Coordinator for High-Availability clusters
neo4j-coordinator-shell — Neo4j Coordinator Shell interactive interface

List of Figures

4.1. Neo4j Coordinator MBeans View
7.1. Typical setup when running multiple Neo4j instances in HA mode
8.1. Connecting JConsole to the Neo4j Java process
8.2. Neo4j MBeans View
9.1. Web Administration Dashboard
9.2. Entity charting
9.3. Status indicator panels
9.4. Browsing and manipulating data
9.5. Manipulating data with Gremlin
9.6. JMX Attributes

List of Tables

1.1. Neo4j deployment options
2.1. Guidelines for heap size
4.1. neo4j-wrapper.conf JVM tuning properties
5.1. Lucene indexing configuration parameters
7.1. HighlyAvailableGraphDatabase configuration parameters
8.1. MBeans exposed by the Neo4j Kernel
8.2. MBean Memory Mapping
8.3. MBean Locking
8.4. MBean Transactions
8.5. MBean Cache
8.6. MBean Configuration
8.7. MBean Primitive count
8.8. MBean XA Resources
8.9. MBean Store file sizes
8.10. MBean Kernel
8.11. MBean High Availability