Version: 4.3

Class: SqlitePlatform

Hierarchy

  • AbstractSqlPlatform

    SqlitePlatform

Properties

config

Protected config: Configuration

Inherited from AbstractSqlPlatform.config

Defined in packages/core/dist/platforms/Platform.d.ts:9


exceptionConverter

Protected Readonly exceptionConverter: SqliteExceptionConverter = new SqliteExceptionConverter()

Overrides AbstractSqlPlatform.exceptionConverter

Defined in packages/sqlite/src/SqlitePlatform.ts:11


schemaHelper

Protected Readonly schemaHelper: SqliteSchemaHelper = new SqliteSchemaHelper()

Overrides void

Defined in packages/sqlite/src/SqlitePlatform.ts:10


timezone

Protected Optional timezone: string

Inherited from AbstractSqlPlatform.timezone

Defined in packages/core/dist/platforms/Platform.d.ts:10

Methods

allowsMultiInsert

allowsMultiInsert(): boolean

Inherited from AbstractSqlPlatform.allowsMultiInsert

Defined in packages/core/dist/platforms/Platform.d.ts:23

Returns: boolean


allowsUniqueBatchUpdates

allowsUniqueBatchUpdates(): boolean

Inherited from AbstractSqlPlatform.allowsUniqueBatchUpdates

Defined in packages/core/dist/platforms/Platform.d.ts:55

Returns: boolean


convertsJsonAutomatically

convertsJsonAutomatically(): boolean

Overrides AbstractSqlPlatform.convertsJsonAutomatically

Defined in packages/sqlite/src/SqlitePlatform.ts:25

Returns: boolean


denormalizePrimaryKey

denormalizePrimaryKey(data: IPrimaryKey): IPrimaryKey

Inherited from AbstractSqlPlatform.denormalizePrimaryKey

Defined in packages/core/dist/platforms/Platform.d.ts:40

