Skip to main content
Module

x/neo4j_driver_lite/mod.ts

Neo4j Bolt driver for JavaScript
Go to Latest
import * as neo4jDriverLite from "https://deno.land/x/neo4j_driver_lite@5.14.0-alpha01/mod.ts";

Classes

Interface which defines an AuthToken with an expiration data time associated

Interface for the piece of software responsible for keeping track of current active AuthToken across the driver.

Defines the object which holds the common AuthTokenManager used in the Driver

Interface for the piece of software responsible for keeping track of current active bookmarks accross the driver.

Interface which defines a connection for the core driver object.

Interface define a common way to acquire a connection

Represents an instant capturing the date, but not the time, nor the timezone. Created Date objects are frozen with Object.freeze() in constructor and thus immutable.

Represents an instant capturing the date, the time and the timezone identifier. Created {@ DateTime} objects are frozen with Object.freeze() in constructor and thus immutable.

A driver maintains one or more Sessions with a remote Neo4j instance. Through the Sessions you can send queries and retrieve results from the database.

Represents an ISO 8601 duration. Contains both date-based values (years, months, days) and time-based values (seconds, nanoseconds). Created Duration objects are frozen with Object.freeze() in constructor and thus immutable.

Represents the fully streamed result

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.

Represents an instant capturing the date and the time, but not the timezone. Created LocalDateTime objects are frozen with Object.freeze() in constructor and thus immutable.

Represents an instant capturing the time of day, but not the date, nor the timezone. Created LocalTime objects are frozen with Object.freeze() in constructor and thus immutable.

Represents a transaction that is managed by the transaction executor.

Class for all errors thrown/returned by the driver.

Class for Node Type.

Class for Cypher notifications

The notification filter object which can be configured in the session and driver creation.

Class for Path Type.

Class for PathSegment Type.

Class for execution plan received by prepending Cypher with EXPLAIN.

Represents a single two or three-dimensional point in a particular coordinate reference system. Created Point objects are frozen with Object.freeze() in constructor and thus immutable.

Class for execution plan received by prepending Cypher with PROFILE.

The query configuration

Get statistical information for a Result.

Records make up the contents of the Result, and is how you access the output of a query. A simple query might yield a result stream with a single record, for instance:

Class for Relationship Type.

A stream of Record representing the result of a query. Can be consumed eagerly as Promise resolved with array of records and ResultSummary summary, or rejected with error that contains string code and string message. Alternatively can be consumed lazily using Result#subscribe function.

A ResultSummary instance contains structured metadata for a Result.

Class for exposing server info from a result.

A Session instance is used for handling the connection and sending queries through the connection. In a single session, multiple queries will be executed serially. In order to execute parallel queries, multiple sessions are required.

The session configuration

Represents an instant capturing the time of day, and the timezone offset in seconds, but not the date. Created Time objects are frozen with Object.freeze() in constructor and thus immutable.

Represents a transaction in the Neo4j database.

Represents a Promise object and a Transaction object.

Class for UnboundRelationship Type.

Variables

Holds the common AuthTokenManagers used in the Driver

Object containing string constants representing predefined Neo4jError codes.

Object containing functions to work with graph types, like Node or Relationship.

Cast value to Integer type.

Object containing functions to work with Integer objects.

Check if a variable is of Integer type.

Verifies if the given error is retriable.

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

Constants that represents the Category in the Notification

Constants that represents the disabled categories in the NotificationFilter

Constants that represents the minimum Severity level in the NotificationFilter

Constants that represents the Severity level in the Notification

Holds the common ResultTransformer used with Driver#executeQuery.

Constants that represents routing modes.

Object containing string constants representing session access modes.

Object containing functions to work with spatial types, like Point.

Object containing functions to work with temporal types, like Time or Duration.

Object containing constructors for all neo4j types.

Functions

Provides an configured BookmarkManager instance.

Construct a new Neo4j Driver. This is your main entry point for this library.

Verifies if the driver can reach a server at the given url.

Test if given object is an instance of Date class.

Test if given object is an instance of DateTime class.

Test if given object is an instance of Duration class.

Test if given object is an instance of LocalDateTime class.

Test if given object is an instance of LocalTime class.

Test if given object is an instance of Node class.

Test if given object is an instance of Path class.

Test if given object is an instance of PathSegment class.

Test if given object is an instance of Point class.

Test if given object is an instance of Relationship class.

Test if given object is an instance of Time class.

Test if given object is an instance of UnboundRelationship class.

Interfaces

The query result is the combination of the ResultSummary and the array Record[] produced by the query

Interface to observe updates on the Result which is being produced.