Class AttributesTableMetadata

Attributes Table Metadata for defining table creation information

Hierarchy

UserTableMetadata<AttributesColumn>
- AttributesTableMetadata

Constructors

constructor

new AttributesTableMetadata(tableName?: string, additionalColumns?: AttributesColumn[], idColumnName?: string, dataType?: string, constraints?: Constraints, autoincrement?: boolean): AttributesTableMetadata
Constructor
Parameters
- Optional tableName: string
  
  table name
- Optional additionalColumns: AttributesColumn[]
  
  additional columns
- Optional idColumnName: string
  
  id column name
- Optional dataType: string
  
  data type
- Optional constraints: Constraints
  
  constraints
- Optional autoincrement: boolean
  
  autoincrement ids
Returns AttributesTableMetadata
Overrides UserTableMetadata.constructor
- Defined in lib/attributes/attributesTableMetadata.ts:167

Properties

`Protected` additionalColumns

additionalColumns: AttributesColumn[]

Additional table columns

`Protected` autoincrement

autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT

ID autoincrement flag

`Protected` columns

columns: AttributesColumn[]

Table columns

`Protected` constraints

constraints: Constraints

Constraints

`Protected` dataType

dataType: string

Data type

`Protected` idColumnName

idColumnName: string

ID column name

`Protected` tableName

tableName: string

Table name

`Static` `Readonly` DEFAULT_DATA_TYPE

DEFAULT_DATA_TYPE: string = ...

Default data type

Methods

buildColumns

buildColumns(): AttributesColumn[]
Build the table columns

Returns
table columns

Returns AttributesColumn[]
Overrides UserTableMetadata.buildColumns
- Defined in lib/attributes/attributesTableMetadata.ts:195

getAdditionalColumns

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

Returns
columns

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

getColumns

getColumns(): AttributesColumn[]
Get the table columns

Returns
columns

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

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
- Defined in lib/attributes/attributesTableMetadata.ts:213

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/attributes/attributesTableMetadata.ts:188

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: AttributesColumn[]): void
Set the additional table columns
Parameters
- additionalColumns: AttributesColumn[]
  
  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: AttributesColumn[]): void
Set the table columns
Parameters
- columns: AttributesColumn[]
  
  columns
Returns void
Inherited from UserTableMetadata.setColumns
- Defined in lib/user/userTableMetadata.ts:172

setConstraints

setConstraints(constraints: Constraints): void
Set the constraints
Parameters
- constraints: Constraints
Returns void
- Defined in lib/attributes/attributesTableMetadata.ts:221

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(tableName?: string, additionalColumns?: AttributesColumn[], constraints?: Constraints, idColumnName?: string, autoincrement?: boolean): AttributesTableMetadata
Constructor

Returns
metadata
Parameters
- Optional tableName: string
  
  table name
- Optional additionalColumns: AttributesColumn[]
  
  additional columns
- Optional constraints: Constraints
- Optional idColumnName: string
  
  id column name
- Optional autoincrement: boolean
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:26

`Static` createTyped

createTyped(dataType?: string, tableName?: string, idColumnName?: string, additionalColumns?: AttributesColumn[], constraints?: Constraints, autoincrement?: boolean): AttributesTableMetadata
Create metadata

Returns
metadata
Parameters
- Optional dataType: string
  
  data type
- Optional tableName: string
  
  table name
- Optional idColumnName: string
  
  id column name
- Optional additionalColumns: AttributesColumn[]
  
  additional columns
- Optional constraints: Constraints
  
  constraints
- Optional autoincrement: boolean
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:85

`Static` createTypedWithColumnsAndConstraints

createTypedWithColumnsAndConstraints(dataType: string, columns: AttributesColumns, constraints?: Constraints, autoincrement?: boolean): AttributesTableMetadata
Create metadata

Returns
metadata
Parameters
- dataType: string
  
  data type
- columns: AttributesColumns
  
  columns
- Optional constraints: Constraints
  
  constraints
- autoincrement: boolean = false
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:112

`Static` createTypedWithTable

createTypedWithTable(dataType: string, table: AttributesTable, autoincrement?: boolean): AttributesTableMetadata
Create metadata

Returns
metadata
Parameters
- dataType: string
  
  data type
- table: AttributesTable
  
  attributes table
- autoincrement: boolean = false
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:138

`Static` createWithColumnsAndConstraints

createWithColumnsAndConstraints(columns: AttributesColumns, constraints: Constraints, autoincrement?: boolean): AttributesTableMetadata
Constructor

Returns
metadata
Parameters
- columns: AttributesColumns
  
  columns
- constraints: Constraints
  
  constraints
- autoincrement: boolean = false
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:43

`Static` createWithTable

createWithTable(table: AttributesTable, autoincrement?: boolean): AttributesTableMetadata
Create metadata

Returns
metadata
Parameters
- table: AttributesTable
  
  attributes table
- autoincrement: boolean = false
  
  autoincrement ids
Returns AttributesTableMetadata
- Defined in lib/attributes/attributesTableMetadata.ts:64

Class AttributesTableMetadata

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional tableName: string

Optional additionalColumns: AttributesColumn[]

Optional idColumnName: string

Optional dataType: string

Optional constraints: Constraints

Optional autoincrement: boolean

Returns AttributesTableMetadata

Properties

Protected additionalColumns

Protected autoincrement

Protected columns

Protected constraints

Protected dataType

Protected idColumnName

Protected tableName

Static Readonly DEFAULT_DATA_TYPE

Methods

buildColumns

Returns

Returns AttributesColumn[]

getAdditionalColumns

Returns

Returns AttributesColumn[]

getColumns

Returns

Returns AttributesColumn[]

getConstraints

Returns

Returns Constraints

getDataType

Returns

Returns string

getDefaultDataType

Returns

Returns string

getIdColumnName

Returns

Returns string

getTableName

Returns

Returns string

isAutoincrement

Returns

Returns boolean

setAdditionalColumns

Parameters

additionalColumns: AttributesColumn[]

Returns void

setAutoincrement

Parameters

autoincrement: boolean

Returns void

setColumns

Parameters

columns: AttributesColumn[]

Returns void

setConstraints

Parameters

constraints: Constraints

Returns void

setDataType

Parameters

dataType: string

Returns void

setIdColumnName

Parameters

idColumnName: string

Returns void

setTableName

Parameters

tableName: string

`Optional` tableName: string

`Optional` additionalColumns: AttributesColumn[]

`Optional` idColumnName: string

`Optional` dataType: string

`Optional` constraints: Constraints

`Optional` autoincrement: boolean

`Protected` additionalColumns

`Protected` autoincrement

`Protected` columns

`Protected` constraints

`Protected` dataType

`Protected` idColumnName

`Protected` tableName

`Static` `Readonly` DEFAULT_DATA_TYPE

`Static` create

`Optional` tableName: string

`Optional` additionalColumns: AttributesColumn[]

`Optional` constraints: Constraints

`Optional` idColumnName: string

`Optional` autoincrement: boolean

`Static` createTyped

`Optional` dataType: string

`Optional` tableName: string

`Optional` idColumnName: string

`Optional` additionalColumns: AttributesColumn[]

`Optional` constraints: Constraints

`Optional` autoincrement: boolean

`Static` createTypedWithColumnsAndConstraints

`Optional` constraints: Constraints

`Static` createTypedWithTable

`Static` createWithColumnsAndConstraints

`Static` createWithTable