Class DefaultPlatform`Abstract`

Hierarchy

DefaultPlatform

Index

Constructors

Properties

annotationId defaultNowExpression defaultSqlType namingStrategy nativeTypeInformation placeholderStrategy schemaParserType serializer typeMapping

Methods

addBinaryType addType applyLimitAndOffset createSqlFilterBuilder createTables getAddColumnDDL getAddForeignKeyDDL getAddForeignKeysDDL getAddIndexDDL getAddIndicesDDL getAddPrimaryKeyDDL getAddSchemaDDL getAddSchemasDDL getAddTableDDL getAddTablesDDL getAggregateSelect getAutoIncrement getBeginDDL getColumnDDL getColumnDefaultValueDDL getColumnListDDL getCreateTableDDL getDropForeignKeyDDL getDropIndexDDL getDropPrimaryKeyDDL getDropTableDDL getEndDDL getEntityFields getForeignKeyDDL getFullIdentifier getIdentifier getMigrationTableName getModifyColumnDDL getModifyDatabaseDDL getModifyTableDDL getNotNullString getNullString getPrimaryKeyDDL getPrimaryKeyName getRemoveColumnDDL getRenameColumnDDL getRenameTableDDL getResetSchemaDDL getSchemaDelimiter getTableIdentifier getTypeMapping getUniqueDDL getUseSchemaDDL normalizeTables quoteIdentifier quoteValue setColumnType supportsInlineForeignKey supportsInlinePrimaryKey supportsSelectFor typeCast

Constructors

constructor

new DefaultPlatform(): DefaultPlatform
Returns DefaultPlatform

Properties

`Protected` annotationId

annotationId: string = '*'

The ID used in annotation to get database related type information (like type, default, defaultExpr, ...) via databaseAnnotation.getDatabase.

`Protected` defaultNowExpression

defaultNowExpression: string = ''

`Protected` defaultSqlType

defaultSqlType: string = 'text'

namingStrategy

namingStrategy: NamingStrategy = ...

`Protected` nativeTypeInformation

nativeTypeInformation: Map<string, Partial<NativeTypeInformation>> = ...

placeholderStrategy

placeholderStrategy: ClassType<SqlPlaceholderStrategy> = SqlPlaceholderStrategy

`Abstract` schemaParserType

schemaParserType: ClassType<SchemaParser>

serializer

serializer: Serializer = sqlSerializer

`Protected` typeMapping

typeMapping: Map<ReflectionKind | TypeMappingChecker, TypeMapping> = ...

Methods

addBinaryType

addBinaryType(sqlType: string, size?: number, scale?: number): void
Parameters
- sqlType: string
- Optional size: number
- Optional scale: number
Returns void
- Defined in packages/sql/src/platform/default-platform.ts:118

addType

addType(kind: ReflectionKind | TypeMappingChecker, sqlType: string, size?: number, scale?: number, unsigned?: boolean): void
Parameters
- kind: ReflectionKind | TypeMappingChecker
- sqlType: string
- Optional size: number
- Optional scale: number
- Optional unsigned: boolean
Returns void
- Defined in packages/sql/src/platform/default-platform.ts:124

applyLimitAndOffset

applyLimitAndOffset(sql: Sql, limit?: number, offset?: number): void
Parameters
- sql: Sql
- Optional limit: number
- Optional offset: number
Returns void
- Defined in packages/sql/src/platform/default-platform.ts:96

createSqlFilterBuilder

createSqlFilterBuilder(reflectionClass: ReflectionClass<any>, tableName: string): SQLFilterBuilder
Parameters
- reflectionClass: ReflectionClass<any>
- tableName: string
Returns SQLFilterBuilder
- Defined in packages/sql/src/platform/default-platform.ts:101

createTables

createTables(entityRegistry: DatabaseEntityRegistry, database?: DatabaseModel): Table[]
Parameters
- entityRegistry: DatabaseEntityRegistry
- database: DatabaseModel = ...
Returns Table[]
- Defined in packages/sql/src/platform/default-platform.ts:238

getAddColumnDDL

getAddColumnDDL(column: Column): string
Parameters
- column: Column
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:604

getAddForeignKeyDDL

