Class UserCustomColumn

Create a new user custom columnd

Param

column index

Param

column name

Param

data type

Param

max value

Param

not null

Param

default value or nil

Param

primary key

Param

autoincrement

Hierarchy

UserColumn
- UserCustomColumn

Index

Constructors

`Protected` constructor

new UserCustomColumn(index: number, name: string, dataType: GeoPackageDataType, max: number, notNull: boolean, defaultValue: any, primaryKey: boolean, autoincrement: boolean): UserCustomColumn
Constructor
Parameters
- index: number
  
  column index
- name: string
  
  column name
- dataType: GeoPackageDataType
  
  data type
- max: number
  
  max value
- notNull: boolean
  
  not null flag
- defaultValue: any
  
  default value
- primaryKey: boolean
  
  primary key flag
- autoincrement: boolean
  
  autoincrement flag
Returns UserCustomColumn
Inherited from UserColumn.constructor
- Defined in lib/user/userColumn.ts:113
new UserCustomColumn(index: number, name: string, type: string, dataType: GeoPackageDataType, max: number, notNull: boolean, defaultValue: any, primaryKey: boolean, autoincrement: boolean): UserCustomColumn
Constructor
Parameters
- index: number
  
  column index
- name: string
  
  column name
- type: string
  
  string type
- dataType: GeoPackageDataType
  
  data type
- max: number
  
  max value
- notNull: boolean
  
  not null flag
- defaultValue: any
  
  default value
- primaryKey: boolean
  
  primary key flag
- autoincrement: boolean
  
  autoincrement flag
Returns UserCustomColumn
Inherited from UserColumn.constructor
- Defined in lib/user/userColumn.ts:136
new UserCustomColumn(tableColumn: TableColumn): UserCustomColumn
Constructor
Parameters
- tableColumn: TableColumn
  
  table column
Returns UserCustomColumn
Inherited from UserColumn.constructor
- Defined in lib/user/userColumn.ts:154
new UserCustomColumn(userColumn: UserColumn): UserCustomColumn
Constructor
Parameters
- userColumn: UserColumn
Returns UserCustomColumn
Inherited from UserColumn.constructor
- Defined in lib/user/userColumn.ts:155

Properties

`Static` `Readonly` AUTOINCREMENT_CONSTRAINT_ORDER

AUTOINCREMENT_CONSTRAINT_ORDER: 4 = 4

Autoincrement Constraint Order

`Static` `Readonly` DEFAULT_VALUE_CONSTRAINT_ORDER

DEFAULT_VALUE_CONSTRAINT_ORDER: 2 = 2

Default Value Constraint Order

`Static` `Readonly` NOT_NULL_CONSTRAINT_ORDER

NOT_NULL_CONSTRAINT_ORDER: 1 = 1

Not Null Constraint Order

`Static` `Readonly` NO_INDEX

NO_INDEX: -1 = -1

User Column index value

`Static` `Readonly` PRIMARY_KEY_CONSTRAINT_ORDER

PRIMARY_KEY_CONSTRAINT_ORDER: 3 = 3

Primary Key Constraint Order

`Static` `Readonly` UNIQUE_CONSTRAINT_ORDER

UNIQUE_CONSTRAINT_ORDER: 5 = 5

Unique Constraint Order

Methods

addAutoincrementConstraint

addAutoincrementConstraint(): void
Add an autoincrement constraint

Returns void
Inherited from UserColumn.addAutoincrementConstraint
- Defined in lib/user/userColumn.ts:823

addConstraint

addConstraint(constraint: Constraint): void
Add a constraint
Parameters
- constraint: Constraint
  
  constraint
Returns void
Inherited from UserColumn.addConstraint
- Defined in lib/user/userColumn.ts:658

addConstraintFrom

addConstraintFrom(type: ConstraintType, constraint: string, order?: number): void
Add a constraint
Parameters
- type: ConstraintType
  
  constraint type
- constraint: string
  
  constraint
- order: number = null
  
  constraint order
Returns void
Inherited from UserColumn.addConstraintFrom
- Defined in lib/user/userColumn.ts:734

