Home Reference Source

References

summary
public

C Driver

A driver maintains one or more Sessions with a remote Neo4j instance.

public

Class for all errors thrown/returned by the driver.

public

C Node

Class for Node Type.

public

C Path

Class for Path Type.

public

Class for PathSegment Type.

public

Class for Relationship Type.

public

C Integer(low: number, high: number)

Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as signed integers. See exported functions for more convenient ways of operating integers. Use int() function to create new integers, isInt() to check if given object is integer, inSafeRange() to check if it is safe to convert given value to native number, toNumber() and toString() to convert given integer to number or string respectively.

public

C Record

Records make up the contents of the Result, and is how you access the output of a query.

public
public

A ResultSummary instance contains structured metadata for a Result.

public

C Result

A stream of Record representing the result of a query.

public

A Reactive session, which provides the same functionality as Session but through a Reactive API.

public

A Session instance is used for handling the connection and sending queries through the connection.

public

C Point

Represents a single two or three-dimensional point in a particular coordinate reference system.

public

C Date

Represents an instant capturing the date, but not the time, nor the timezone.

public

Represents an instant capturing the date, the time and the timezone identifier.

public

Represents an ISO 8601 duration.

public

Represents an instant capturing the date and the time, but not the timezone.

public

Represents an instant capturing the time of day, but not the date, nor the timezone.

public

C Time

Represents an instant capturing the time of day, and the timezone offset in seconds, but not the date.

public

A reactive transaction, which provides the same functionality as Transaction but through a Reactive API.

public

Represents a transaction in the Neo4j database.

public

F isNode(obj: Object): boolean

Test if given object is an instance of Node class.

public

F isPath(obj: Object): boolean

Test if given object is an instance of Path class.

public

F isPathSegment(obj: Object): boolean

Test if given object is an instance of PathSegment class.

public

F isRelationship(obj: Object): boolean

Test if given object is an instance of Relationship class.

public

F isUnboundRelationship(obj: Object): boolean

Test if given object is an instance of UnboundRelationship class.

public

F driver(url: string, authToken: Map<string, string>, config: Object): Driver

Construct a new Neo4j Driver.

public

F isPoint(obj: Object): boolean

Test if given object is an instance of Point class.

public

F isDate(obj: Object): boolean

Test if given object is an instance of Date class.

public

F isDateTime(obj: Object): boolean

Test if given object is an instance of DateTime class.

public

F isDuration(obj: Object): boolean

Test if given object is an instance of Duration class.

public

F isLocalDateTime(obj: Object): boolean

Test if given object is an instance of LocalDateTime class.

public

F isLocalTime(obj: Object): boolean

Test if given object is an instance of LocalTime class.

public

F isTime(obj: Object): boolean

Test if given object is an instance of Time class.

public

V READ: string

Constant that represents read session access mode.

public

V WRITE: string

Constant that represents write session access mode.

public

V PROTOCOL_ERROR: string

Error code representing serialization/deserialization issue in the Bolt protocol.

public

Error code representing complete loss of service.

public

V SESSION_EXPIRED: string

Error code representing transient loss of service.

public

V auth: {"basic": *, "kerberos": *, "custom": *}

public

V error: {"SERVICE_UNAVAILABLE": *, "SESSION_EXPIRED": *, "PROTOCOL_ERROR": *}

public

V forExport: {"driver": *, "int": *, "isInt": *, "isPoint": *, "isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *, "integer": *, "Neo4jError": *, "auth": *, "logging": *, "types": *, "session": *, "error": *, "spatial": *, "temporal": *}

public

V integer: {"toNumber": *, "toString": *, "inSafeRange": *}

public

V logging: {"console": *}

Object containing predefined logging configurations.

public

V session: {"READ": *, "WRITE": *}

public

V spatial: {"isPoint": *}

public

V temporal: {"isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *}

public

V types: {"Node": *, "Relationship": *, "UnboundRelationship": *, "PathSegment": *, "Path": *, "Result": *, "ResultSummary": *, "Record": *, "Point": *, "Date": *, "DateTime": *, "Duration": *, "LocalDateTime": *, "LocalTime": *, "Time": *, "Integer": *}

public

V inSafeRange(value: Mixed): Boolean: *

Check if a variable can be safely converted to a number

public

V int(value: Mixed): Integer: *

Cast value to Integer type.

public

V isInt(value: Mixed): Boolean: *

Check if a variable is of Integer type.

public

V toNumber(value: Mixed): number: *

Converts a variable to a number

public

V toString(value: Mixed, radix: number): string: *

Converts the integer to a string representation

public

V queryType: {SCHEMA_WRITE: string, WRITE_ONLY: string, READ_ONLY: string, READ_WRITE: string}

The constants for query types

public

T TransactionConfig: Object

Configuration object containing settings for explicit and auto-commit transactions.