Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/neo4j_lite_client/core/index.ts

Unofficial Neo4j Driver for Deno
Latest
import * as neo4jLiteClient from "https://deno.land/x/neo4j_lite_client@4.4.6/core/index.ts";

Classes

Interface which defines the raw connection with the database

Inteface 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.

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.

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.

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.

Utility to lazily initialize connections and return them back to the pool when unused.

Provides a interaction with a ConnectionHolder without change it state by releasing or initilizing

Verifies connectivity using the given connection provider.

Logger used by the driver to notify about various internal events. Single logger should be used per driver.

Internal holder of the transaction configuration. It performs input validation and value conversion for further serialization by the Bolt protocol layer. Users of the driver provide transaction configuration as regular objects {timeout: 10, metadata: {key: 'value'}}. Driver converts such objects to TxConfig immediately and uses converted values everywhere.

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.

Class for all errors thrown/returned by the driver.

Class for Node Type.

Class for Cypher notifications

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.

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.

Stats Query statistics dictionary for a QueryStatistics

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.

Class for UnboundRelationship Type.

Variables

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

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

Object containing string constants representing predefined Neo4jError codes.

Check if a variable can be safely converted to a number

Cast value to Integer type.

Connection holder that does not manage any connections.

Copyright (c) "Neo4j" Neo4j Sweden AB [http://neo4j.com]

Check if a variable is of Integer type.

The constants for query types

Converts a variable to a number

Converts the integer to a string representation

Functions

Verified error and returns if it could be retried or not

Assert that the day value is valid.

Assert that the hour value is valid.

Assert that the minute value is valid.

Assert that the month value is valid.

Assert that the nanosecond value is valid.

Assert that the second value is valid.

Assert that the year value is valid.

Converts given local date into a single integer representing it's epoch day.

Formats given date to an ISO 8601 string.

Format given duration to an ISO 8601 string.

Converts given local date time into a single integer representing this same time in epoch seconds UTC.

Converts given local time into a single integer representing this same time in nanoseconds of the day.

Formats given time to an ISO 8601 string.

Get the time zone offset in seconds from the given standard JavaScript date.

Formats given time zone offset in seconds to string representation like '±HH:MM', '±HH:MM:SS' or 'Z' for UTC.

Get the total number of nanoseconds from the milliseconds of the given standard JavaScript date and optional nanosecond part.

Assert it's a number

Assert it's a number or integer

Assert it's a object

Assert it's a string

Assert it's a valid datae

Verifies if the object is null or empty

Verify if it's an object

Verify if the supplied object is a string

Check and normalize given query and parameters.

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.

Custom version on JSON.stringify that can handle values that normally don't support serialization, such as BigInt.

Create a new error from a message and error code

Interfaces

Raw observer for the stream

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.