addConstraintSql

addConstraintSql(constraint: string): void
Add a constraint
Parameters
- constraint: string
  
  constraint
Returns void
Inherited from UserColumn.addConstraintSql
- Defined in lib/user/userColumn.ts:718

addConstraints

addConstraints(constraints: Constraints): void
Add constraints
Parameters
- constraints: Constraints
  
  constraints
Returns void
Inherited from UserColumn.addConstraints
- Defined in lib/user/userColumn.ts:767

addConstraintsArray

addConstraintsArray(constraints: Constraint[]): void
Add constraints
Parameters
- constraints: Constraint[]
  
  constraints
Returns void
Inherited from UserColumn.addConstraintsArray
- Defined in lib/user/userColumn.ts:744

addConstraintsFromColumnConstraints

addConstraintsFromColumnConstraints(constraints: ColumnConstraints): void
Add constraints
Parameters
- constraints: ColumnConstraints
  
  constraints
Returns void
Inherited from UserColumn.addConstraintsFromColumnConstraints
- Defined in lib/user/userColumn.ts:756

addDefaultConstraints

addDefaultConstraints(): void
Add the default constraints that are enabled (not null, default value, primary key) from the column properties

Returns void
Inherited from UserColumn.addDefaultConstraints
- Defined in lib/user/userColumn.ts:637

addDefaultValueConstraint

addDefaultValueConstraint(defaultValue: any): void
Add a default value constraint
Parameters
- defaultValue: any
  
  default value
Returns void
Inherited from UserColumn.addDefaultValueConstraint
- Defined in lib/user/userColumn.ts:791

addNotNullConstraint

addNotNullConstraint(): void
Add a not null constraint

Returns void
Inherited from UserColumn.addNotNullConstraint
- Defined in lib/user/userColumn.ts:774

addPrimaryKeyConstraint

addPrimaryKeyConstraint(): void
Add a primary key constraint

Returns void
Inherited from UserColumn.addPrimaryKeyConstraint
- Defined in lib/user/userColumn.ts:809

addUniqueConstraint

addUniqueConstraint(): void
Add a unique constraint

Returns void
Inherited from UserColumn.addUniqueConstraint
- Defined in lib/user/userColumn.ts:837

buildConstraintSql

buildConstraintSql(constraint: Constraint): string
Build the SQL for the constraint

Returns
SQL or null
Parameters
- constraint: Constraint
  
  constraint
Returns string
Inherited from UserColumn.buildConstraintSql
- Defined in lib/user/userColumn.ts:856

clearConstraints

clearConstraints(reset?: boolean): Constraint[]
Clear the constraints

Returns
cleared constraints
Parameters
- reset: boolean = true
  
  true to reset constraint settings
Returns Constraint[]
Inherited from UserColumn.clearConstraints
- Defined in lib/user/userColumn.ts:591

clearConstraintsForType

clearConstraintsForType(type: ConstraintType): Constraint[]
Clear the constraints of the provided type

Returns
cleared constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from UserColumn.clearConstraintsForType
- Defined in lib/user/userColumn.ts:610

compareTo

compareTo(another: UserColumn): number
Comparison function that sorts user columns by index
Parameters
- another: UserColumn
Returns number
Inherited from UserColumn.compareTo
- Defined in lib/user/userColumn.ts:867

copy

copy(): UserCustomColumn
Copy the column

Returns
copied column

Returns UserCustomColumn
Overrides UserColumn.copy
- Defined in lib/user/custom/userCustomColumn.ts:119

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
Inherited from UserColumn.getConstraints
- Defined in lib/user/userColumn.ts:569

getConstraintsForType

getConstraintsForType(type: ConstraintType): Constraint[]
Get the constraints of the provided type

Returns
constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from UserColumn.getConstraintsForType
- Defined in lib/user/userColumn.ts:581

getDataType

getDataType(): GeoPackageDataType
Get the data type

Returns
data type

Returns GeoPackageDataType
Inherited from UserColumn.getDataType
- Defined in lib/user/userColumn.ts:521

