Class: AbstractSqlDriver<C>

knex.AbstractSqlDriver

Type parameters

Name	Type	Default
C	AbstractSqlConnection	AbstractSqlConnection

Hierarchy

• DatabaseDriver<C>

  ↳ AbstractSqlDriver

Constructors

constructor

+ Protectednew AbstractSqlDriver<C>(config: Configuration<IDatabaseDriver<Connection>>, platform: AbstractSqlPlatform, connection: Constructor<C>, connector: string[]): AbstractSqlDriver<C>

Type parameters:

Name	Type	Default
C	AbstractSqlConnection<C>	AbstractSqlConnection

Parameters:

Name	Type
config	Configuration<IDatabaseDriver<Connection>>
platform	AbstractSqlPlatform
connection	Constructor<C>
connector	string[]

Returns: AbstractSqlDriver<C>

Inherited from: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:19

Properties

__@EntityManagerType@43871

• __@EntityManagerType@43871: EntityManager<AbstractSqlDriver<C>>

Overrides: DatabaseDriver.__@EntityManagerType@43871

Defined in: packages/knex/src/AbstractSqlDriver.ts:15

---

comparator

• Protected comparator: EntityComparator

Inherited from: DatabaseDriver.comparator

Defined in: packages/core/src/drivers/DatabaseDriver.ts:21

---

config

• Protected Readonly config: Configuration<IDatabaseDriver<Connection>>

Inherited from: DatabaseDriver.config

---

connection

• Protected Readonly connection: C

Overrides: DatabaseDriver.connection

Defined in: packages/knex/src/AbstractSqlDriver.ts:17

---

dependencies

• Protected Readonly dependencies: string[]

Inherited from: DatabaseDriver.dependencies

---

logger

• Protected Readonly logger: Logger

Inherited from: DatabaseDriver.logger

Defined in: packages/core/src/drivers/DatabaseDriver.ts:20

---

metadata

• Protected metadata: MetadataStorage

Inherited from: DatabaseDriver.metadata

Defined in: packages/core/src/drivers/DatabaseDriver.ts:22

---

platform

• Protected Readonly platform: AbstractSqlPlatform

Overrides: DatabaseDriver.platform

Defined in: packages/knex/src/AbstractSqlDriver.ts:19

---

replicas

• Protected Readonly replicas: C[]

Overrides: DatabaseDriver.replicas

Defined in: packages/knex/src/AbstractSqlDriver.ts:18

Methods

aggregate

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

Parameters:

Name	Type
entityName	string
pipeline	any[]

Returns: Promise<any[]>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:49

---

appendToCollection

▸ PrivateappendToCollection<T>(meta: EntityMetadata<T>, collection: EntityData<T>[], relationPojo: EntityData<T>): void

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
meta	EntityMetadata<T>
collection	EntityData<T>[]
relationPojo	EntityData<T>

Returns: void

Defined in: packages/knex/src/AbstractSqlDriver.ts:157

---

autoJoinOneToOneOwner

▸ ProtectedautoJoinOneToOneOwner<T>(meta: EntityMetadata<any>, populate: PopulateOptions<T>[], fields?: (string | FieldsMap)[]): PopulateOptions<T>[]

1:1 owner side needs to be marked for population so QB auto-joins the owner id

Type parameters:

Name
T

Parameters:

Name	Type	Default value
meta	EntityMetadata<any>	-
populate	PopulateOptions<T>[]	-
fields	(string | FieldsMap)[]	...

Returns: PopulateOptions<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:419

---

buildFields

▸ ProtectedbuildFields<T>(meta: EntityMetadata<T>, populate: PopulateOptions<T>[], joinedProps: PopulateOptions<T>[], qb: QueryBuilder<T>, fields?: Field<T>[]): Field<T>[]

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
meta	EntityMetadata<T>
populate	PopulateOptions<T>[]
joinedProps	PopulateOptions<T>[]
qb	QueryBuilder<T>
fields?	Field<T>[]

Returns: Field<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:586

---

close

▸ close(force?: boolean): Promise<void>

Parameters:

Name	Type
force?	boolean

Returns: Promise<void>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:93

---

connect

▸ connect(): Promise<C>

Returns: Promise<C>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:71

---

convertException

▸ convertException(exception: Error): DriverException

