Class BaseDataSourceAbstract

constructor

• new BaseDataSource(): BaseDataSource

  Returns BaseDataSource

Abstract Readonlyentities

Readonlymigrations

Abstract Readonlyoptions

ReadonlyrootPw

ReadonlyrootUsername

createBackupData

• createBackupData(): Readable

  Creates the data that should be backed up in form of a Readable stream.

  Returns Readable

createQueryRunner

• createQueryRunner(): QueryRunner

  Creates a typeorm query runner.

  Returns QueryRunner

  A typeorm query runner.

  Throws

  When the data source has not been initialized yet.

getRepository

• getRepository<T extends BaseEntity>(cls: Newable<T>): Repository<T>

  Gets a repository to access the table of the provided entity class.

  Type Parameters

  • T extends BaseEntity

  Parameters

  • cls: Newable<T>

    The entity class to get the repository for.

  Returns Repository<T>

  A repository for the provided entity class.

  Throws

  When the data source has not been initialized yet or the provided entity does not belong to this data source.

init

• init(): Promise<void>

  Initializes the data source.

  Returns Promise<void>

normalizeColumnType

• normalizeColumnType(
      column: {
          isArray: undefined | boolean;
          length: undefined | string | number;
          precision: undefined | null | number;
          scale: undefined | number;
          type: undefined | string & {} | ColumnType;
      },
  ): string

  Normalizes the provided column.

  Parameters

  • column: {
        isArray: undefined | boolean;
        length: undefined | string | number;
        precision: undefined | null | number;
        scale: undefined | number;
        type: undefined | string & {} | ColumnType;
    }

  Returns string

  Throws

  When the data source has not been initialized yet.

propertyToTableColumnOptions

• propertyToTableColumnOptions<T extends BaseEntity>(
      entity: Newable<T>,
      property: keyof T,
  ): TableColumnOptions

  Transforms the property on the given entity class to typeorm column options.

  Type Parameters

  • T extends BaseEntity

  Parameters

  • entity: Newable<T>

    The entity class which property should be transformed.
  • property: keyof T

    The key of the actual property that should be transformed.

  Returns TableColumnOptions

  Typeorm column options.

  Throws

  When no data source has been provided or no column metadata could be found.

restoreBackup

• restoreBackup(backupData: Readable): Promise<void>

  Restores this resource to the the given backup data.

  Parameters

  • backupData: Readable

  Returns Promise<void>

runMigrations

• runMigrations(): Promise<void>

  Runs migrations for the data source.

  Returns Promise<void>

startTransaction

• startTransaction(isolationLevel?: IsolationLevel): Promise<Transaction>

  Starts a new transaction.

  Parameters

  • OptionalisolationLevel: IsolationLevel

    The isolation level of the transaction.

  Returns Promise<Transaction>

  A new transaction that can be passed to any repository methods.