Class MongooseDatasource

Hierarchy (View Summary)

BaseDataSource<MongooseCollection>
- MongooseDatasource

Index

Constructors

Properties

_collections _nativeQueryConnections

Accessors

collections nativeQueryConnections schema

Methods

addCollection addNativeQueryConnection executeNativeQuery getCollection renderChart

Constructors

constructor

new MongooseDatasource(
    connection: __module | Connection,
    options?: MongooseOptions,
    logger?: Logger,
): MongooseDatasource
Parameters
- connection: __module | Connection
- options: MongooseOptions = {}
- logger: Logger = null
Returns MongooseDatasource
Overrides BaseDataSource.constructor
- Defined in datasource-mongoose/src/datasource.ts:14

Properties

`Protected`_collections

_collections: { [collectionName: string]: MongooseCollection }

`Protected`_nativeQueryConnections

_nativeQueryConnections: { [connectionName: string]: unknown }

Accessors

collections

get collections(): T[]
Returns T[]
Inherited from BaseDataSource.collections
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:12

nativeQueryConnections

get nativeQueryConnections(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from BaseDataSource.nativeQueryConnections
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:13

schema

get schema(): DataSourceSchema
Returns DataSourceSchema
Inherited from BaseDataSource.schema
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:14

Methods

addCollection

addCollection(collection: MongooseCollection): void
Parameters
- collection: MongooseCollection
Returns void
Inherited from BaseDataSource.addCollection
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:16

addNativeQueryConnection

addNativeQueryConnection(connectionName: string, definition: unknown): void
Parameters
- connectionName: string
- definition: unknown
Returns void
Inherited from BaseDataSource.addNativeQueryConnection
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:17

executeNativeQuery

executeNativeQuery(
    connectionName: string,
    query: string,
    contextVariables: Record<string, unknown>,
): Promise<unknown>
Parameters
- connectionName: string
- query: string
- contextVariables: Record<string, unknown>
Returns Promise<unknown>
Inherited from BaseDataSource.executeNativeQuery
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:19

getCollection

getCollection(name: string): MongooseCollection
Parameters
- name: string
Returns MongooseCollection
Inherited from BaseDataSource.getCollection
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:15

renderChart

renderChart(caller: Caller, name: string): Promise<unknown>
Parameters
- caller: Caller
- name: string
Returns Promise<unknown>
Inherited from BaseDataSource.renderChart
- Defined in datasource-toolkit/dist/src/base-datasource.d.ts:18