getDefaultValue

getDefaultValue(): any
Get the default value

Returns
default value

Returns any
Inherited from UserColumn.getDefaultValue
- Defined in lib/user/userColumn.ts:423

getIndex

getIndex(): number
Get the index

Returns
index

Returns number
Inherited from UserColumn.getIndex
- Defined in lib/user/userColumn.ts:305

getMax

getMax(): number
Get the max

Returns
max

Returns number
Inherited from UserColumn.getMax
- Defined in lib/user/userColumn.ts:364

getName

getName(): string
Get the name

Returns
name

Returns string
Inherited from UserColumn.getName
- Defined in lib/user/userColumn.ts:324

getType

getType(): string
Get the database type

Returns
type

Returns string
Inherited from UserColumn.getType
- Defined in lib/user/userColumn.ts:540

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from UserColumn.hasConstraints
- Defined in lib/user/userColumn.ts:549

hasConstraintsForType

hasConstraintsForType(type: ConstraintType): boolean
Check if has constraints of the provided type

Returns
true if has constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns boolean
Inherited from UserColumn.hasConstraintsForType
- Defined in lib/user/userColumn.ts:560

hasDefaultValue

hasDefaultValue(): boolean
Determine if the column has a default value

Returns
true if has default value

Returns boolean
Inherited from UserColumn.hasDefaultValue
- Defined in lib/user/userColumn.ts:400

hasIndex

hasIndex(): boolean
Check if the column has a valid index

Returns
true if has a valid index

Returns boolean
Inherited from UserColumn.hasIndex
- Defined in lib/user/userColumn.ts:264

hasMax

hasMax(): boolean
Determine if the column has a max value

Returns
true if has max value

Returns boolean
Inherited from UserColumn.hasMax
- Defined in lib/user/userColumn.ts:344

isAutoincrement

isAutoincrement(): boolean
Get the autoincrement flag

Returns
autoincrement flag

Returns boolean
Inherited from UserColumn.isAutoincrement
- Defined in lib/user/userColumn.ts:476

isNamed

isNamed(name: string): boolean
Determine if this column is named the provided name

Returns
true if named the provided name
Parameters
- name: string
  
  column name
Returns boolean
Inherited from UserColumn.isNamed
- Defined in lib/user/userColumn.ts:335

isNotNull

isNotNull(): boolean
Get the is not null flag

Returns
not null flag

Returns boolean
Inherited from UserColumn.isNotNull
- Defined in lib/user/userColumn.ts:391

isPrimaryKey

isPrimaryKey(): boolean
Get the primary key flag

Returns
primary key flag

Returns boolean
Inherited from UserColumn.isPrimaryKey
- Defined in lib/user/userColumn.ts:450

isUnique

isUnique(): boolean
Get the unique flag

Returns
unique flag

Returns boolean
Inherited from UserColumn.isUnique
- Defined in lib/user/userColumn.ts:502

removeAutoincrementConstraint

removeAutoincrementConstraint(): void
Remove an autoincrement constraint

Returns void
Inherited from UserColumn.removeAutoincrementConstraint
- Defined in lib/user/userColumn.ts:830

removeDefaultValueConstraint

removeDefaultValueConstraint(): void
Remove a default value constraint

Returns void
Inherited from UserColumn.removeDefaultValueConstraint
- Defined in lib/user/userColumn.ts:802

removeNotNullConstraint

removeNotNullConstraint(): void
Remove a not null constraint

Returns void
Inherited from UserColumn.removeNotNullConstraint
- Defined in lib/user/userColumn.ts:781

removePrimaryKeyConstraint

removePrimaryKeyConstraint(): void
Remove a primary key constraint

Returns void
Inherited from UserColumn.removePrimaryKeyConstraint
- Defined in lib/user/userColumn.ts:816

removeUniqueConstraint

removeUniqueConstraint(): void
Remove a unique constraint

Returns void
Inherited from UserColumn.removeUniqueConstraint
- Defined in lib/user/userColumn.ts:844

resetIndex

