/ 
Neo4j-Driver-1.02
River stage one • 1 direct dependent • 2 total dependents
/ Neo4j::Driver::ResultSummary

NAME

Neo4j::Driver::ResultSummary - Details about the result of running a query

VERSION

version 1.02

SYNOPSIS

$summary = $session->execute_write( sub ($transaction) {
  return $transaction->run( ... )->consume;
});

# SummaryCounters
$counters = $summary->counters;

# Query information
$query  = $summary->query->{text};
$params = $summary->query->{parameters};
$plan   = $summary->plan;
@notes  = $summary->notifications;

# ServerInfo
$address = $summary->server->address;
$version = $summary->server->agent;

DESCRIPTION

The result summary of running a query. The result summary can be used to investigate details about the result, like the Neo4j server version, how many and which kinds of updates have been executed, and query plan information if available.

To obtain a result summary, call "consume" in Neo4j::Driver::Result.

METHODS

Neo4j::Driver::ResultSummary implements the following methods.

counters

$summary_counters = $summary->counters;

Returns the SummaryCounters with statistics counts for operations the query triggered.

notifications

@notifications = $summary->notifications;

use Data::Printer;
p @notifications;

A list of notifications that might arise when executing the query. Notifications can be warnings about problematic queries or other valuable information that can be presented in a client. Unlike failures or errors, notifications do not affect the execution of a query. In scalar context, return the number of notifications.

This driver only supports notifications over HTTP.

plan

$plan = $summary->plan;

use Data::Printer;
p $plan;

This describes how the database will execute your query. Available if this is the summary of a Cypher EXPLAIN query.

This driver only supports execution plans over HTTP.

query

$query  = $summary->query->{text};
$params = $summary->query->{parameters};

The executed query and query parameters this summary is for.

Before driver version 1.00, the query was retrieved with the statement() method. That method has since been deprecated, matching a corresponding change in Neo4j 4.0.

server

$address = $summary->server->address;
$version = $summary->server->agent;

The ServerInfo, consisting of the host, port, protocol and Neo4j version.

SEE ALSO

AUTHOR

Arne Johannessen (AJNN)

COPYRIGHT AND LICENSE

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

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0 or (at your option) the same terms as the Perl 5 programming language system itself.