The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Neo4j::Bolt::Relationship - Representation of a Neo4j Relationship

SYNOPSIS

 $q = 'MATCH ()-[r]-() RETURN r';
 $reln = ( $cxn->run_query($q)->fetch_next )[0];
 
 $reln_id       = $reln->{id};
 $reln_type     = $reln->{type};
 $start_node_id = $reln->{start};
 $end_node_id   = $reln->{end};
 $properties    = $reln->{properties} // {};
 %properties    = %$properties;
 
 $value1 = $reln->{properties}->{property1};
 $value2 = $reln->{properties}->{property2};
 
 $hashref = $reln->as_simple;

DESCRIPTION

Neo4j::Bolt::Relationship instances are created by executing a Cypher query that returns relationships from a Neo4j database. Their properties and metadata can be accessed as shown in the synopsis above.

This package inherits from Neo4j::Types::Relationship, which offers an object-oriented interface to the relationship's properties and metadata. This is entirely optional to use.

If a query returns the same relationship twice, two separate Neo4j::Bolt::Relationship instances will be created.

METHODS

This package inherits all methods from Neo4j::Types::Relationship. The following additional method is provided:

as_simple()
 $simple = $reln->as_simple;
 
 $reln_id       = $simple->{_relationship};
 $reln_type     = $simple->{_type};
 $start_node_id = $simple->{_start};
 $end_node_id   = $simple->{_end};
 $value1        = $simple->{property1};
 $value2        = $simple->{property2};

Get relationship as a simple hashref in the style of REST::Neo4p.

The value of properties named _relationship, _type, _start or _end will be replaced with the relationship's metadata.

SEE ALSO

Neo4j::Bolt, Neo4j::Types::Relationship

AUTHOR

 Arne Johannessen
 CPAN: AJNN

LICENSE

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004