resetIndex(): void
Reset the column index

Returns void
Inherited from UserColumn.resetIndex
- Defined in lib/user/userColumn.ts:296

setAutoincrement

setAutoincrement(autoincrement: boolean): void
Set the autoincrement flag
Parameters
- autoincrement: boolean
  
  autoincrement flag
Returns void
Inherited from UserColumn.setAutoincrement
- Defined in lib/user/userColumn.ts:460

setConstraintOrder

setConstraintOrder(constraint: Constraint): void
Set the constraint order by constraint type
Parameters
- constraint: Constraint
  
  constraint
Returns void
Inherited from UserColumn.setConstraintOrder
- Defined in lib/user/userColumn.ts:690

setDataType

setDataType(dataType: GeoPackageDataType): void
Set the data type
Parameters
- dataType: GeoPackageDataType
  
  data type
Returns void
Inherited from UserColumn.setDataType
- Defined in lib/user/userColumn.ts:512

setDefaultValue

setDefaultValue(defaultValue: any): void
Set the default value
Parameters
- defaultValue: any
  
  default value
Returns void
Inherited from UserColumn.setDefaultValue
- Defined in lib/user/userColumn.ts:410

setIndex

setIndex(index: number): void
Set the column index. Only allowed when #hasIndex() is false ( #getIndex() is #NO_INDEX). Setting a valid index to an existing valid index does nothing.
Parameters
- index: number
  
  column index
Returns void
Inherited from UserColumn.setIndex
- Defined in lib/user/userColumn.ts:276

setMax

setMax(max: number): void
Set the max
Parameters
- max: number
  
  max
Returns void
Inherited from UserColumn.setMax
- Defined in lib/user/userColumn.ts:355

setName

setName(name: string): void
Set the name
Parameters
- name: string
  
  column name
Returns void
Inherited from UserColumn.setName
- Defined in lib/user/userColumn.ts:315

setNotNull

setNotNull(notNull: boolean): void
Set the not null flag
Parameters
- notNull: boolean
  
  not null flag
Returns void
Inherited from UserColumn.setNotNull
- Defined in lib/user/userColumn.ts:375

setPrimaryKey

setPrimaryKey(primaryKey: boolean): void
Set the primary key flag
Parameters
- primaryKey: boolean
  
  primary key flag
Returns void
Inherited from UserColumn.setPrimaryKey
- Defined in lib/user/userColumn.ts:433

setType

setType(type: string): void
Set the database type
Parameters
- type: string
  
  database type
Returns void
Inherited from UserColumn.setType
- Defined in lib/user/userColumn.ts:531

setUnique

setUnique(unique: boolean): void
Set the unique flag
Parameters
- unique: boolean
  
  unique flag
Returns void
Inherited from UserColumn.setUnique
- Defined in lib/user/userColumn.ts:486

`Static` createColumn

createColumn(name: string, type: GeoPackageDataType, notNull??: boolean, defaultValue?: DBValue, max?: number, autoincrement?: boolean): UserCustomColumn
Create a new column

Returns
created column
Parameters
- name: string
  
  column name
- type: GeoPackageDataType
  
  data type
- Optional notNull: boolean = false
  
  not null
- Optional defaultValue: DBValue
  
  default value or nil
- Optional max: number
  
  max value
- Optional autoincrement: boolean
  
  autoincrement or nil
Returns UserCustomColumn
- Defined in lib/user/custom/userCustomColumn.ts:31

`Static` createColumnWithIndex

createColumnWithIndex(index?: number, name: string, type: GeoPackageDataType, notNull??: boolean, defaultValue?: DBValue, max?: number, autoincrement?: boolean): UserCustomColumn
Create a new column with a specified column index

Returns
created column
Parameters
- index: number = UserCustomColumn.NO_INDEX
  
  column index
- name: string
  
  column name
- type: GeoPackageDataType
  
  data type
- Optional notNull: boolean = false
  
  not null
- Optional defaultValue: DBValue
  
  default value or nil
- Optional max: number
  
  max value
- Optional autoincrement: boolean
  
  autoincrement or nil