inheritdoc

Parameters:

Name	Type
exception	Error

Returns: DriverException

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:244

---

count

▸ count<T>(entityName: string, where: any, options?: CountOptions<T>, ctx?: Transaction<any, any>): Promise<number>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
where	any	-
options	CountOptions<T>	...
ctx?	Transaction<any, any>	-

Returns: Promise<number>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:171

---

createEntityManager

▸ createEntityManager<D>(useContext?: boolean): D[typeof EntityManagerType]

Type parameters:

Name	Type	Default
D	IDatabaseDriver<Connection, D>	IDatabaseDriver<Connection\>

Parameters:

Name	Type
useContext?	boolean

Returns: D[typeof EntityManagerType]

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:32

---

createQueryBuilder

▸ ProtectedcreateQueryBuilder<T>(entityName: string, ctx?: Transaction<any, any>, write?: boolean, convertCustomTypes?: boolean): QueryBuilder<T>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
entityName	string
ctx?	Transaction<any, any>
write?	boolean
convertCustomTypes?	boolean

Returns: QueryBuilder<T>

Defined in: packages/knex/src/AbstractSqlDriver.ts:500

---

createReplicas

▸ ProtectedcreateReplicas(cb: (c: ConnectionOptions) => C): C[]

Parameters:

Name	Type
cb	(c: ConnectionOptions) => C

Returns: C[]

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:205

---

ensureIndexes

▸ ensureIndexes(): Promise<void>

Returns: Promise<void>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:117

---

execute

▸ execute<T>(queryOrKnex: string | QueryBuilder<any, any> | Raw<any>, params?: any[], method?: all | get | run, ctx?: any): Promise<T>

Type parameters:

Name	Type	Default
T	QueryResult | EntityData<AnyEntity<any>> | EntityData<AnyEntity<any>>[]	EntityData<AnyEntity<any\>\>[]

Parameters:

Name	Type	Default value
queryOrKnex	string | QueryBuilder<any, any> | Raw<any>	-
params	any[]	...
method	all | get | run	'all'
ctx?	any	-

Returns: Promise<T>

Defined in: packages/knex/src/AbstractSqlDriver.ts:412

---

extractManyToMany

▸ ProtectedextractManyToMany<T>(entityName: string, data: EntityData<T>): EntityData<T>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
entityName	string
data	EntityData<T>

Returns: EntityData<T>

Defined in: packages/knex/src/AbstractSqlDriver.ts:510

---

find

▸ find<T>(entityName: string, where: FilterQuery<T>, options?: FindOptions<T, Populate<T>>, ctx?: Transaction<any, any>): Promise<EntityData<T>[]>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
where	FilterQuery<T>	-
options	FindOptions<T, Populate<T>>	...
ctx?	Transaction<any, any>	-

Returns: Promise<EntityData<T>[]>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:36

---

findOne

▸ findOne<T>(entityName: string, where: FilterQuery<T>, options?: FindOneOptions<T, Populate<T>>, ctx?: Transaction<any, any>): Promise<null | EntityData<T>>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
entityName	string
where	FilterQuery<T>
options?	FindOneOptions<T, Populate<T>>
ctx?	Transaction<any, any>

Returns: Promise<null | EntityData<T>>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:74

---

getConnection

▸ getConnection(type?: read | write): C

Parameters:

Name	Type	Default value
type	read | write	'write'

Returns: C

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:83

---

getDependencies

▸ getDependencies(): string[]

Returns: string[]

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:113

---

getFieldsForJoinedLoad

▸ ProtectedgetFieldsForJoinedLoad<T>(qb: QueryBuilder<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], parentTableAlias?: string, parentJoinPath?: string): Field<T>[]

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
qb	QueryBuilder<T>	-
meta	EntityMetadata<T>	-
populate	PopulateOptions<T>[]	...
parentTableAlias?	string	-
parentJoinPath?	string	-

Returns: Field<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:460

---

getPivotInverseProperty

▸ ProtectedgetPivotInverseProperty(prop: EntityProperty<any>): EntityProperty<any>

Parameters:

Name	Type
prop	EntityProperty<any>

Returns: EntityProperty<any>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:190

---

getPivotOrderBy

▸ ProtectedgetPivotOrderBy(prop: EntityProperty<any>, orderBy?: QueryOrderMap): QueryOrderMap

