Class default

Asynchronous API that queries data from a database.

Implements

default

Index

Constructors

Methods

close prepareMetadata prepareTicket query queryPoints

Constructors

constructor

new default(_options: ConnectionOptions): default
Parameters
- _options: ConnectionOptions
Returns default
- Defined in packages/client/src/impl/QueryApiImpl.ts:29

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of default.close
- Defined in packages/client/src/impl/QueryApiImpl.ts:196

prepareMetadata

prepareMetadata(headers?: Record<string, string>): RpcMetadata
Parameters
- Optionalheaders: Record<string, string>
Returns RpcMetadata
- Defined in packages/client/src/impl/QueryApiImpl.ts:72

prepareTicket

prepareTicket(database: string, query: string, options: QueryOptions): Ticket
Parameters
- database: string
- query: string
- options: QueryOptions
Returns Ticket
- Defined in packages/client/src/impl/QueryApiImpl.ts:46

query

query(
    query: string,
    database: string,
    options: QueryOptions,
): AsyncGenerator<Record<string, any>, void, void>
Execute a query and return the results as an async generator.
Parameters
- query: string
  The query string.
- database: string
  The name of the database to query.
- options: QueryOptions
  options applied to the query (default: { type: 'sql'}).
Returns AsyncGenerator<Record<string, any>, void, void>
An async generator that yields maps of string keys to any values.
Implementation of default.query
- Defined in packages/client/src/impl/QueryApiImpl.ts:121

queryPoints

queryPoints(
    query: string,
    database: string,
    options: QueryOptions,
): AsyncGenerator<PointValues, void, void>
Execute a query and return the results as an async generator.
Parameters
- query: string
  The query string.
- database: string
  The name of the database to query.
- options: QueryOptions
  Options for the query (default: {type: 'sql'}).
Returns AsyncGenerator<PointValues, void, void>
An async generator that yields PointValues object.
Implementation of default.queryPoints
- Defined in packages/client/src/impl/QueryApiImpl.ts:140