Returns UserCustomColumn
- Defined in lib/user/custom/userCustomColumn.ts:63

`Static` createColumnWithTableColumn

createColumnWithTableColumn(tableColumn: TableColumn): UserCustomColumn
Create a new column

Returns
user custom column
Parameters
- tableColumn: TableColumn
  
  table column
Returns UserCustomColumn
- Defined in lib/user/custom/userCustomColumn.ts:115

`Static` createPrimaryKeyColumn

createPrimaryKeyColumn(name: string, autoincrement?: boolean): UserCustomColumn
Create a new primary key column
Parameters
- name: string
- autoincrement: boolean = UserTableDefaults.DEFAULT_AUTOINCREMENT
Returns UserCustomColumn
- Defined in lib/user/custom/userCustomColumn.ts:80

`Static` createPrimaryKeyColumnWithIndex

createPrimaryKeyColumnWithIndex(index?: number, name: string, autoincrement?: boolean): UserCustomColumn
Create a new primary key column with a specified column index
Parameters
- index: number = UserCustomColumn.NO_INDEX
- name: string
- autoincrement: boolean = UserTableDefaults.DEFAULT_AUTOINCREMENT
Returns UserCustomColumn
- Defined in lib/user/custom/userCustomColumn.ts:93

`Static` `Protected` getTypeName

getTypeName(name: string, dataType: GeoPackageDataType): string
Get the type name from the data type

Returns
type name
Parameters
- name: string
  
  column name
- dataType: GeoPackageDataType
  
  data type
Returns string
Inherited from UserColumn.getTypeName
- Defined in lib/user/userColumn.ts:232

`Static` `Protected` validateDataType

validateDataType(name: string, dataType: GeoPackageDataType): void
Validate the data type
Parameters
- name: string
  
  column name
- dataType: GeoPackageDataType
  
  data type
Returns void
Inherited from UserColumn.validateDataType
- Defined in lib/user/userColumn.ts:246

Class UserCustomColumn

Param

Param

Param

Param

Param

Param

Param

Param

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

index: number

name: string

dataType: GeoPackageDataType

max: number

notNull: boolean

defaultValue: any

primaryKey: boolean

autoincrement: boolean

Returns UserCustomColumn

Parameters

index: number

name: string

type: string

dataType: GeoPackageDataType

max: number

notNull: boolean

defaultValue: any

primaryKey: boolean

autoincrement: boolean

Returns UserCustomColumn

Parameters

tableColumn: TableColumn

Returns UserCustomColumn

Parameters

userColumn: UserColumn

Returns UserCustomColumn

Properties

Static Readonly AUTOINCREMENT_CONSTRAINT_ORDER

Static Readonly DEFAULT_VALUE_CONSTRAINT_ORDER

Static Readonly NOT_NULL_CONSTRAINT_ORDER

Static Readonly NO_INDEX

Static Readonly PRIMARY_KEY_CONSTRAINT_ORDER

Static Readonly UNIQUE_CONSTRAINT_ORDER

Methods

addAutoincrementConstraint

Returns void

addConstraint

Parameters

constraint: Constraint

Returns void

addConstraintFrom

Parameters

type: ConstraintType

constraint: string

order: number = null

Returns void

addConstraintSql

Parameters

constraint: string

Returns void

addConstraints

Parameters

constraints: Constraints

Returns void

addConstraintsArray

Parameters

constraints: Constraint[]

Returns void

addConstraintsFromColumnConstraints

Parameters

constraints: ColumnConstraints

Returns void

addDefaultConstraints

`Protected` constructor

`Static` `Readonly` AUTOINCREMENT_CONSTRAINT_ORDER

`Static` `Readonly` DEFAULT_VALUE_CONSTRAINT_ORDER

`Static` `Readonly` NOT_NULL_CONSTRAINT_ORDER

`Static` `Readonly` NO_INDEX

`Static` `Readonly` PRIMARY_KEY_CONSTRAINT_ORDER

`Static` `Readonly` UNIQUE_CONSTRAINT_ORDER