Class: AbstractSqlPlatform#
knex.AbstractSqlPlatform
Hierarchy#
↳ AbstractSqlPlatform
Constructors#
constructor#
+ new AbstractSqlPlatform(): AbstractSqlPlatform
Returns: AbstractSqlPlatform
Inherited from: Platform
Properties#
config#
• Protected config: Configuration<IDatabaseDriver<Connection>>
Inherited from: Platform.config
Defined in: packages/core/src/platforms/Platform.ts:11
exceptionConverter#
• Protected Readonly exceptionConverter: ExceptionConverter
Inherited from: Platform.exceptionConverter
Defined in: packages/core/src/platforms/Platform.ts:10
schemaHelper#
• Protected Optional Readonly schemaHelper: undefined | SchemaHelper
Defined in: packages/knex/src/AbstractSqlPlatform.ts:8
timezone#
• Protected Optional timezone: undefined | string
Inherited from: Platform.timezone
Defined in: packages/core/src/platforms/Platform.ts:12
Methods#
allowsComparingTuples#
â–¸ allowsComparingTuples(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:120
allowsMultiInsert#
â–¸ allowsMultiInsert(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:46
allowsUniqueBatchUpdates#
â–¸ allowsUniqueBatchUpdates(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:124
convertsJsonAutomatically#
â–¸ convertsJsonAutomatically(marshall?: boolean): boolean
Parameters:#
| Name | Type | Default value |
|---|---|---|
marshall | boolean | false |
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:168
denormalizePrimaryKey#
â–¸ denormalizePrimaryKey(data: IPrimaryKeyValue): IPrimaryKeyValue
Converts scalar primary key representation to native driver wrapper (e.g. string to mongodb's ObjectId)
Parameters:#
| Name | Type |
|---|---|
data | IPrimaryKeyValue |
Returns: IPrimaryKeyValue
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:78
formatQuery#
â–¸ formatQuery(sql: string, params: readonly any[]): string
Parameters:#
| Name | Type |
|---|---|
sql | string |
params | readonly any[] |
Returns: string
Defined in: packages/knex/src/AbstractSqlPlatform.ts:36
getArrayDeclarationSQL#
â–¸ getArrayDeclarationSQL(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:140
getBigIntTypeDeclarationSQL#
â–¸ getBigIntTypeDeclarationSQL(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:136
getBlobDeclarationSQL#
â–¸ getBlobDeclarationSQL(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:156
getCurrentTimestampSQL#
â–¸ getCurrentTimestampSQL(length: number): string
Returns the SQL specific for the platform to get the current timestamp
Parameters:#
| Name | Type |
|---|---|
length | number |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:96
getDateTypeDeclarationSQL#
â–¸ getDateTypeDeclarationSQL(length: number): string
Parameters:#
| Name | Type |
|---|---|
length | number |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:100
getDefaultCharset#
â–¸ getDefaultCharset(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:176
getExceptionConverter#
â–¸ getExceptionConverter(): ExceptionConverter
Returns: ExceptionConverter
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:180
getJsonDeclarationSQL#
â–¸ getJsonDeclarationSQL(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:160
getNamingStrategy#
â–¸ getNamingStrategy(): function
Returns: function
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:26
getRegExpOperator#
â–¸ getRegExpOperator(): string
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:108
getRepositoryClass#
â–¸ getRepositoryClass<T>(): Constructor<EntityRepository<T>>
Type parameters:#
| Name |
|---|
T |
Returns: Constructor<EntityRepository<T>>
Overrides: Platform
Defined in: packages/knex/src/AbstractSqlPlatform.ts:14
getSchemaGenerator#
â–¸ getSchemaGenerator(em: EntityManager<IDatabaseDriver<Connection>>): SchemaGenerator
Parameters:#
| Name | Type |
|---|---|
em | EntityManager<IDatabaseDriver<Connection>> |
Returns: SchemaGenerator
Overrides: Platform
Defined in: packages/knex/src/AbstractSqlPlatform.ts:22
getSchemaHelper#
â–¸ getSchemaHelper(): undefined | SchemaHelper
Returns: undefined | SchemaHelper
Overrides: Platform
Defined in: packages/knex/src/AbstractSqlPlatform.ts:18
getSearchJsonPropertySQL#
â–¸ getSearchJsonPropertySQL(path: string): string
Parameters:#
| Name | Type |
|---|---|
path | string |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:164
getSerializedPrimaryKeyField#
â–¸ getSerializedPrimaryKeyField(field: string): string
Used when serializing via toObject and toJSON methods, allows to use different PK field name (like id instead of _id)
Parameters:#
| Name | Type |
|---|---|
field | string |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:85
getTimeTypeDeclarationSQL#
â–¸ getTimeTypeDeclarationSQL(length: number): string
Parameters:#
| Name | Type |
|---|---|
length | number |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:104
isBigIntProperty#
â–¸ isBigIntProperty(prop: EntityProperty<any>): boolean
Parameters:#
| Name | Type |
|---|---|
prop | EntityProperty<any> |
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:128
isRaw#
â–¸ isRaw(value: any): boolean
Parameters:#
| Name | Type |
|---|---|
value | any |
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:132
marshallArray#
â–¸ marshallArray(values: string[]): string
Parameters:#
| Name | Type |
|---|---|
values | string[] |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:144
normalizePrimaryKey#
â–¸ normalizePrimaryKey<T>(data: string | number | bigint | Date | { toHexString: () => string } | Primary<T>): T
Normalizes primary key wrapper to scalar value (e.g. mongodb's ObjectId to string)
Type parameters:#
| Name | Type | Default |
|---|---|---|
T | string | number | string \ |
Parameters:#
| Name | Type |
|---|---|
data | string | number | bigint | Date | { toHexString: () => string } | Primary<T> |
Returns: T
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:71
processDateProperty#
â–¸ processDateProperty(value: unknown): string | number | Date
Parameters:#
| Name | Type |
|---|---|
value | unknown |
Returns: string | number | Date
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:188
quoteIdentifier#
â–¸ quoteIdentifier(id: string, quote?: string): string
Parameters:#
| Name | Type | Default value |
|---|---|---|
id | string | - |
quote | string | '`' |
Returns: string
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:192
quoteValue#
â–¸ quoteValue(value: any): string
Parameters:#
| Name | Type |
|---|---|
value | any |
Returns: string
Defined in: packages/knex/src/AbstractSqlPlatform.ts:26
quoteVersionValue#
â–¸ quoteVersionValue(value: number | Date, prop: EntityProperty<any>): string | number | Date
Parameters:#
| Name | Type |
|---|---|
value | number | Date |
prop | EntityProperty<any> |
Returns: string | number | Date
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:112
requiresNullableForAlteringColumn#
â–¸ requiresNullableForAlteringColumn(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:42
requiresValuesKeyword#
â–¸ requiresValuesKeyword(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:116
setConfig#
â–¸ setConfig(config: Configuration<IDatabaseDriver<Connection>>): void
Parameters:#
| Name | Type |
|---|---|
config | Configuration<IDatabaseDriver<Connection>> |
Returns: void
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:196
supportsTransactions#
â–¸ supportsTransactions(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:18
unmarshallArray#
â–¸ unmarshallArray(value: string): string[]
Parameters:#
| Name | Type |
|---|---|
value | string |
Returns: string[]
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:148
usesBatchInserts#
â–¸ usesBatchInserts(): boolean
Whether or not the driver supports retuning list of created PKs back when multi-inserting
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:53
usesBatchUpdates#
â–¸ usesBatchUpdates(): boolean
Whether or not the driver supports updating many records at once
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:60
usesCascadeStatement#
â–¸ usesCascadeStatement(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:34
usesDefaultKeyword#
â–¸ usesDefaultKeyword(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:64
usesDifferentSerializedPrimaryKey#
â–¸ usesDifferentSerializedPrimaryKey(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:89
usesImplicitTransactions#
â–¸ usesImplicitTransactions(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:22
usesPivotTable#
â–¸ usesPivotTable(): boolean
Returns: boolean
Overrides: Platform
Defined in: packages/knex/src/AbstractSqlPlatform.ts:10
usesReturningStatement#
â–¸ usesReturningStatement(): boolean
Returns: boolean
Inherited from: Platform
Defined in: packages/core/src/platforms/Platform.ts:30