MsSqlDriver

Hierarchy

• AbstractSqlDriver<MsSqlConnection>
  • MsSqlDriver

Index

Constructors

• constructor

Properties

• [EntityManagerType]
• config

Methods

• aggregate
• close
• connect
• convertException
• count
• countVirtual
• createEntityManager
• execute
• find
• findOne
• findVirtual
• getConnection
• getDependencies
• getMetadata
• getORMClass
• getPlatform
• loadFromPivotTable
• lockPessimistic
• mapResult
• nativeDelete
• nativeInsert
• nativeInsertMany
• nativeUpdate
• nativeUpdateMany
• reconnect
• setMetadata
• stream
• syncCollections

Constructors

constructor

• new MsSqlDriver(config): MsSqlDriver

• Overrides AbstractSqlDriver<MsSqlConnection>.constructor

  Parameters

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns MsSqlDriver

Properties

inherited[EntityManagerType]

[EntityManagerType]: SqlEntityManager<MsSqlDriver>

Inherited from AbstractSqlDriver.[EntityManagerType]

readonlyinheritedconfig

config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

Inherited from AbstractSqlDriver.config

Methods

inheritedaggregate

• aggregate(entityName, pipeline): Promise<any[]>

• Inherited from AbstractSqlDriver.aggregate

  Parameters

  • entityName: EntityName

  • pipeline: any[]

  Returns Promise<any[]>

inheritedclose

• close(force): Promise<void>

• Inherited from AbstractSqlDriver.close

  Parameters

  • optionalforce: boolean

  Returns Promise<void>

inheritedconnect

• connect(options): Promise<MsSqlConnection>

• Inherited from AbstractSqlDriver.connect

  Parameters

  • optionaloptions: { skipOnConnect?: boolean }

  • optionalskipOnConnect: boolean

  Returns Promise<MsSqlConnection>

inheritedconvertException

• convertException(exception): DriverException

• Inherited from AbstractSqlDriver.convertException

  Converts native db errors to standardized driver exceptions

  ---

  Parameters

  • exception: Error

  Returns DriverException

inheritedcount

• count<T>(entityName, where, options): Promise<number>

• Inherited from AbstractSqlDriver.count

  Parameters

  • entityName: EntityName<T>

  • where: any

  • options: CountOptions<T, never> = {}

  Returns Promise<number>

inheritedcountVirtual

• countVirtual<T>(entityName, where, options): Promise<number>

• Inherited from AbstractSqlDriver.countVirtual

  Parameters

  • entityName: EntityName<T>

  • where: ObjectQuery<T>

  • options: CountOptions<T, any>

  Returns Promise<number>

inheritedcreateEntityManager

• createEntityManager(useContext): SqlEntityManager<MsSqlDriver>

• Inherited from AbstractSqlDriver.createEntityManager

  Parameters

  • optionaluseContext: boolean

  Returns SqlEntityManager<MsSqlDriver>

inheritedexecute

• execute<T>(query, params, method, ctx, loggerContext): Promise<T>

• Inherited from AbstractSqlDriver.execute

  Parameters

  • query: string | RawQueryFragment | NativeQueryBuilder

  • params: any[] = []

  • method: get | all | run = 'all'

  • optionalctx: any

  • optionalloggerContext: LoggingOptions

  Returns Promise<T>

inheritedfind

• find<T, P, F, E>(entityName, where, options): Promise<EntityData<T>[]>

• Inherited from AbstractSqlDriver.find

  Finds selection of entities

  ---

  Parameters

  • entityName: EntityName<T>

  • where: ObjectQuery<T>

  • options: FindOptions<T, P, F, E> = {}

  Returns Promise<EntityData<T>[]>

inheritedfindOne

• findOne<T, P, F, E>(entityName, where, options): Promise<null | EntityData<T>>

• Inherited from AbstractSqlDriver.findOne

  Finds single entity (table row, document)

  ---

  Parameters

  • entityName: EntityName<T>

  • where: ObjectQuery<T>

  • optionaloptions: FindOneOptions<T, P, F, E>

  Returns Promise<null | EntityData<T>>

inheritedfindVirtual

• findVirtual<T>(entityName, where, options): Promise<EntityData<T>[]>

• Inherited from AbstractSqlDriver.findVirtual

  Parameters

  • entityName: EntityName<T>

  • where: ObjectQuery<T>

  • options: FindOptions<T, any, any, any>

  Returns Promise<EntityData<T>[]>

inheritedgetConnection

• getConnection(type): MsSqlConnection

• Inherited from AbstractSqlDriver.getConnection

  Parameters

  • type: ConnectionType = 'write'

  Returns MsSqlConnection

inheritedgetDependencies

• getDependencies(): string[]

• Inherited from AbstractSqlDriver.getDependencies

  Returns name of the underlying database dependencies (e.g. mongodb or mysql2) for SQL drivers it also returns knex in the array as connectors are not used directly there

  ---

  Returns string[]

inheritedgetMetadata

• getMetadata(): MetadataStorage

• Inherited from AbstractSqlDriver.getMetadata

  Returns MetadataStorage

getORMClass

• getORMClass(): Constructor<MsSqlMikroORM<SqlEntityManager<MsSqlDriver>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>>