Parameters:

Name	Type
prop	EntityProperty<any>
orderBy?	QueryOrderMap

Returns: QueryOrderMap

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:169

---

getPlatform

▸ getPlatform(): AbstractSqlPlatform

Returns: AbstractSqlPlatform

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:28

---

getPrimaryKeyFields

▸ ProtectedgetPrimaryKeyFields(entityName: string): string[]

Parameters:

Name	Type
entityName	string

Returns: string[]

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:185

---

inlineEmbeddables

▸ ProtectedinlineEmbeddables<T>(meta: EntityMetadata<T>, data: T, where?: boolean): void

Type parameters:

Name
T

Parameters:

Name	Type
meta	EntityMetadata<T>
data	T
where?	boolean

Returns: void

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:121

---

joinedProps

▸ ProtectedjoinedProps<T>(meta: EntityMetadata<any>, populate: PopulateOptions<T>[]): PopulateOptions<T>[]

Type parameters:

Name
T

Parameters:

Name	Type
meta	EntityMetadata<any>
populate	PopulateOptions<T>[]

Returns: PopulateOptions<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:432

---

loadFromPivotTable

▸ loadFromPivotTable<T, O>(prop: EntityProperty<any>, owners: Primary<O>[][], where?: FilterQuery<T>, orderBy?: QueryOrderMap, ctx?: any, options?: FindOptions<T, Populate<T>>): Promise<Dictionary<T[]>>

Type parameters:

Name	Type
T	AnyEntity<T>
O	AnyEntity<O>

Parameters:

Name	Type	Default value
prop	EntityProperty<any>	-
owners	Primary<O>[][]	-
where	FilterQuery<T>	...
orderBy?	QueryOrderMap	-
ctx?	any	-
options?	FindOptions<T, Populate<T>>	-

Returns: Promise<Dictionary<T[]>>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:381

---

lockPessimistic

▸ lockPessimistic<T>(entity: T, mode: LockMode, ctx?: any): Promise<void>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
entity	T
mode	LockMode
ctx?	any

Returns: Promise<void>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:578

---

mapJoinedProps

▸ PrivatemapJoinedProps<T>(result: EntityData<T>, meta: EntityMetadata<T>, populate: PopulateOptions<T>[], qb: QueryBuilder<T>, root: EntityData<T>, map: Dictionary<any>, parentJoinPath?: string): void

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
result	EntityData<T>
meta	EntityMetadata<T>
populate	PopulateOptions<T>[]
qb	QueryBuilder<T>
root	EntityData<T>
map	Dictionary<any>
parentJoinPath?	string

Returns: void

Defined in: packages/knex/src/AbstractSqlDriver.ts:104

---

mapPropToFieldNames

▸ mapPropToFieldNames<T>(qb: QueryBuilder<T>, prop: EntityProperty<T>, tableAlias?: string): Field<T>[]

internal

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
qb	QueryBuilder<T>
prop	EntityProperty<T>
tableAlias?	string

Returns: Field<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:485

---

mapResult

▸ mapResult<T>(result: EntityData<T>, meta: EntityMetadata<T>, populate?: PopulateOptions<T>[], qb?: QueryBuilder<T>, map?: Dictionary<any>): null | EntityData<T>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
result	EntityData<T>	-
meta	EntityMetadata<T>	-
populate	PopulateOptions<T>[]	...
qb?	QueryBuilder<T>	-
map	Dictionary<any>	...

Returns: null | EntityData<T>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:89

---

mergeJoinedResult

▸ mergeJoinedResult<T>(rawResults: EntityData<T>[], meta: EntityMetadata<T>): EntityData<T>[]

internal

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
rawResults	EntityData<T>[]
meta	EntityMetadata<T>

Returns: EntityData<T>[]

Defined in: packages/knex/src/AbstractSqlDriver.ts:442

---

nativeDelete

▸ nativeDelete<T>(entityName: string, where: any, ctx?: Transaction<any, any>): Promise<QueryResult>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
entityName	string
where	any
ctx?	Transaction<any, any>

Returns: Promise<QueryResult>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:336

---

nativeInsert

