NAME

Neo4j::Bolt::DateTime - Representation of a Neo4j date/time related structure

SYNOPSIS

$q = "RETURN datetime('2021-01-21T12:00:00-0500')";
$dt = ( $cxn->run_query($q)->fetch_next )[0];

$neo4j_type = $dt->{neo4j_type}; # Date, Time, DateTime, LocalDateTime, LocalTime
$epoch_days = $dt->{epoch_days};
$epoch_secs = $dt->{epoch_secs};
$secs = $dt->{secs};
$nanosecs = $dt->{nsecs};
$offset_secs = $dt->{offset_secs};

$perl_dt = $node->as_DateTime;

DESCRIPTION

Neo4j::Bolt::DateTime instances are created by executing a Cypher query that returns one of the date/time Bolt structures from the Neo4j database. They can also be created locally and passed to Neo4j as query parameter. See "DateTime" in Neo4j::Types::Generic.

The values in the Bolt structures are described at https://neo4j.com/docs/bolt/current/bolt/structure-semantics/. The Neo4j::Bolt::DateTime objects possess values for the keys that are relevant to the underlying date/time structure.

This class conforms to the Neo4j::Types::DateTime API, which offers an object-oriented interface to the underlying date/time component values. This is entirely optional to use.

Use the "as_DateTime" method to obtain an equivalent DateTime object that is probably easier to use.

METHODS

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

• days()

• epoch()

• nanoseconds()

• seconds()

• type()

• tz_name()

• tz_offset()

The following additional method is provided:

as_DateTime()

$perl_dt  = $dt->as_DateTime;

$node_id = $simple->{_node};
@labels  = @{ $simple->{_labels} };
$value1  = $simple->{property1};
$value2  = $simple->{property2};

Obtain a DateTime object equivalent to the Neo4j structure returned by the database. Time and LocalTime objects generate a DateTime whose date is the first day of the Unix epoch (1970-01-01).

SEE ALSO

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

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