Class SimpleAttributesTableMetadata

Simple Attributes Table Metadata for defining table creation information

Hierarchy

UserTableMetadata<UserCustomColumn>
- SimpleAttributesTableMetadata

Constructors

constructor

new SimpleAttributesTableMetadata(): SimpleAttributesTableMetadata
Constructor

Returns SimpleAttributesTableMetadata
Overrides UserTableMetadata.constructor
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:81
new SimpleAttributesTableMetadata(tableName: string, idColumnName: string, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Constructor
Parameters
- tableName: string
  
  table name
- idColumnName: string
  
  id column name
- columns: UserCustomColumn[]
  
  columns
Returns SimpleAttributesTableMetadata
Overrides UserTableMetadata<UserCustomColumn>.constructor
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:89
new SimpleAttributesTableMetadata(tableName: string, idColumnName: string, autoincrement: boolean, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Constructor
Parameters
- tableName: string
  
  table name
- idColumnName: string
  
  id column name
- autoincrement: boolean
  
  autoincrement ids
- columns: UserCustomColumn[]
  
  columns
Returns SimpleAttributesTableMetadata
Overrides UserTableMetadata<UserCustomColumn>.constructor
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:98

Properties

`Protected` additionalColumns

additionalColumns: UserCustomColumn[]

Additional table columns

`Protected` autoincrement

autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT

ID autoincrement flag

`Protected` columns

columns: UserCustomColumn[]

Table columns

`Protected` dataType

dataType: string

Data type

`Protected` idColumnName

idColumnName: string

ID column name

`Protected` tableName

tableName: string

Table name

Methods

buildColumns

buildColumns(): UserCustomColumn[]
Build the table columns

Returns
table columns

Returns UserCustomColumn[]
Overrides UserTableMetadata.buildColumns
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:128

getAdditionalColumns

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

Returns
columns

Returns UserCustomColumn[]
Inherited from UserTableMetadata.getAdditionalColumns
- Defined in lib/user/userTableMetadata.ts:143

getColumns

getColumns(): UserCustomColumn[]
Get the table columns

Returns
columns

Returns UserCustomColumn[]
Inherited from UserTableMetadata.getColumns
- Defined in lib/user/userTableMetadata.ts:162

getDataType

getDataType(): string
Get the data type

Returns
data type

Returns string
Inherited from UserTableMetadata.getDataType
- Defined in lib/user/userTableMetadata.ts:86

getDefaultDataType

getDefaultDataType(): string
Get the default data type

Returns
default data type

Returns string
Overrides UserTableMetadata.getDefaultDataType
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:121

getIdColumnName

getIdColumnName(): string
Get the id column name

Returns
id column name

Returns string
Inherited from UserTableMetadata.getIdColumnName
- Defined in lib/user/userTableMetadata.ts:105

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from UserTableMetadata.getTableName
- Defined in lib/user/userTableMetadata.ts:67

isAutoincrement

isAutoincrement(): boolean
Is id autocincrement enabled?

Returns
autoincrement flag

Returns boolean
Inherited from UserTableMetadata.isAutoincrement
- Defined in lib/user/userTableMetadata.ts:124

setAdditionalColumns

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

setAutoincrement

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

setColumns

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

setDataType

setDataType(dataType: string): void
Set the data type
Parameters
- dataType: string
  
  data type
Returns void
Inherited from UserTableMetadata.setDataType
- 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
Inherited from UserTableMetadata.setIdColumnName
- Defined in lib/user/userTableMetadata.ts:115

setTableName

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

`Static` create

create(): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata

Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:9
create(tableName: string): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:10
create(tableName: string, autoincrement: boolean): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
- autoincrement: boolean
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:11
create(tableName: string, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
- columns: UserCustomColumn[]
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:12
create(tableName: string, autoincrement: boolean, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
- autoincrement: boolean
- columns: UserCustomColumn[]
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:13
create(tableName: string, idColumnName: string, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
- idColumnName: string
- columns: UserCustomColumn[]
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:18
create(tableName: string, idColumnName: string, autoincrement: boolean, columns: UserCustomColumn[]): SimpleAttributesTableMetadata
Create metadata

Returns
SimpleAttributesTableMetadata
Parameters
- tableName: string
- idColumnName: string
- autoincrement: boolean
- columns: UserCustomColumn[]
Returns SimpleAttributesTableMetadata
- Defined in lib/extension/related/simple/simpleAttributesTableMetadata.ts:23

Class SimpleAttributesTableMetadata

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SimpleAttributesTableMetadata

Parameters

tableName: string

idColumnName: string

columns: UserCustomColumn[]

Returns SimpleAttributesTableMetadata

Parameters

tableName: string

idColumnName: string

autoincrement: boolean

columns: UserCustomColumn[]

Returns SimpleAttributesTableMetadata

Properties

Protected additionalColumns

Protected autoincrement

Protected columns

Protected dataType

Protected idColumnName

Protected tableName

Methods

buildColumns

Returns

Returns UserCustomColumn[]

getAdditionalColumns

Returns

Returns UserCustomColumn[]

getColumns

Returns

Returns UserCustomColumn[]

getDataType

Returns

Returns string

getDefaultDataType

Returns

Returns string

getIdColumnName

Returns

Returns string

getTableName

Returns

Returns string

isAutoincrement

Returns

Returns boolean

setAdditionalColumns

Parameters

additionalColumns: UserCustomColumn[]

Returns void

setAutoincrement

Parameters

autoincrement: boolean

Returns void

setColumns

Parameters

columns: UserCustomColumn[]

Returns void

setDataType

Parameters

dataType: string

Returns void

setIdColumnName

Parameters

idColumnName: string

Returns void

setTableName

Parameters

tableName: string

Returns void

Static create

Returns

Returns SimpleAttributesTableMetadata

Returns

`Protected` additionalColumns

`Protected` autoincrement

`Protected` columns

`Protected` dataType

`Protected` idColumnName

`Protected` tableName

`Static` create