Class DataSourceManager<T>`Abstract`

Type Parameters

T

Hierarchy

DataSourceManager

Index

Constructors

Properties

dataSource modelMapping options

Methods

checkConnected createDataSource createInstance destroyDataSource getDataSource getDataSourceNameByModel getDataSourceNames getDefaultDataSourceName getName hasDataSource initDataSource isConnected stop

Constructors

constructor

new DataSourceManager<T>(): DataSourceManager<T>
Type Parameters
- T
Returns DataSourceManager<T>

Properties

`Protected` dataSource

dataSource: Map<string, T> = ...

`Protected` modelMapping

modelMapping: WeakMap<object, any> = ...

`Protected` options

options: Partial<DataSourceConfig> = {}

Methods

`Protected` `Abstract` checkConnected

checkConnected(dataSource: T): Promise<boolean>
Parameters
- dataSource: T
Returns Promise<boolean>
- Defined in packages/core/src/common/dataSourceManager.ts:176

`Protected` `Abstract` createDataSource

createDataSource(config: any, dataSourceName: string): void | T | Promise<void | T>
Parameters
- config: any
- dataSourceName: string
Returns void | T | Promise<void | T>
- Defined in packages/core/src/common/dataSourceManager.ts:172

createInstance

createInstance(config: any, clientName: any, options?: CreateDataSourceInstanceOptions): Promise<void | T>
Parameters
- config: any
- clientName: any
- Optional options: CreateDataSourceInstanceOptions
Returns Promise<void | T>
- Defined in packages/core/src/common/dataSourceManager.ts:127

`Protected` `Abstract` destroyDataSource

destroyDataSource(dataSource: T): Promise<void>
Parameters
- dataSource: T
Returns Promise<void>
- Defined in packages/core/src/common/dataSourceManager.ts:177

getDataSource

getDataSource(dataSourceName: string): T
get a data source instance
Parameters
- dataSourceName: string
Returns T
- Defined in packages/core/src/common/dataSourceManager.ts:102

getDataSourceNameByModel

getDataSourceNameByModel(modelOrRepository: any): string
get data source name by model or repository
Parameters
- modelOrRepository: any
Returns string
- Defined in packages/core/src/common/dataSourceManager.ts:167

getDataSourceNames

getDataSourceNames(): string[]
Returns string[]
- Defined in packages/core/src/common/dataSourceManager.ts:114

getDefaultDataSourceName

getDefaultDataSourceName(): string
Returns string
- Defined in packages/core/src/common/dataSourceManager.ts:189

`Abstract` getName

getName(): string
Returns string
- Defined in packages/core/src/common/dataSourceManager.ts:171

hasDataSource

hasDataSource(dataSourceName: string): boolean
check data source has exists
Parameters
- dataSourceName: string
Returns boolean
- Defined in packages/core/src/common/dataSourceManager.ts:110

`Protected` initDataSource

initDataSource(dataSourceConfig: {
    cacheInstance?: boolean;
    dataSource: {
        entities?: unknown[];
        [key: string]: unknown;
    };
    validateConnection?: boolean;
}, appDirOrOptions: string | {
    appDir: string;
}): Promise<void>
Parameters
- dataSourceConfig: {
      cacheInstance?: boolean;
      dataSource: {
          entities?: unknown[];
          [key: string]: unknown;
      };
      validateConnection?: boolean;
  }
  - Optional cacheInstance?: boolean
  - dataSource: {
    entities?: unknown[];
    [key: string]: unknown;
    }
    - [key: string]: unknown
    - Optional entities?: unknown[]
  - Optional validateConnection?: boolean
- appDirOrOptions: string | {
  appDir: string;
  }
Returns Promise<void>
- Defined in packages/core/src/common/dataSourceManager.ts:37

isConnected

isConnected(dataSourceName: string): Promise<boolean>
check the data source is connected
Parameters
- dataSourceName: string
Returns Promise<boolean>
- Defined in packages/core/src/common/dataSourceManager.ts:122

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/common/dataSourceManager.ts:179

Generated using TypeDoc