Class: DatabaseTable#
knex.DatabaseTable
Constructors#
constructor#
+ new DatabaseTable(name: string, schema?: string): DatabaseTable
Parameters:#
| Name | Type |
|---|---|
name | string |
schema? | string |
Returns: DatabaseTable
Defined in: packages/knex/src/schema/DatabaseTable.ts:9
Properties#
columns#
• Private columns: Dictionary<Column>
Defined in: packages/knex/src/schema/DatabaseTable.ts:7
foreignKeys#
• Private foreignKeys: Dictionary<ForeignKey>
Defined in: packages/knex/src/schema/DatabaseTable.ts:9
indexes#
• Private indexes: Index[]
Defined in: packages/knex/src/schema/DatabaseTable.ts:8
name#
• Readonly name: string
schema#
• Optional Readonly schema: string
Methods#
getColumn#
â–¸ getColumn(name: string): undefined | Column
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: undefined | Column
Defined in: packages/knex/src/schema/DatabaseTable.ts:18
getColumns#
â–¸ getColumns(): Column[]
Returns: Column[]
Defined in: packages/knex/src/schema/DatabaseTable.ts:14
getEntityDeclaration#
â–¸ getEntityDeclaration(namingStrategy: NamingStrategy, schemaHelper: SchemaHelper): EntityMetadata<any>
Parameters:#
| Name | Type |
|---|---|
namingStrategy | NamingStrategy |
schemaHelper | SchemaHelper |
Returns: EntityMetadata<any>
Defined in: packages/knex/src/schema/DatabaseTable.ts:58
getIndexes#
â–¸ getIndexes(): Dictionary<Index[]>
Returns: Dictionary<Index[]>
Defined in: packages/knex/src/schema/DatabaseTable.ts:22
getPropertyDeclaration#
â–¸ PrivategetPropertyDeclaration(column: Column, namingStrategy: NamingStrategy, schemaHelper: SchemaHelper, compositeFkIndexes: Dictionary<{ keyName: string }>, schema: EntitySchema<AnyEntity<any>, undefined>): void
Parameters:#
| Name | Type |
|---|---|
column | Column |
namingStrategy | NamingStrategy |
schemaHelper | SchemaHelper |
compositeFkIndexes | Dictionary<{ keyName: string }> |
schema | EntitySchema<AnyEntity<any>, undefined> |
Returns: void
Defined in: packages/knex/src/schema/DatabaseTable.ts:91
getPropertyDefaultValue#
â–¸ PrivategetPropertyDefaultValue(schemaHelper: SchemaHelper, column: Column, propType: string, raw?: boolean): any
Parameters:#
| Name | Type | Default value |
|---|---|---|
schemaHelper | SchemaHelper | - |
column | Column | - |
propType | string | - |
raw | boolean | false |
Returns: any
Defined in: packages/knex/src/schema/DatabaseTable.ts:157
getPropertyName#
â–¸ PrivategetPropertyName(column: Column): string
Parameters:#
| Name | Type |
|---|---|
column | Column |
Returns: string
Defined in: packages/knex/src/schema/DatabaseTable.ts:133
getPropertyType#
â–¸ PrivategetPropertyType(namingStrategy: NamingStrategy, schemaHelper: SchemaHelper, column: Column, defaultType?: string): string
Parameters:#
| Name | Type | Default value |
|---|---|---|
namingStrategy | NamingStrategy | - |
schemaHelper | SchemaHelper | - |
column | Column | - |
defaultType | string | 'string' |
Returns: string
Defined in: packages/knex/src/schema/DatabaseTable.ts:143
getReferenceType#
â–¸ PrivategetReferenceType(column: Column): ReferenceType
Parameters:#
| Name | Type |
|---|---|
column | Column |
Returns: ReferenceType
Defined in: packages/knex/src/schema/DatabaseTable.ts:121
init#
â–¸ init(cols: Column[], indexes: Index[], pks: string[], fks: Dictionary<ForeignKey>, enums: Dictionary<string[]>): void
Parameters:#
| Name | Type |
|---|---|
cols | Column[] |
indexes | Index[] |
pks | string[] |
fks | Dictionary<ForeignKey> |
enums | Dictionary<string[]> |
Returns: void
Defined in: packages/knex/src/schema/DatabaseTable.ts:35