NAME

Neo4j::Bolt::Duration - Representation of a Neo4j duration structure

SYNOPSIS

$q = "RETURN datetime('P1Y10MT5H30S')";
$dt = ( $cxn->run_query($q)->fetch_next )[0];

$months = $dt->{months};
$days = $dt->{days};
$secs = $dt->{secs};
$nanosecs = $dt->{nsecs};

$perl_dt = $node->as_DTDuration;

DESCRIPTION

Neo4j::Bolt::Duration instances are created by executing a Cypher query that returns a duration value from the Neo4j database. They can also be created locally and passed to Neo4j as query parameter. See "Duration" in Neo4j::Types::Generic.

The values in the Bolt structure are described at https://neo4j.com/docs/bolt/current/bolt/structure-semantics/. The Neo4j::Bolt::Duration object possesses integer values for the keys months, days, secs, and nsecs.

This class conforms to the Neo4j::Types::Duration API, which offers an object-oriented interface to the duration's component values. This is entirely optional to use.

Use the "as_DTDuration" method to obtain an equivalent DateTime::Duration object that can be used in the DateTime context (e.g., to perform time arithmetic).

METHODS

This class provides the following methods defined by Neo4j::Types::Duration:

• days()

• months()

• nanoseconds()

• seconds()

The following additional method is provided:

as_DTDuration()

$perl_dt  = $dt->as_DTDuration;

SEE ALSO

Neo4j::Bolt, Neo4j::Types::Duration, DateTime, DateTime::Duration

AUTHOR

Mark A. Jensen
CPAN: MAJENSEN

LICENSE

This software is Copyright (c) 2024 by Mark A. Jensen.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004