Class Session

A Session is used to send queries and receive results from the remote MillenniumDB instance

Index

Constructors

Properties

_chunkDecoder _connection _messageDecoder _open _requestBuffer _requestWriter _responseHandler _results

Methods

_cancel _ensureOpen _onChunksDecoded _onServerMessage catalog close run

Constructors

constructor

new Session(url): Session
This constructor should never be called directly
Parameters
- url: URL
  the URL for the MillenniumDB server
Returns Session
- Defined in src/session.ts:34

Properties

`Private` `Readonly` _chunkDecoder

_chunkDecoder: ChunkDecoder

`Private` `Readonly` _connection

_connection: WebSocketConnection

`Private` `Readonly` _messageDecoder

_messageDecoder: MessageDecoder

`Private` _open

_open: boolean

`Private` `Readonly` _requestBuffer

_requestBuffer: RequestBuffer

`Private` `Readonly` _requestWriter

_requestWriter: RequestWriter

`Private` `Readonly` _responseHandler

_responseHandler: ResponseHandler

`Private` `Readonly` _results

_results: Result[]

Methods

_cancel

_cancel(result): Promise<void>
Try to cancel another query given a Result. This method should be called exclusively by driver
Parameters
- result: Result
  the Result to cancel
Returns Promise<void>
a promise that resolves when the query is cancelled
- Defined in src/session.ts:113

`Private` _ensureOpen

_ensureOpen(): void
Returns void
- Defined in src/session.ts:141

`Private` _onChunksDecoded

_onChunksDecoded(iobuffer): void
Handler for chunks that were decoded
Parameters
- iobuffer: IOBuffer
  the data received
Returns void
- Defined in src/session.ts:161

`Private` _onServerMessage

_onServerMessage(iobuffer): void
Handler for incoming data from the server
Parameters
- iobuffer: IOBuffer
  the data received
Returns void
- Defined in src/session.ts:152

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/session.ts:54

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/session.ts:97

run

run(query, parameters?): Result
Sends a request for executing a query to the server
Parameters
- query: string
  the query to execute
- parameters: Record<string, any> = {}
  the query parameters
Returns Result
a Result for the query
- Defined in src/session.ts:82