		Next

The Neo4j Manual v1.6

The Neo4j Team neo4j.org neotechnology.com

Copyright © 2012 Neo Technology

License: Creative Commons 3.0

2012-01-22 14:57:04

Quickstart

Table of Contents

I. Introduction

1. Neo4j Highlights

2. Graph Database Concepts

2.1. What is a Graph Database?
2.2. Comparing Database Models

3. The Neo4j Graph Database

3.1. Nodes
3.2. Relationships
3.3. Properties
3.4. Paths
3.5. Traversal

II. Tutorials

4. Using Neo4j embedded in Java applications

4.1. Include Neo4j in your project
4.2. Hello World
4.3. User database with index
4.4. Traversal
4.5. Domain entities
4.6. Graph Algorithm examples
4.7. Reading a management attribute
4.8. Cypher Queries

5. Cypher Cookbook

5.1. Hyperedges and Cypher
5.2. Basic Friend finding based on social neighborhood
5.3. Co-favorited places
5.4. Find people based on similar favorites
5.5. Multirelational (social) graphs

6. Using the Neo4j REST API

6.1. How to use the REST API from Java

7. Extending the Neo4j Server

7.1. Server Plugins
7.2. Unmanaged Extensions

8. The Traversal Framework

8.1. Main concepts
8.2. Traversal Framework Java API

9. Domain Modeling Gallery

9.1. User roles in graphs
9.2. ACL structures in graphs

10. Languages

11. Using Neo4j embedded in Python applications

11.1. Hello, world!
11.2. A sample app using traversals and indexes

III. Reference

12. Capabilities

12.1. Data Security
12.2. Data Integrity
12.3. Data Integration
12.4. Availability and Reliability
12.5. Capacity

13. Transaction Management

13.1. Interaction cycle
13.2. Isolation levels
13.3. Default locking behavior
13.4. Deadlocks
13.5. Delete semantics
13.6. Creating unique nodes
13.7. Transaction events

14. Indexing

14.1. Introduction
14.2. Create
14.3. Delete
14.4. Add
14.5. Remove
14.6. Update
14.7. Search
14.8. Relationship indexes
14.9. Scores
14.10. Configuration and fulltext indexes
14.11. Extra features for Lucene indexes
14.12. Batch insertion
14.13. Automatic Indexing

15. Cypher Query Language

15.1. Compatibility
15.2. Parameters
15.3. Identifiers
15.4. Start
15.5. Match
15.6. Where
15.7. Return
15.8. Aggregation
15.9. Order by
15.10. Skip
15.11. Limit
15.12. Functions

16. Graph Algorithms

16.1. Introduction

17. Neo4j Server

17.1. Server Installation
17.2. Server Configuration
17.3. Setup for remote debugging
17.4. Using the server (including web administration) with an embedded database
17.5. Server Performance Tuning
17.6. Server Installation in the Cloud

18. REST API

18.1. Service root
18.2. Nodes
18.3. Relationships
18.4. Relationship types
18.5. Node properties
18.6. Relationship properties
18.7. Indexes
18.8. Unique Indexes
18.9. Automatic Indexes
18.10. Configurable Automatic Indexing
18.11. Traversals
18.12. Cypher queries
18.13. Built-in Graph Algorithms
18.14. Batch operations
18.15. Cypher Plugin
18.16. Gremlin Plugin

19. Python embedded bindings

19.1. Installation
19.2. Core API
19.3. Indexes
19.4. Cypher Queries
19.5. Traversals

IV. Operations

20. Installation & Deployment

20.1. Deployment Scenarios
20.2. System Requirements
20.3. Installation
20.4. Upgrading
20.5. Usage Data Collector

21. Configuration & Performance

21.1. Introduction
21.2. Performance Guide
21.3. Caches in Neo4j
21.4. JVM Settings
21.5. Compressed storage of short strings
21.6. Compressed storage of short arrays
21.7. Memory mapped IO settings
21.8. Linux Performance Guide
21.9. Linux specific notes

22. High Availability

22.1. Architecture
22.2. Setup and configuration
22.3. How Neo4j HA operates
22.4. High Availability setup tutorial
22.5. Setting up HAProxy as a load balancer

23.1. Embedded and Server
23.2. Online Backup from Java
23.3. High Availability
23.4. Restoring Your Data

24. Security

24.1. Securing access to the Neo4j Server

25. Monitoring

25.1. JMX

26. Web Administration

26.1. Dashboard tab
26.2. Data tab
26.3. Console tab
26.4. The Server Info tab

27. Neo4j Shell

27.1. Starting the shell
27.2. Passing options and arguments
27.3. Enum options
27.4. Filters
27.5. Node titles
27.6. How to use (individual commands)
27.7. Extending the shell: Adding your own commands
27.8. An example shell session
27.9. A Matrix example

VI. Community

28. Community Support

29. Contributing to Neo4j

29.1. Contributor License Agreement
29.2. Writing Neo4j Documentation
29.3. Areas for contribution
29.4. Contributors

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

B. Questions & Answers

List of Figures

List of Tables

3.1. Using relationship direction and type
3.2. Property value types
6.1. Neo4j REST clients contributed by the community.
10.1. Neo4j embedded drivers contributed by the community.
14.1. Lucene indexing configuration parameters
17.1. neo4j-wrapper.conf JVM tuning properties
20.1. Neo4j deployment options
20.2. Neo4j editions
20.3. Upgrade process for Neo4J version
21.1. Guidelines for heap size
22.1. HighlyAvailableGraphDatabase configuration parameters
25.1. MBeans exposed by the Neo4j Kernel
25.2. MBean Memory Mapping
25.3. MBean Locking
25.4. MBean Transactions
25.5. MBean Cache
25.6. MBean Configuration
25.7. MBean Primitive count
25.8. MBean XA Resources
25.9. MBean Store file sizes
25.10. MBean Kernel
25.11. MBean High Availability

Copyright © 2012 Neo Technology