Class Driver

A driver that can hold multiple Sessions with a remote MillenniumDB instance. The Sessions have the interface for sending queries and receiving results. It is expected that an application holds a single driver instance.

Index

Constructors

Properties

_open _sessions _url

Methods

_ensureOpen cancel catalog close session

Constructors

constructor

new Driver(url): Driver
This constructor should never be called directly
Parameters
- url: string
  the URL for the MillenniumDB server
Returns Driver
- Defined in src/driver.ts:21

Properties

`Private` _open

_open: boolean

`Private` `Readonly` _sessions

_sessions: Session[]

`Private` `Readonly` _url

_url: URL

Methods

`Private` _ensureOpen

_ensureOpen(): void
Returns void
- Defined in src/driver.ts:87

cancel

cancel(result): Promise<void>
Cancel the execution of a currently running query. Internally this will create a temporary Session that will be closed after the query has been cancelled.
Parameters
- result: Result
  the Result to cancel
Returns Promise<void>
- Defined in src/driver.ts:49

catalog

catalog(): Promise<Catalog>
Get the Catalog of the remote MillenniumDB instance

Returns Promise<Catalog>
Promise that will be resolved with the Catalog
- Defined in src/driver.ts:32

close

close(): Promise<void>
Close all open Sessions

Returns Promise<void>
Promise that will be resolved when all Sessions are closed
- Defined in src/driver.ts:79

session

session(): Session
Create a Session, establishing a new connection with the remote MillenniumDB instance. The Session must be closed when your operations are done.

Returns Session
a new Session instance
- Defined in src/driver.ts:67