NAME

REST::Neo4p - Perl object bindings for a Neo4j database

SYNOPSIS

  use REST::Neo4p;
  REST::Neo4p->connect('http://127.0.0.1:7474');

DESCRIPTION

REST::Neo4p provides a Perl 5 object framework for accessing and manipulating a Neo4j graph database server via the Neo4j REST API. Its goals are

(1) to make the API as transparent as possible, allowing the user to work exclusively with Perl objects, and

(2) to exploit the API's self-discovery mechanisms, avoiding as much as possible internal hard-coding of URLs.

Neo4j entities are represented by corresponding classes:

• Nodes : REST::Neo4p::Node

• Relationships : REST::Neo4p::Relationship

• Indexes : REST::Neo4p::Index

Actions on class instances have a corresponding effect on the database (i.e., REST::Neo4p approximates an ORM).

The class REST::Neo4p::Query provides a DBIesqe Cypher query facility.

CLASS METHODS

connect()

 REST::Neo4p->connect( $server )

get_node_by_id()

 $node = REST::Neo4p->get_node_by_id( $id );

get_relationship_by_id()

 $relationship = REST::Neo4p->get_relationship_by_id( $id );

get_index_by_name()

 $index = REST::Neo4p->get_index_by_name( $name );

get_relationship_types()

 @all_relationship_types = REST::Neo4p->get_relationship_types;

get_indexes(), get_node_indexes(), get_relationship_indexes()

 @all_indexes = REST::Neo4p->get_indexes;
 @node_indexes = REST::Neo4p->get_node_indexes;
 @relationship_indexes = REST::Neo4p->get_relationship_indexes;

AUTHOR

    Mark A. Jensen
    CPAN ID: MAJENSEN
    majensen -at- cpan -dot- org

LICENSE

Copyright (c) 2012 Mark A. Jensen. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.