getAddForeignKeyDDL(foreignKey: ForeignKey): string
Parameters
- foreignKey: ForeignKey
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:539

getAddForeignKeysDDL

getAddForeignKeysDDL(table: Table): string[]
Parameters
- table: Table
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:531

getAddIndexDDL

getAddIndexDDL(index: IndexModel): string
Parameters
- index: IndexModel
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:558

getAddIndicesDDL

getAddIndicesDDL(table: Table): string[]
Parameters
- table: Table
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:535

getAddPrimaryKeyDDL

getAddPrimaryKeyDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:406

getAddSchemaDDL

getAddSchemaDDL(schemaName: string): string
Parameters
- schemaName: string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:449

getAddSchemasDDL

getAddSchemasDDL(database: DatabaseModel): string
Parameters
- database: DatabaseModel
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:438

getAddTableDDL

getAddTableDDL(table: Table): string[]
Parameters
- table: Table
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:510

getAddTablesDDL

getAddTablesDDL(database: DatabaseModel): string[]
Parameters
- database: DatabaseModel
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:418

getAggregateSelect

getAggregateSelect(tableName: string, property: ReflectionProperty, func: string): string
Parameters
- tableName: string
- property: ReflectionProperty
- func: string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:114

getAutoIncrement

getAutoIncrement(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:642

getBeginDDL

getBeginDDL(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:410

getColumnDDL

getColumnDDL(column: Column): string
Parameters
- column: Column
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:620

getColumnDefaultValueDDL

getColumnDefaultValueDDL(column: Column): string
Parameters
- column: Column
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:632

getColumnListDDL

getColumnListDDL(columns: Column[]): string
Parameters
- columns: Column[]
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:128

getCreateTableDDL

getCreateTableDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:522

getDropForeignKeyDDL

getDropForeignKeyDDL(foreignKey: ForeignKey): string
Parameters
- foreignKey: ForeignKey
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:608

getDropIndexDDL

getDropIndexDDL(index: IndexModel): string
Parameters
- index: IndexModel
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:612

getDropPrimaryKeyDDL

getDropPrimaryKeyDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:400

getDropTableDDL

getDropTableDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:580

getEndDDL

getEndDDL(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:414

getEntityFields

getEntityFields(schema: ReflectionClass<any>): ReflectionProperty[]
Parameters
- schema: ReflectionClass<any>
Returns ReflectionProperty[]
- Defined in packages/sql/src/platform/default-platform.ts:167

getForeignKeyDDL

getForeignKeyDDL(foreignKey: ForeignKey): string
Parameters
- foreignKey: ForeignKey
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:543

getFullIdentifier

getFullIdentifier(object: Table | Column, append?: string): string
Parameters
- object: Table | Column
- append: string = ''
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:392

getIdentifier

getIdentifier(object: Table | Column | IndexModel | ForeignKey, append?: string): string
Parameters
- object: Table | Column | IndexModel | ForeignKey
- append: string = ''
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:387

getMigrationTableName

getMigrationTableName(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:105

getModifyColumnDDL

getModifyColumnDDL(diff: ColumnDiff): string
Parameters
- diff: ColumnDiff
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:600

getModifyDatabaseDDL

getModifyDatabaseDDL(databaseDiff: DatabaseDiff): string[]
Parameters
- databaseDiff: DatabaseDiff
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:213

getModifyTableDDL

getModifyTableDDL(diff: TableDiff): string[]
Parameters
- diff: TableDiff
Returns string[]
- Defined in packages/sql/src/platform/default-platform.ts:466

getNotNullString

getNotNullString(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:646

getNullString

getNullString(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:650

getPrimaryKeyDDL

getPrimaryKeyDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:157

getPrimaryKeyName

getPrimaryKeyName(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:396

getRemoveColumnDDL

getRemoveColumnDDL(column: Column): string
Parameters
- column: Column
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:588

getRenameColumnDDL

getRenameColumnDDL(from: Column, to: Column): string
Parameters
- from: Column
- to: Column
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:592

getRenameTableDDL

getRenameTableDDL(from: Table, to: Table): string
Parameters
- from: Table
- to: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:462

getResetSchemaDDL

getResetSchemaDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:458

getSchemaDelimiter

getSchemaDelimiter(): string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:132

getTableIdentifier

getTableIdentifier(schema: ReflectionClass<any>): string
Parameters
- schema: ReflectionClass<any>
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:380

`Protected` getTypeMapping

getTypeMapping(type: Type): undefined | TypeMapping
Parameters
- type: Type
Returns undefined | TypeMapping
- Defined in packages/sql/src/platform/default-platform.ts:176

getUniqueDDL

getUniqueDDL(unique: IndexModel): string
Parameters
- unique: IndexModel
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:616

getUseSchemaDDL

getUseSchemaDDL(table: Table): string
Parameters
- table: Table
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:454

normalizeTables

normalizeTables(tables: Table[]): void
Parameters
- tables: Table[]
Returns void
- Defined in packages/sql/src/platform/default-platform.ts:163

quoteIdentifier

quoteIdentifier(id: string): string
Parameters
- id: string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:376

quoteValue

quoteValue(value: any): string
Parameters
- value: any
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:109

`Protected` setColumnType

setColumnType(column: Column, typeProperty: ReflectionProperty): void
Parameters
- column: Column
- typeProperty: ReflectionProperty
Returns void
- Defined in packages/sql/src/platform/default-platform.ts:188

supportsInlineForeignKey

supportsInlineForeignKey(): boolean
If the platform supports the CONSTRAINT %s FOREIGN KEY section in CREATE TABLE(column, column, CONSTRAINT %s FOREIGN KEY);

Returns boolean
- Defined in packages/sql/src/platform/default-platform.ts:153

supportsInlinePrimaryKey

supportsInlinePrimaryKey(): boolean
If the platform supports the PRIMARY KEY section in CREATE TABLE(column, column, PRIMARY KEY());

Returns boolean
- Defined in packages/sql/src/platform/default-platform.ts:146

supportsSelectFor

supportsSelectFor(): boolean
If the platform supports the SELECT FOR UPDATE or SELECT FOR SHARE.

Returns boolean
- Defined in packages/sql/src/platform/default-platform.ts:139

typeCast

typeCast(schema: ReflectionClass<any>, name: string): string
Parameters
- schema: ReflectionClass<any>
- name: string
Returns string
- Defined in packages/sql/src/platform/default-platform.ts:81

Class DefaultPlatformAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DefaultPlatform

Properties

Protected annotationId

Protected defaultNowExpression

Protected defaultSqlType

namingStrategy

Protected nativeTypeInformation

placeholderStrategy

Abstract schemaParserType

serializer

Protected typeMapping

Methods

addBinaryType

Parameters

sqlType: string

Optional size: number

Optional scale: number

Returns void

addType

Parameters

kind: ReflectionKind | TypeMappingChecker

sqlType: string

Optional size: number

Optional scale: number

Optional unsigned: boolean

Returns void

applyLimitAndOffset

Parameters

sql: Sql

Optional limit: number

Optional offset: number

Returns void

createSqlFilterBuilder

Parameters

reflectionClass: ReflectionClass<any>

tableName: string

Returns SQLFilterBuilder

createTables

Parameters

entityRegistry: DatabaseEntityRegistry

database: DatabaseModel = ...

Returns Table[]

getAddColumnDDL

Parameters

column: Column

Returns string

getAddForeignKeyDDL

Parameters

foreignKey: ForeignKey

Returns string

getAddForeignKeysDDL

Parameters

table: Table

Returns string[]

getAddIndexDDL

Parameters

index: IndexModel

Returns string

getAddIndicesDDL

Parameters

table: Table

Returns string[]

getAddPrimaryKeyDDL

Parameters

table: Table

Returns string

getAddSchemaDDL

Parameters

schemaName: string

Returns string

getAddSchemasDDL

Parameters

Class DefaultPlatform`Abstract`

`Protected` annotationId

`Protected` defaultNowExpression

`Protected` defaultSqlType

`Protected` nativeTypeInformation

`Abstract` schemaParserType

`Protected` typeMapping

`Optional` size: number

`Optional` scale: number

`Optional` size: number

`Optional` scale: number

`Optional` unsigned: boolean

`Optional` limit: number

`Optional` offset: number