References
summary | ||
public |
Defines the object which holds the common AuthTokenManager used in the Driver |
|
public |
this class is experimental. Exposed as preview feature.
Defines the object which holds the common ClientCertificateProviders used in the Driver |
since 5.19 |
public |
C Driver A driver maintains one or more Sessions with a remote Neo4j instance. |
|
public |
C GQLError this class is experimental. this class is part of the preview of GQL-compliant errors
Class for nested errors, to be used as causes in Neo4jError |
|
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 |
|
public |
this class is experimental.
Representation for GqlStatusObject found when executing a query. |
|
public |
Class for Cypher notifications |
|
public |
C Record Records make up the contents of the Result, and is how you access the output of a query. |
|
public |
Represents the fully streamed result |
|
public |
C Plan Class for execution plan received by prepending Cypher with EXPLAIN. |
|
public |
Class for execution plan received by prepending Cypher with PROFILE. |
|
public |
Get statistical information for a Result. |
|
public |
A ResultSummary instance contains structured metadata for a Result. |
|
public |
Class for exposing server info from a result. |
|
public |
C Stats Stats Query statistics dictionary for a QueryStatistics |
|
public |
Defines the object which holds the common ResultTransformer used with Driver#executeQuery. |
|
public |
C Result A stream of Record representing the result of a query. |
|
public |
C Session 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 |
C DateTime Represents an instant capturing the date, the time and the timezone identifier. |
|
public |
C Duration 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 |
Represents a transaction that is managed by the transaction executor. |
|
public |
Represents a {@link Promise<Transaction>} object and a Transaction object. |
|
public |
Represents a transaction in the Neo4j database. |
|
public |
|
|
public |
C Driver A driver maintains one or more Sessions with a remote Neo4j instance. |
|
public |
C RxResult |
|
public |
A Reactive session, which provides the same functionality as Session but through a Reactive API. |
|
public |
Represents a rx transaction that is managed by the transaction executor. |
|
public |
A reactive transaction, which provides the same functionality as Transaction but through a Reactive API. |
|
public |
Interface which defines an AuthToken with an expiration data time associated |
since 5.14 |
public |
Interface for the piece of software responsible for keeping track of current active AuthToken across the driver. |
since 5.14 |
public |
Interface for the piece of software responsible for keeping track of current active bookmarks accross the driver. |
since 5.0 |
public |
this class is experimental. Exposed as preview feature.
Holds the Client TLS certificate information. |
since 5.19 |
public |
this class is experimental. Exposed as preview feature.
Provides a client certificate to the driver for mutual TLS. |
since 5.19 |
public |
this class is experimental. Exposed as preview feature.
Interface for ClientCertificateProvider which provides update certificate function. |
since 5.19 |
public |
The query configuration |
|
public |
The session configuration |
|
public |
The notification filter object which can be configured in the session and driver creation. |
|
public |
I Config The Neo4j Driver configuration. |
|
public |
F bookmarkManager(config: BookmarkManagerConfig): BookmarkManager Provides an configured BookmarkManager instance. |
since 5.0 |
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 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 |
Construct a new Neo4j Driver. |
|
public |
F async hasReachableServer(url: string, config: object): true this function is experimental.
Verifies if the driver can reach a server at the given url. |
since 5.0.0 |
public |
Holds the common AuthTokenManagers used in the Driver. |
|
public |
V auth: {"basic": *, "kerberos": *, "bearer": *, "none": *, "custom": *} |
|
public |
this variable is experimental. Exposed as preview feature.
Holds the common ClientCertificateProviders used in the Driver. |
since 5.19 |
public |
V READ: string Constant that represents read session access mode. |
|
public |
V WRITE: string Constant that represents write session access mode. |
|
public |
V routing: {"WRITE": *, "READ": *} Constants that represents routing modes. |
|
public |
V PROTOCOL_ERROR: string Error code representing serialization/deserialization issue in the Bolt protocol. |
|
public |
V SERVICE_UNAVAILABLE: string Error code representing complete loss of service. |
|
public |
V SESSION_EXPIRED: string Error code representing transient loss of service. |
|
public |
V isRetriableError(error: object | undefined | null): boolean: * Verifies if the given error is retriable. |
|
public |
V rawPolyfilledDiagnosticRecord: {"OPERATION": *, "OPERATION_CODE": string, "CURRENT_SCHEMA": string} |
|
public |
V error: {"SERVICE_UNAVAILABLE": *, "SESSION_EXPIRED": *, "PROTOCOL_ERROR": *} Object containing string constants representing predefined Neo4jError codes. |
|
public |
V inSafeRange(value: Mixed): Boolean: * Check if a variable can be safely converted to a number |
|
public |
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 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 |
V notificationFilterMinimumSeverityLevel: {"OFF": string, "WARNING": string, "INFORMATION": string} Constants that represents the minimum Severity level in the NotificationFilter |
|
public |
V 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 |
V notificationSeverityLevel: {"WARNING": string, "INFORMATION": string, "UNKNOWN": string} Constants that represents the Severity level in the Notification |
|
public |
V queryType: {SCHEMA_WRITE: string, WRITE_ONLY: string, READ_ONLY: string, READ_WRITE: string} The constants for query types |
|
public |
|
|
public |
V 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 |
V graph: {"isNode": *, "isPath": *, "isPathSegment": *, "isRelationship": *, "isUnboundRelationship": *} |
|
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": *, "EagerResult": *, "ResultSummary": *, "Record": *, "Point": *, "Date": *, "DateTime": *, "Duration": *, "LocalDateTime": *, "LocalTime": *, "Time": *, "Integer": *} |
|
public |
T BookmarkManagerConfig: Object |
since 5.0 |
public |
T KeyFileObject: object Represents KeyFile represented as file. |
|
public |
T RoutingControl: 'WRITE' | 'READ' |
|
public |
T ErrorClassification: 'DATABASE_ERROR' | 'CLIENT_ERROR' | 'TRANSIENT_ERROR' | 'UNKNOWN' this typedef is experimental. this is part of the preview of GQL-compliant errors
|
|
public |
T NotificationFilterDisabledCategory: 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' |
|
public |
this typedef is experimental.
|
|
public |
T NotificationFilterMinimumSeverityLevel: 'WARNING' | 'INFORMATION' | 'OFF' |
|
public |
T NotificationCategory: 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'SCHEMA' | 'UNKNOWN' |
|
public |
this typedef is experimental.
|
|
public |
T NotificationSeverityLevel: 'WARNING' | 'INFORMATION' | 'UNKNOWN' |
|
public |
T ResultTransformer: function<T>(result:Result):Promise<T> Protocol for transforming Result. |
|
public |
T TransactionConfig: Object Configuration object containing settings for explicit and auto-commit transactions. |