• Overrides AbstractSqlDriver.getORMClass

  @inheritDoc

  ---

  Returns Constructor<MsSqlMikroORM<SqlEntityManager<MsSqlDriver>, (string | EntityClass<Partial<any>> | EntitySchema<any, never, EntityCtor<any>>)[]>>

inheritedgetPlatform

• getPlatform(): AbstractSqlPlatform

• Inherited from AbstractSqlDriver.getPlatform

  Returns AbstractSqlPlatform

inheritedloadFromPivotTable

• loadFromPivotTable<T, O>(prop, owners, where, orderBy, ctx, options, pivotJoin): Promise<Dictionary<T[]>>

• Inherited from AbstractSqlDriver.loadFromPivotTable

  When driver uses pivot tables for M:N, this method will load identifiers for given collections from them

  ---

  Parameters

  • prop: EntityProperty<any, any>

  • owners: (O extends { [PrimaryKeyProp]?: PK } ? PK extends undefined ? Omit<O<O>, typeof PrimaryKeyProp> : PK extends keyof O<O> ? ReadonlyPrimary<UnwrapPrimary<O<O>[PK<PK>]>> : PK extends keyof O<O>[] ? ReadonlyPrimary<PrimaryPropToType<O<O>, PK<PK>>> : PK : O extends { _id?: PK } ? string | ReadonlyPrimary<PK> : O extends { id?: PK } ? ReadonlyPrimary<PK> : O extends { uuid?: PK } ? ReadonlyPrimary<PK> : O)[][]

  • where: any = ...

  • optionalorderBy: OrderDefinition<T>

  • optionalctx: any

  • optionaloptions: FindOptions<T, any, any, any>

  • optionalpivotJoin: boolean

  Returns Promise<Dictionary<T[]>>

inheritedlockPessimistic

• lockPessimistic<T>(entity, options): Promise<void>

• Inherited from AbstractSqlDriver.lockPessimistic

  Parameters

  • entity: T

  • options: LockOptions

  Returns Promise<void>

inheritedmapResult

• mapResult<T>(result, meta, populate, qb, map): null | EntityData<T>

• Inherited from AbstractSqlDriver.mapResult

  Parameters

  • result: EntityData<T>

  • meta: EntityMetadata<T, EntityCtor<T>>

  • populate: PopulateOptions<T>[] = []

  • optionalqb: QueryBuilder<T, any, any, any>

  • map: Dictionary = {}

  Returns null | EntityData<T>

inheritednativeDelete

• nativeDelete<T>(entityName, where, options): Promise<QueryResult<T>>

• Inherited from AbstractSqlDriver.nativeDelete

  Parameters

  • entityName: EntityName<T>

  • where: any

  • options: DeleteOptions<T> = {}

  Returns Promise<QueryResult<T>>

inheritednativeInsert

• nativeInsert<T>(entityName, data, options): Promise<QueryResult<T>>

• Inherited from AbstractSqlDriver.nativeInsert

  Parameters

  • entityName: EntityName<T>

  • data: EntityDictionary<T>

  • options: NativeInsertUpdateOptions<T> = {}

  Returns Promise<QueryResult<T>>

nativeInsertMany

• nativeInsertMany<T>(entityName, data, options): Promise<QueryResult<T>>

• Overrides AbstractSqlDriver.nativeInsertMany

  Parameters

  • entityName: EntityName<T>

  • data: EntityDictionary<T>[]

  • options: NativeInsertUpdateManyOptions<T> = {}

  Returns Promise<QueryResult<T>>

inheritednativeUpdate

• nativeUpdate<T>(entityName, where, data, options): Promise<QueryResult<T>>

• Inherited from AbstractSqlDriver.nativeUpdate

  Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • data: EntityDictionary<T>

  • options: NativeInsertUpdateOptions<T> & UpsertOptions<T, never> = {}

  Returns Promise<QueryResult<T>>

inheritednativeUpdateMany

• nativeUpdateMany<T>(entityName, where, data, options): Promise<QueryResult<T>>

• Inherited from AbstractSqlDriver.nativeUpdateMany

  Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>[]

  • data: EntityDictionary<T>[]

  • options: NativeInsertUpdateManyOptions<T> & UpsertManyOptions<T, never> = {}

  Returns Promise<QueryResult<T>>

inheritedreconnect

• reconnect(options): Promise<MsSqlConnection>

• Inherited from AbstractSqlDriver.reconnect

  Parameters

  • optionaloptions: { skipOnConnect?: boolean }

  • optionalskipOnConnect: boolean

  Returns Promise<MsSqlConnection>

inheritedsetMetadata

• setMetadata(metadata): void

• Inherited from AbstractSqlDriver.setMetadata

  Parameters

  • metadata: MetadataStorage

  Returns void

inheritedstream

• stream<T>(entityName, where, options): AsyncIterableIterator<T, any, any>

• Inherited from AbstractSqlDriver.stream

  Parameters

  • entityName: EntityName<T>

  • where: FilterQuery<T>

  • options: StreamOptions<T, any, any, any>

  Returns AsyncIterableIterator<T, any, any>

inheritedsyncCollections

• syncCollections<T, O>(collections, options): Promise<void>

• Inherited from AbstractSqlDriver.syncCollections

  Parameters

  • collections: Iterable<Collection<T, O>, any, any>

  • optionaloptions: DriverMethodOptions

  Returns Promise<void>