Class TypeOrmBaseDataSource<TOptions>Abstract

constructor

• new TypeOrmBaseDataSource<TOptions extends DataSourceOptions>(
      logger: LoggerInterface,
      authService: AuthServiceInterface,
  ): TypeOrmBaseDataSource<TOptions>

  Type Parameters

  • TOptions extends DataSourceOptions

  Parameters

  • logger: LoggerInterface
  • authService: AuthServiceInterface

  Returns TypeOrmBaseDataSource<TOptions>

Abstract Readonlyentities

Readonlymigrations

Readonlyoptions

addPropertyToEntity

• addPropertyToEntity<T extends BaseEntity>(
      entity: Newable<T>,
      key: keyof T,
      transaction: Transaction,
  ): Promise<void>

  Adds a new property to the given entity.

  Mostly needed in the context of migrations.

  Type Parameters

  • T extends BaseEntity

  Parameters

  • entity: Newable<T>
  • key: keyof T
  • transaction: Transaction

  Returns Promise<void>

changePropertyOfEntity

• changePropertyOfEntity<T extends BaseEntity>(
      entity: Newable<T>,
      oldColumn: string & {} | keyof T,
      newColumn: PropertyMetadataInput & {
          name?: keyof T;
          type:
              | "string"
              | "number"
              | "boolean"
              | "object"
              | "array"
              | "date"
              | "unknown";
      },
      transaction: Transaction,
  ): Promise<void>

  Changes the given oldProperty to the newProperty on the given entity.

  Type Parameters

  • T extends BaseEntity

  Parameters

  • entity: Newable<T>
  • oldColumn: string & {} | keyof T
  • newColumn: PropertyMetadataInput & {
        name?: keyof T;
        type:
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "array"
            | "date"
            | "unknown";
    }

    • Optionalname?: keyof T

      The name of the new column.

    • type: "string" | "number" | "boolean" | "object" | "array" | "date" | "unknown"

      The type of the new column.

  • transaction: Transaction

  Returns Promise<void>

AbstractcreateBackupData

• createBackupData(): Readable

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

  Returns Readable

createQueryRunner

• createQueryRunner(): QueryRunner

  Creates a query runner.

  Returns QueryRunner

  A query runner.

  Throws

  When the data source has not been initialized yet.

getRepository

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

  Gets a repository to manage the provided entity class in the data source.

  Type Parameters

  • T extends BaseEntity

  Parameters

  • cls: Newable<T>

    The entity class to get the repository for.

  Returns RepositoryTypeForEntity<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>

AbstractrestoreBackup

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

  Restores this resource to the the given backup data.

  Parameters

  • backupData: Readable

  Returns void | Promise<void>

runMigrations

• runMigrations(): Promise<void>

  Runs migrations for the data source.

  Returns Promise<void>

shutDown

• shutDown(): Promise<void>

  Shuts down the data source. Should be called from the data source service AfterAppShutdown hook.

  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.

whereFilterToFindOptionsWhere

• whereFilterToFindOptionsWhere<T extends object>(
      filter: Where<T>,
      entityClass: Newable<T>,
  ): Where<T> extends WhereFilter<T>[]
      ? FindOptionsWhere<T>[]
      : FindOptionsWhere<T>

  Transforms the given Zibri where filter to typeorm's FindOptionsWhere.

  Type Parameters

  • T extends object

  Parameters

  • filter: Where<T>

    The filter to transform.

  • entityClass: Newable<T>

    The entity class that the where filter is for.

  Returns Where<T> extends WhereFilter<T>[] ? FindOptionsWhere<T>[] : FindOptionsWhere<T>

  TypeOrm's FindOptionsWhere.

  Throws

  When the data source hasn't been initialized yet.