Getting Started With Apoc

From Neo4j Wiki

Jump to: navigation, search

Apoc is A Package Of Components, i.e. a handful of useful Neo4j components bundled together in one convenient package. It includes sample code that demonstrates basic usage of these components.

Apoc contains no new actual functionality but is simply a a meta package of components that we noticed were "always" included in new projects.

Contents

[edit] Components included in Apoc

Apoc currently includes four components:

  • neo4j-kernel -- the Neo4j kernel
  • neo4j-index -- an indexing component that lets you look up nodes by property value
  • neo4j-shell -- a command line browser that allows you to connect to a running Neo4j instance and browse the graph using familiar Unix commands like ls, cd and pwd
  • neo4j-remote-graphdb -- an implementation of the Neo4j API that delegates all operations to a remote Neo4j instance
  • neo4j-online-backup -- backup a running Neo4j instance (included since 1.1)
  • neo4j-graph-algo -- graph algorithms like shortest-path for Neo4j (included since 1.1)

[edit] How to get started with Apoc

[edit] In your IDE

There's pre-configured projects which are ready to be opened in an IDE:

Note: these downloads are using the (previous) Apoc 1.0 release

Note that recent NetBeans versions open Maven projects natively. Eclipse needs a Maven plug-in installed.

[edit] Using Maven

Apoc is a Maven project that depends on the four components listed above. So you only have to declare a single dependency in your application's POM to get a tested set of useful components on top of Neo4j itself. Simply add the following to your pom.xml: 

<project>
...
   <repositories>
      <repository>
         <id>neo4j-public-repository</id>
         <name>Publically available Maven 2 repository for Neo4j</name>
         <url>http://m2.neo4j.org </url>
         <snapshots>
           <enabled>true</enabled>
         </snapshots>
      </repository>
   </repositories>
...
   <dependencies>
      <dependency>
         <groupId>org.neo4j</groupId>
         <artifactId>neo4j-apoc</artifactId>
         <version>1.1</version>
         <type>pom</type>
      </dependency>
      ...
   </dependencies>
...
</project>

Code examples using the libraries are found in the neo4j-apoc-examples source code.

[edit] Using a downloaded zip/tarball

  1. Download the libraries together with examples: neo4j-apoc-1.1.tar.gz neo4j-apoc-1.1.zip
  2. Unpack the downloaded file
  3. The contents of the download:
    • bin shortcuts to start the example applications on *nix or Windows systems
    • examples source code of the examples
    • lib the Apoc libraries
    • LICENSE, NOTICE, README general and license information

[edit] How to use Apoc

  1. Try out the examples and learn from the code
  2. Check out the introductory 10-minute Getting Started Guide
  3. Read in the apidocs to get the finer points regarding neo4j: http://api.neo4j.org/
  4. Find more information about the included libraries on the Apoc component page http://components.neo4j.org/apoc/
  5. Go to the Main Page and look for more getting started information
Retrieved from "http://wiki.neo4j.org/content/Getting_Started_With_Apoc"
Personal tools