org.neo4j.driver.v1.summary

Interface ResultSummary

@Immutable
public interface ResultSummary

The result summary of running a statement. The result summary interface can be used to investigate details about the result, like the type of query run, how many and which kinds of updates have been executed, and query plan and profiling information if available. The result summary is only available after all result records have been consumed. Keeping the result summary around does not influence the lifecycle of any associated session and/or transaction.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
SummaryCounters	counters()
boolean	hasPlan()
boolean	hasProfile()
List<Notification>	notifications() A list of notifications that might arise when executing the statement.
Plan	plan() This describes how the database will execute your statement.
ProfiledPlan	profile() This describes how the database did execute your statement.
long	resultAvailableAfter(TimeUnit unit) The time it took the server to make the result available for consumption.
long	resultConsumedAfter(TimeUnit unit) The time it took the server to consume the result.
ServerInfo	server() The basic information of the server where the result is obtained from
Statement	statement()
StatementType	statementType()

Method Detail

statement

Statement statement()

Returns:

statement that has been executed

counters

SummaryCounters counters()

Returns:

counters for operations the statement triggered

statementType

StatementType statementType()

Returns:

type of statement that has been executed

hasPlan

boolean hasPlan()

Returns:

true if the result contained a statement plan, i.e. is the summary of a Cypher "PROFILE" or "EXPLAIN" statement

hasProfile

boolean hasProfile()

Returns:

true if the result contained profiling information, i.e. is the summary of a Cypher "PROFILE" statement

plan

Plan plan()

This describes how the database will execute your statement.

Returns:

statement plan for the executed statement if available, otherwise null

profile

ProfiledPlan profile()

This describes how the database did execute your statement. If the statement you executed was profiled, the statement plan will contain detailed information about what each step of the plan did. That more in-depth version of the statement plan becomes available here.

Returns:

profiled statement plan for the executed statement if available, otherwise null

notifications

List<Notification> notifications()

A list of notifications that might arise when executing the statement. Notifications can be warnings about problematic statements or other valuable information that can be presented in a client. Unlike failures or errors, notifications do not affect the execution of a statement.

Returns:

a list of notifications produced while executing the statement. The list will be empty if no notifications produced while executing the statement.

resultAvailableAfter

long resultAvailableAfter(TimeUnit unit)

The time it took the server to make the result available for consumption.

Parameters:

unit - The unit of the duration.

Returns:

The time it took for the server to have the result available in the provided time unit.

resultConsumedAfter

long resultConsumedAfter(TimeUnit unit)

The time it took the server to consume the result.

Parameters:

unit - The unit of the duration.

Returns:

The time it took for the server to consume the result in the provided time unit.

server

ServerInfo server()

The basic information of the server where the result is obtained from

Returns:

basic information of the server where the result is obtain from