Class UserTableMetadata<TColumn>`Abstract`

User Table Metadata for defining table creation information

Type Parameters

TColumn extends UserColumn

user column type

Hierarchy

UserTableMetadata

Constructors

constructor

new UserTableMetadata<TColumn>(): UserTableMetadata<TColumn>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
Returns UserTableMetadata<TColumn>
- Defined in lib/user/userTableMetadata.ts:46

Properties

`Protected` additionalColumns

additionalColumns: TColumn[]

Additional table columns

`Protected` autoincrement

autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT

ID autoincrement flag

`Protected` columns

columns: TColumn[]

Table columns

`Protected` dataType

dataType: string

Data type

`Protected` idColumnName

idColumnName: string

ID column name

`Protected` tableName

tableName: string

Table name

Methods

`Abstract` buildColumns

buildColumns(): TColumn[]
Build the table columns

Returns
table columns

Returns TColumn[]
- Defined in lib/user/userTableMetadata.ts:60

getAdditionalColumns

getAdditionalColumns(): TColumn[]
Get the additional table columns

Returns
columns

Returns TColumn[]
- Defined in lib/user/userTableMetadata.ts:143

getColumns

getColumns(): TColumn[]
Get the table columns

Returns
columns

Returns TColumn[]
- Defined in lib/user/userTableMetadata.ts:162

getDataType

getDataType(): string
Get the data type

Returns
data type

Returns string
- Defined in lib/user/userTableMetadata.ts:86

`Abstract` getDefaultDataType

getDefaultDataType(): string
Get the default data type

Returns
default data type

Returns string
- Defined in lib/user/userTableMetadata.ts:53

getIdColumnName

getIdColumnName(): string
Get the id column name

Returns
id column name

Returns string
- Defined in lib/user/userTableMetadata.ts:105

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
- Defined in lib/user/userTableMetadata.ts:67

isAutoincrement

isAutoincrement(): boolean
Is id autocincrement enabled?

Returns
autoincrement flag

Returns boolean
- Defined in lib/user/userTableMetadata.ts:124

setAdditionalColumns

setAdditionalColumns(additionalColumns: TColumn[]): void
Set the additional table columns
Parameters
- additionalColumns: TColumn[]
  
  columns
Returns void
- Defined in lib/user/userTableMetadata.ts:153

setAutoincrement

setAutoincrement(autoincrement: boolean): void
Set the id autoincrement flag
Parameters
- autoincrement: boolean
  
  autoincrement flag
Returns void
- Defined in lib/user/userTableMetadata.ts:134

setColumns

setColumns(columns: TColumn[]): void
Set the table columns
Parameters
- columns: TColumn[]
  
  columns
Returns void
- Defined in lib/user/userTableMetadata.ts:172

setDataType

setDataType(dataType: string): void
Set the data type
Parameters
- dataType: string
  
  data type
Returns void
- Defined in lib/user/userTableMetadata.ts:96

setIdColumnName

setIdColumnName(idColumnName: string): void
Set the id column name
Parameters
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/user/userTableMetadata.ts:115

setTableName

setTableName(tableName: string): void
Set the table name
Parameters
- tableName: string
  
  table name
Returns void
- Defined in lib/user/userTableMetadata.ts:77

Generated using TypeDoc