Converts scalar primary key representation to native driver wrapper (e.g. string to mongodb's ObjectId)

Parameters:

NameType
dataIPrimaryKey

Returns: IPrimaryKey


formatQuery

formatQuery(sql: string, params: readonly any[]): string

Inherited from MySqlPlatform.formatQuery

Defined in packages/knex/dist/AbstractSqlPlatform.d.ts:10

Parameters:

NameType
sqlstring
paramsreadonly any[]

Returns: string


getArrayDeclarationSQL

getArrayDeclarationSQL(): string

Inherited from AbstractSqlPlatform.getArrayDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:58

Returns: string


getBigIntTypeDeclarationSQL

getBigIntTypeDeclarationSQL(): string

Inherited from AbstractSqlPlatform.getBigIntTypeDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:57

Returns: string


getBlobDeclarationSQL

getBlobDeclarationSQL(): string

Inherited from AbstractSqlPlatform.getBlobDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:61

Returns: string


getCurrentTimestampSQL

getCurrentTimestampSQL(length: number): string

Overrides AbstractSqlPlatform.getCurrentTimestampSQL

Defined in packages/sqlite/src/SqlitePlatform.ts:21

Parameters:

NameType
lengthnumber

Returns: string


getDateTypeDeclarationSQL

getDateTypeDeclarationSQL(length: number): string

Inherited from AbstractSqlPlatform.getDateTypeDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:50

Parameters:

NameType
lengthnumber

Returns: string


getDefaultCharset

getDefaultCharset(): string

Inherited from AbstractSqlPlatform.getDefaultCharset

Defined in packages/core/dist/platforms/Platform.d.ts:66

Returns: string


getExceptionConverter

getExceptionConverter(): ExceptionConverter

Inherited from AbstractSqlPlatform.getExceptionConverter

Defined in packages/core/dist/platforms/Platform.d.ts:67

Returns: ExceptionConverter


getJsonDeclarationSQL

getJsonDeclarationSQL(): string

Inherited from AbstractSqlPlatform.getJsonDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:62

Returns: string


getNamingStrategy

getNamingStrategy(): object

Inherited from AbstractSqlPlatform.getNamingStrategy

Defined in packages/core/dist/platforms/Platform.d.ts:14

Returns: object

NameType
constructor() => NamingStrategy

getRegExpOperator

getRegExpOperator(): string

Inherited from AbstractSqlPlatform.getRegExpOperator

Defined in packages/core/dist/platforms/Platform.d.ts:52

Returns: string


getRepositoryClass

getRepositoryClass<T>(): Constructor<EntityRepository<T>>

Inherited from MySqlPlatform.getRepositoryClass

Overrides void

Defined in packages/knex/dist/AbstractSqlPlatform.d.ts:6

Type parameters:

Name
T

Returns: Constructor<EntityRepository<T>>


getSchemaGenerator

getSchemaGenerator(em: EntityManager): SchemaGenerator

Inherited from MySqlPlatform.getSchemaGenerator

Overrides MongoPlatform.getSchemaGenerator

Defined in packages/knex/dist/AbstractSqlPlatform.d.ts:8

Parameters:

NameType
emEntityManager

Returns: SchemaGenerator


getSchemaHelper

getSchemaHelper(): SchemaHelper | undefined

Inherited from MySqlPlatform.getSchemaHelper

Overrides MongoPlatform.getSchemaHelper

Defined in packages/knex/dist/AbstractSqlPlatform.d.ts:7

Returns: SchemaHelper | undefined


getSearchJsonPropertySQL

getSearchJsonPropertySQL(path: string): string

Inherited from AbstractSqlPlatform.getSearchJsonPropertySQL

Defined in packages/core/dist/platforms/Platform.d.ts:63

Parameters:

NameType
pathstring

Returns: string


getSerializedPrimaryKeyField

getSerializedPrimaryKeyField(field: string): string

Inherited from AbstractSqlPlatform.getSerializedPrimaryKeyField

Defined in packages/core/dist/platforms/Platform.d.ts:44

Used when serializing via toObject and toJSON methods, allows to use different PK field name (like id instead of _id)

Parameters:

NameType
fieldstring

Returns: string


getTimeTypeDeclarationSQL

getTimeTypeDeclarationSQL(length: number): string

Inherited from AbstractSqlPlatform.getTimeTypeDeclarationSQL

Defined in packages/core/dist/platforms/Platform.d.ts:51

Parameters:

NameType
lengthnumber

Returns: string


isBigIntProperty

isBigIntProperty(prop: EntityProperty): boolean

Inherited from AbstractSqlPlatform.isBigIntProperty

Defined in packages/core/dist/platforms/Platform.d.ts:56

Parameters:

NameType
propEntityProperty

Returns: boolean


marshallArray

marshallArray(values: string[]): string

Inherited from AbstractSqlPlatform.marshallArray

Defined in packages/core/dist/platforms/Platform.d.ts:59

Parameters:

NameType
valuesstring[]

Returns: string


normalizePrimaryKey

normalizePrimaryKey<T>(data: Primary<T> | IPrimaryKey): T

Inherited from AbstractSqlPlatform.normalizePrimaryKey

Defined in packages/core/dist/platforms/Platform.d.ts:36

Normalizes primary key wrapper to scalar value (e.g. mongodb's ObjectId to string)

Type parameters:

NameTypeDefault
Tnumber | stringnumber \

Parameters:

NameType
dataPrimary<T> | IPrimaryKey

Returns: T


processDateProperty

processDateProperty(value: unknown): string | number | Date

Overrides AbstractSqlPlatform.processDateProperty

Defined in packages/sqlite/src/SqlitePlatform.ts:35

This is used to narrow the value of Date properties as they will be stored as timestamps in sqlite. We use this method to convert Dates to timestamps when computing the changeset, so we have the right data type in the payload as well as in original entity data. Without that, we would end up with diffs including all Date properties, as we would be comparing Date object with timestamp.

Parameters:

NameType
valueunknown

Returns: string | number | Date


quoteIdentifier

quoteIdentifier(id: string, quote?: string): string

Inherited from AbstractSqlPlatform.quoteIdentifier

Defined in packages/core/dist/platforms/Platform.d.ts:70

Parameters:

NameType
idstring
quote?string

Returns: string


quoteValue

quoteValue(value: any): string

Overrides MySqlPlatform.quoteValue

Defined in packages/sqlite/src/SqlitePlatform.ts:55

Parameters:

NameType
valueany

Returns: string


quoteVersionValue

quoteVersionValue(value: Date | number, prop: EntityProperty): Date | string | number

Overrides AbstractSqlPlatform.quoteVersionValue

Defined in packages/sqlite/src/SqlitePlatform.ts:43

Parameters:

NameType
valueDate | number
propEntityProperty

Returns: Date | string | number


requiresNullableForAlteringColumn

requiresNullableForAlteringColumn(): boolean

Overrides AbstractSqlPlatform.requiresNullableForAlteringColumn

Defined in packages/sqlite/src/SqlitePlatform.ts:13

Returns: boolean


requiresValuesKeyword

requiresValuesKeyword(): boolean

Overrides AbstractSqlPlatform.requiresValuesKeyword

Defined in packages/sqlite/src/SqlitePlatform.ts:51

Returns: boolean


setConfig

setConfig(config: Configuration): void

Inherited from AbstractSqlPlatform.setConfig

Defined in packages/core/dist/platforms/Platform.d.ts:71

Parameters:

NameType
configConfiguration

Returns: void


supportsTransactions

supportsTransactions(): boolean

Inherited from AbstractSqlPlatform.supportsTransactions

Defined in packages/core/dist/platforms/Platform.d.ts:12

Returns: boolean


unmarshallArray

unmarshallArray(value: string): string[]

Inherited from AbstractSqlPlatform.unmarshallArray

Defined in packages/core/dist/platforms/Platform.d.ts:60

Parameters:

NameType
valuestring

Returns: string[]


usesBatchInserts

usesBatchInserts(): boolean

Inherited from AbstractSqlPlatform.usesBatchInserts

Defined in packages/core/dist/platforms/Platform.d.ts:27

Whether or not the driver supports retuning list of created PKs back when multi-inserting

Returns: boolean


usesBatchUpdates

usesBatchUpdates(): boolean

Inherited from AbstractSqlPlatform.usesBatchUpdates

Defined in packages/core/dist/platforms/Platform.d.ts:31

Whether or not the driver supports updating many records at once

Returns: boolean


usesCascadeStatement

usesCascadeStatement(): boolean

Inherited from AbstractSqlPlatform.usesCascadeStatement

Defined in packages/core/dist/platforms/Platform.d.ts:18

Returns: boolean


usesDefaultKeyword

usesDefaultKeyword(): boolean

Overrides AbstractSqlPlatform.usesDefaultKeyword

Defined in packages/sqlite/src/SqlitePlatform.ts:17

Returns: boolean


usesDifferentSerializedPrimaryKey

usesDifferentSerializedPrimaryKey(): boolean

Inherited from AbstractSqlPlatform.usesDifferentSerializedPrimaryKey

Defined in packages/core/dist/platforms/Platform.d.ts:45

Returns: boolean


usesImplicitTransactions

usesImplicitTransactions(): boolean

Inherited from AbstractSqlPlatform.usesImplicitTransactions

Defined in packages/core/dist/platforms/Platform.d.ts:13

Returns: boolean


usesPivotTable

usesPivotTable(): boolean

Inherited from MySqlPlatform.usesPivotTable

Overrides MongoPlatform.usesPivotTable

Defined in packages/knex/dist/AbstractSqlPlatform.d.ts:5

Returns: boolean


usesReturningStatement

usesReturningStatement(): boolean

Inherited from AbstractSqlPlatform.usesReturningStatement

Defined in packages/core/dist/platforms/Platform.d.ts:17

Returns: boolean

Last updated on by Martin Adámek