▸ nativeInsert<T>(entityName: string, data: EntityData<T>, ctx?: Transaction<any, any>, convertCustomTypes?: boolean): Promise<QueryResult>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
data	EntityData<T>	-
ctx?	Transaction<any, any>	-
convertCustomTypes	boolean	true

Returns: Promise<QueryResult>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:184

---

nativeInsertMany

▸ nativeInsertMany<T>(entityName: string, data: EntityData<T>[], ctx?: Transaction<any, any>, processCollections?: boolean, convertCustomTypes?: boolean): Promise<QueryResult>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
data	EntityData<T>[]	-
ctx?	Transaction<any, any>	-
processCollections	boolean	true
convertCustomTypes	boolean	true

Returns: Promise<QueryResult>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:206

---

nativeUpdate

▸ nativeUpdate<T>(entityName: string, where: FilterQuery<T>, data: EntityData<T>, ctx?: Transaction<any, any>, convertCustomTypes?: boolean): Promise<QueryResult>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
where	FilterQuery<T>	-
data	EntityData<T>	-
ctx?	Transaction<any, any>	-
convertCustomTypes	boolean	true

Returns: Promise<QueryResult>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:262

---

nativeUpdateMany

▸ nativeUpdateMany<T>(entityName: string, where: FilterQuery<T>[], data: EntityData<T>[], ctx?: Transaction<any, any>, processCollections?: boolean, convertCustomTypes?: boolean): Promise<QueryResult>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
entityName	string	-
where	FilterQuery<T>[]	-
data	EntityData<T>[]	-
ctx?	Transaction<any, any>	-
processCollections	boolean	true
convertCustomTypes	boolean	true

Returns: Promise<QueryResult>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:286

---

processManyToMany

▸ ProtectedprocessManyToMany<T>(meta: undefined | EntityMetadata<T>, pks: Primary<T>[], collections: EntityData<T>, clear: boolean, ctx?: Transaction<any, any>): Promise<void>

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type
meta	undefined | EntityMetadata<T>
pks	Primary<T>[]
collections	EntityData<T>
clear	boolean
ctx?	Transaction<any, any>

Returns: Promise<void>

Defined in: packages/knex/src/AbstractSqlDriver.ts:527

---

reconnect

▸ reconnect(): Promise<C>

Returns: Promise<C>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:78

---

rethrow

▸ Protectedrethrow<T>(promise: Promise<T>): Promise<T>

Type parameters:

Name
T

Parameters:

Name	Type
promise	Promise<T>

Returns: Promise<T>

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:252

---

setMetadata

▸ setMetadata(metadata: MetadataStorage): void

Parameters:

Name	Type
metadata	MetadataStorage

Returns: void

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:102

---

shouldHaveColumn

▸ shouldHaveColumn<T>(prop: EntityProperty<T>, populate: PopulateOptions<T>[], includeFormulas?: boolean): boolean

internal

Type parameters:

Name	Type
T	AnyEntity<T>

Parameters:

Name	Type	Default value
prop	EntityProperty<T>	-
populate	PopulateOptions<T>[]	-
includeFormulas	boolean	true

Returns: boolean

Inherited from: DatabaseDriver

Defined in: packages/core/src/drivers/DatabaseDriver.ts:225

---

syncCollection

▸ syncCollection<T, O>(coll: Collection<T, O>, ctx?: any): Promise<void>

Type parameters:

Name	Type
T	AnyEntity<T>
O	AnyEntity<O>

Parameters:

Name	Type
coll	Collection<T, O>
ctx?	any

Returns: Promise<void>

Overrides: DatabaseDriver

Defined in: packages/knex/src/AbstractSqlDriver.ts:348

---

updateCollectionDiff

▸ ProtectedupdateCollectionDiff<T, O>(meta: EntityMetadata<O>, prop: EntityProperty<T>, pks: Primary<O>[], deleteDiff: boolean | Primary<T>[][], insertDiff: Primary<T>[][], ctx?: any): Promise<void>

Type parameters:

Name	Type
T	AnyEntity<T>
O	AnyEntity<O>

Parameters:

Name	Type
meta	EntityMetadata<O>
prop	EntityProperty<T>
pks	Primary<O>[]
deleteDiff	boolean | Primary<T>[][]
insertDiff	Primary<T>[][]
ctx?	any

Returns: Promise<void>

Defined in: packages/knex/src/AbstractSqlDriver.ts:539