Neo4j::Driver::Type::Relationship - Describes a relationship from a Neo4j graph


version 0.19


 $q = "MATCH (a:Person)-[k:KNOWS]->(b:Person) RETURN k";
 $rel = $driver->session->run($q)->list->[0]->get('k');
 print 'Person # ', $rel->start_id;
 print ' ', $rel->type;
 print ' person # ', $rel->end_id;
 print ' since ', $rel->properties->{since};


Describes a relationship from a Neo4j graph. A relationship may be a part of records returned from Cypher statement execution. Its description contains the relationship's properties as well as certain meta data, all accessible by methods that this class provides.

Neo4j::Driver::Type::Relationship objects are not in a one-to-one relation with relationships in a Neo4j graph. If the same Neo4j relationship is fetched multiple times, then multiple distinct Neo4j::Driver::Type::Relationship objects will be created by the driver. If your intention is to verify that two Neo4j::Driver::Type::Relationship objects in Perl describe the same node in the Neo4j database, you need to compare their IDs.


Neo4j::Driver::Type::Relationship implements the following methods.


 $value = $relationship->get('property_key');

Retrieve the value of this relationship's property with the given key. If no such key exists, return undef.


 $id = $relationship->id;

Return a unique ID for this relationship.

In the Neo4j Driver API, entity IDs are only guaranteed to remain stable for the duration of the current session. Although in practice server versions at least up to and including Neo4j 3.5 may appear to use persistent IDs, your code should not depend upon that.

A relationship with the ID 0 may exist. Nodes and relationships do not share the same ID space.


 $hashref = $relationship->properties;
 $value = $hashref->{property_key};

Return all properties of this relationship as a hash reference.


 $id = $relationship->start_id;

Return the ID of the node where this relationship starts.


 $id = $relationship->end_id;

Return the ID of the node where this relationship ends.


 $type = $relationship->type;

Return the type of this relationship.


Neo4j::Driver::Type::Relationship implements the following experimental features. These are subject to unannounced modification or removal in future versions. Expect your code to break if you depend upon these features.

Deletion indicator

 $node_exists = ! $relationship->deleted;

In some circumstances, Cypher statements using DELETE may still RETURN relationships that were deleted. To help avoid confusion in such cases, the server sometimes reports whether or not a relationship was deleted.

This method is experimental because that information is not reliably available. In particular, there is a known issue with the Neo4j server (#12306), and old Neo4j versions may not report it at all. If unavailable, undef will be returned by this method.


The value of properties named _meta, _relationship, _start, _end, or _type may not be returned correctly.

When using HTTP, the type of relationships that are returned as part of a Neo4j::Driver::Type::Path is unavailable, because that information is not currently reported by the Neo4j server. undef is returned instead.



Arne Johannessen <>


This software is Copyright (c) 2016-2021 by Arne Johannessen.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)