Home Reference Source
import ResultSummary from 'neo4j-driver/lib/v1/result-summary.js'
public class | source

ResultSummary

A ResultSummary instance contains structured metadata for a Result.

Constructor Summary

Public Constructor
public

constructor(statement: string, parameters: Object, metadata: Object)

Member Summary

Public Members
public

counters: StatementStatistics

Counters for operations the statement triggered.

public

notifications: Array<Notification>

An array of notifications that might arise when executing the statement.

public

plan: Plan

This describes how the database will execute the statement.

public

profile: ProfiledPlan

This describes how the database did execute your statement.

public

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

public

The time it took the server to consume the result.

public

server: ServerInfo

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

public

statement: {text: string, parameters: Object}

The statement and parameters this summary is for.

public

statementType: string

The type of statement executed.

public

Method Summary

Public Methods
public

hasPlan(): boolean

Check if the result summary has a plan

public

hasProfile(): boolean

Check if the result summary has a profile

Public Constructors

public constructor(statement: string, parameters: Object, metadata: Object) source

Params:

NameTypeAttributeDescription
statement string

The statement this summary is for

parameters Object

Parameters for the statement

metadata Object

Statement metadata

Public Members

public counters: StatementStatistics source

Counters for operations the statement triggered.

public notifications: Array<Notification> source

An array 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.

public plan: Plan source

This describes how the database will execute the statement. Statement plan for the executed statement if available, otherwise undefined. Will only be populated for queries that start with "EXPLAIN".

public profile: ProfiledPlan source

This describes how the database did execute your statement. This will contain detailed information about what each step of the plan did. Profiled statement plan for the executed statement if available, otherwise undefined. Will only be populated for queries that start with "PROFILE".

public resultAvailableAfter: number source

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

public resultConsumedAfter: number source

The time it took the server to consume the result.

public server: ServerInfo source

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

public statement: {text: string, parameters: Object} source

The statement and parameters this summary is for.

public statementType: string source

The type of statement executed. Can be "r" for read-only statement, "rw" for read-write statement, "w" for write-only statement and "s" for schema-write statement. String constants are available in statementType object.

public updateStatistics: * source

Public Methods

public hasPlan(): boolean source

Check if the result summary has a plan

Return:

boolean

public hasProfile(): boolean source

Check if the result summary has a profile

Return:

boolean