Home Reference Source

Variable

Static Public Summary
public

PROTOCOL_ERROR: string

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

READ: string

Constant that represents read session access mode.
public

Error code representing complete loss of service.
public

SESSION_EXPIRED: string

Error code representing transient loss of service.
public

WRITE: string

Constant that represents write session access mode.
public

auth: {"basic": *, "kerberos": *, "bearer": *, "none": *, "custom": *}

public

Holds the common AuthTokenManagers used in the Driver.
public
this variable is experimental. Exposed as preview feature.

Holds the common ClientCertificateProviders used in the Driver.

 since 5.19
public

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

Object containing string constants representing predefined Neo4jError codes.
public

forExport: {"authTokenManagers": *, "driver": *, "hasReachableServer": *, "int": *, "isInt": *, "isPoint": *, "isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *, "isNode": *, "isPath": *, "isPathSegment": *, "isRelationship": *, "isUnboundRelationship": *, "integer": *, "Neo4jError": *, "isRetryableError": *, "auth": *, "logging": *, "types": *, "session": *, "routing": *, "error": *, "graph": *, "spatial": *, "temporal": *, "Driver": *, "Session": *, "Transaction": *, "ManagedTransaction": *, "Result": *, "EagerResult": *, "RxSession": *, "RxTransaction": *, "RxManagedTransaction": *, "RxResult": *, "ResultSummary": *, "Plan": *, "ProfiledPlan": *, "QueryStatistics": *, "Notification": *, "GqlStatusObject": *, "ServerInfo": *, "Record": *, "Node": *, "Relationship": *, "UnboundRelationship": *, "Path": *, "PathSegment": *, "Point": *, "Integer": *, "Duration": *, "LocalTime": *, "Time": *, "Date": *, "LocalDateTime": *, "DateTime": *, "bookmarkManager": *, "resultTransformers": *, "notificationCategory": *, "notificationSeverityLevel": *, "notificationFilterDisabledCategory": *, "notificationFilterMinimumSeverityLevel": *, "clientCertificateProviders": *}

public

graph: {"isNode": *, "isPath": *, "isPathSegment": *, "isRelationship": *, "isUnboundRelationship": *}

public

inSafeRange(value: Mixed): Boolean: *

Check if a variable can be safely converted to a number
public

int(value: Mixed, opts: Object): Integer: *

Cast value to Integer type.
public

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

public

isInt(value: Mixed): Boolean: *

Check if a variable is of Integer type.
public

isRetriableError(error: object | undefined | null): boolean: *

Verifies if the given error is retriable.
public

logging: {"console": *}

Object containing predefined logging configurations.
public

notificationCategory: {"HINT": string, "UNRECOGNIZED": string, "UNSUPPORTED": string, "PERFORMANCE": string, "DEPRECATION": string, "TOPOLOGY": string, "SECURITY": string, "GENERIC": string, "SCHEMA": string, "UNKNOWN": string}

Constants that represents the Category in the Notification
public
this variable is experimental.

Constants that represents the Classification in the GqlStatusObject
public

notificationFilterDisabledCategory: {"HINT": string, "UNRECOGNIZED": string, "UNSUPPORTED": string, "PERFORMANCE": string, "TOPOLOGY": string, "SECURITY": string, "DEPRECATION": string, "GENERIC": string, "SCHEMA": string}

Constants that represents the disabled categories in the NotificationFilter
public
this variable is experimental.

Constants that represents the disabled classifications in the NotificationFilter
public

notificationFilterMinimumSeverityLevel: {"OFF": string, "WARNING": string, "INFORMATION": string}

Constants that represents the minimum Severity level in the NotificationFilter
public

notificationSeverityLevel: {"WARNING": string, "INFORMATION": string, "UNKNOWN": string}

Constants that represents the Severity level in the Notification
public

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

The constants for query types
public

rawPolyfilledDiagnosticRecord: {"OPERATION": *, "OPERATION_CODE": string, "CURRENT_SCHEMA": string}

public
public

routing: {"WRITE": *, "READ": *}

Constants that represents routing modes.
public

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

public

spatial: {"isPoint": *}

public

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

public

toNumber(value: Mixed): number: *

Converts a variable to a number
public

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

Converts the integer to a string representation
public

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

Static Public

public PROTOCOL_ERROR: string source 

import {PROTOCOL_ERROR} from 'neo4j-driver-core/lib/error.js'

Error code representing serialization/deserialization issue in the Bolt protocol. Used by Neo4jError#code.

public READ: string source 

import {READ} from 'neo4j-driver-core/lib/driver.js'

Constant that represents read session access mode. Should be used like this: driver.session({ defaultAccessMode: neo4j.session.READ }).

public SERVICE_UNAVAILABLE: string source 

import {SERVICE_UNAVAILABLE} from 'neo4j-driver-core/lib/error.js'

Error code representing complete loss of service. Used by Neo4jError#code.

public SESSION_EXPIRED: string source 

import {SESSION_EXPIRED} from 'neo4j-driver-core/lib/error.js'

Error code representing transient loss of service. Used by Neo4jError#code.

public WRITE: string source 

import {WRITE} from 'neo4j-driver-core/lib/driver.js'

Constant that represents write session access mode. Should be used like this: driver.session({ defaultAccessMode: neo4j.session.WRITE }).

public auth: {"basic": *, "kerberos": *, "bearer": *, "none": *, "custom": *} source 

import auth from 'neo4j-driver-core/lib/auth.js'

Properties:

NameTypeAttributeDescription
basic function(username: string, password: string, realm: ?string)

the function to create a basic authentication token.
kerberos function(base64EncodedTicket: string)

the function to create a Kerberos authentication token. Accepts a single string argument - base64 encoded Kerberos ticket.
bearer function(base64EncodedTicket: string)

the function to create a Bearer authentication token. Accepts a single string argument - base64 encoded Bearer ticket.
custom function(principal: string, credentials: string, realm: string, scheme: string, parameters: ?object)

the function to create a custom authentication token.

public authTokenManagers: AuthTokenManagers source 

import {authTokenManagers} from 'neo4j-driver-core/lib/auth-token-manager.js'

Holds the common AuthTokenManagers used in the Driver.

public clientCertificateProviders: ClientCertificateProviders since 5.19 source 

import {clientCertificateProviders} from 'neo4j-driver-core/lib/client-certificate.js'
this variable is experimental. Exposed as preview feature.

Holds the common ClientCertificateProviders used in the Driver.

public error: {"SERVICE_UNAVAILABLE": *, "SESSION_EXPIRED": *, "PROTOCOL_ERROR": *} source 

import {error} from 'neo4j-driver-core'

Object containing string constants representing predefined Neo4jError codes.

public forExport: {"authTokenManagers": *, "driver": *, "hasReachableServer": *, "int": *, "isInt": *, "isPoint": *, "isDuration": *, "isLocalTime": *, "isTime": *, "isDate": *, "isLocalDateTime": *, "isDateTime": *, "isNode": *, "isPath": *, "isPathSegment": *, "isRelationship": *, "isUnboundRelationship": *, "integer": *, "Neo4jError": *, "isRetryableError": *, "auth": *, "logging": *, "types": *, "session": *, "routing": *, "error": *, "graph": *, "spatial": *, "temporal": *, "Driver": *, "Session": *, "Transaction": *, "ManagedTransaction": *, "Result": *, "EagerResult": *, "RxSession": *, "RxTransaction": *, "RxManagedTransaction": *, "RxResult": *, "ResultSummary": *, "Plan": *, "ProfiledPlan": *, "QueryStatistics": *, "Notification": *, "GqlStatusObject": *, "ServerInfo": *, "Record": *, "Node": *, "Relationship": *, "UnboundRelationship": *, "Path": *, "PathSegment": *, "Point": *, "Integer": *, "Duration": *, "LocalTime": *, "Time": *, "Date": *, "LocalDateTime": *, "DateTime": *, "bookmarkManager": *, "resultTransformers": *, "notificationCategory": *, "notificationSeverityLevel": *, "notificationFilterDisabledCategory": *, "notificationFilterMinimumSeverityLevel": *, "clientCertificateProviders": *} source 

import forExport from 'neo4j-driver'

public graph: {"isNode": *, "isPath": *, "isPathSegment": *, "isRelationship": *, "isUnboundRelationship": *} source 

import {graph} from 'neo4j-driver'

public inSafeRange(value: Mixed): Boolean: * source 

import {inSafeRange} from 'neo4j-driver-core/lib/integer.js'

Check if a variable can be safely converted to a number

Return:

Boolean

true if it is safe to call toNumber on variable otherwise false

public int(value: Mixed, opts: Object): Integer: * source 

import {int} from 'neo4j-driver-core/lib/integer.js'

Cast value to Integer type.

Return:

Integer

An object of type Integer.

public integer: {"toNumber": *, "toString": *, "inSafeRange": *} source 

import {integer} from 'neo4j-driver'

public isInt(value: Mixed): Boolean: * source 

import {isInt} from 'neo4j-driver-core/lib/integer.js'

Check if a variable is of Integer type.

Return:

Boolean

Is it of the Integer type?

public isRetriableError(error: object | undefined | null): boolean: * source 

import {isRetriableError} from 'neo4j-driver-core/lib/error.js'

Verifies if the given error is retriable.

Return:

boolean

true if the error is retriable

public logging: {"console": *} source 

import {logging} from 'neo4j-driver'

Object containing predefined logging configurations. These are expected to be used as values of the driver config's logging property.

Properties:

NameTypeAttributeDescription
console function(level: ?string): object

the function to create a logging config that prints all messages to console.log with timestamp, level and message. It takes an optional level parameter which represents the maximum log level to be logged. Default value is 'info'.

public notificationCategory: {"HINT": string, "UNRECOGNIZED": string, "UNSUPPORTED": string, "PERFORMANCE": string, "DEPRECATION": string, "TOPOLOGY": string, "SECURITY": string, "GENERIC": string, "SCHEMA": string, "UNKNOWN": string} source 

import {notificationCategory} from 'neo4j-driver-core/lib/notification.js'

Constants that represents the Category in the Notification

public notificationClassification: notificationCategory source 

import {notificationClassification} from 'neo4j-driver-core/lib/notification.js'
this variable is experimental.

Constants that represents the Classification in the GqlStatusObject

public notificationFilterDisabledCategory: {"HINT": string, "UNRECOGNIZED": string, "UNSUPPORTED": string, "PERFORMANCE": string, "TOPOLOGY": string, "SECURITY": string, "DEPRECATION": string, "GENERIC": string, "SCHEMA": string} source 

import {notificationFilterDisabledCategory} from 'neo4j-driver-core/lib/notification-filter.js'

Constants that represents the disabled categories in the NotificationFilter

public notificationFilterDisabledClassification: notificationFilterDisabledCategory source 

import {notificationFilterDisabledClassification} from 'neo4j-driver-core/lib/notification-filter.js'
this variable is experimental.

Constants that represents the disabled classifications in the NotificationFilter

public notificationFilterMinimumSeverityLevel: {"OFF": string, "WARNING": string, "INFORMATION": string} source 

import {notificationFilterMinimumSeverityLevel} from 'neo4j-driver-core/lib/notification-filter.js'

Constants that represents the minimum Severity level in the NotificationFilter

public notificationSeverityLevel: {"WARNING": string, "INFORMATION": string, "UNKNOWN": string} source 

import {notificationSeverityLevel} from 'neo4j-driver-core/lib/notification.js'

Constants that represents the Severity level in the Notification

public queryType: {SCHEMA_WRITE: string, WRITE_ONLY: string, READ_ONLY: string, READ_WRITE: string} source 

import {queryType} from 'neo4j-driver-core/lib/result-summary.js'

The constants for query types

public rawPolyfilledDiagnosticRecord: {"OPERATION": *, "OPERATION_CODE": string, "CURRENT_SCHEMA": string} source 

import {rawPolyfilledDiagnosticRecord} from 'neo4j-driver-core/lib/gql-constants.js'

public resultTransformers: ResultTransformers source 

import resultTransformers from 'neo4j-driver-core/lib/result-transformers.js'

public routing: {"WRITE": *, "READ": *} source 

import {routing} from 'neo4j-driver-core/lib/driver.js'

Constants that represents routing modes.

Example:

driver.executeQuery("<QUERY>", <PARAMETERS>, { routing: neo4j.routing.WRITE })

public session: {"READ": *, "WRITE": *} source 

import {session} from 'neo4j-driver'

public spatial: {"isPoint": *} source 

import {spatial} from 'neo4j-driver'

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

import {temporal} from 'neo4j-driver'

public toNumber(value: Mixed): number: * source 

import {toNumber} from 'neo4j-driver-core/lib/integer.js'

Converts a variable to a number

Return:

number

the variable as a number

public toString(value: Mixed, radix: number): string: * source 

import {toString} from 'neo4j-driver-core/lib/integer.js'

Converts the integer to a string representation

Return:

string

returns a string representation of the integer

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

import {types} from 'neo4j-driver'