Class UserColumns<TColumn>`Abstract`

Type Parameters

TColumn extends UserColumn

Hierarchy

UserColumns

Constructors

`Protected` constructor

new UserColumns<TColumn>(tableName: string, columns: TColumn[], custom: boolean): UserColumns<TColumn>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
Parameters
- tableName: string
  
  table name
- columns: TColumn[]
  
  columns
- custom: boolean
  
  custom column specification
Returns UserColumns<TColumn>
- Defined in lib/user/userColumns.ts:58
new UserColumns<TColumn>(userColumns: UserColumns<TColumn>): UserColumns<TColumn>
Copy Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
Parameters
- userColumns: UserColumns<TColumn>
  
  user columns
Returns UserColumns<TColumn>
- Defined in lib/user/userColumns.ts:66

Methods

addColumn

addColumn(column: TColumn): void
Add a new column
Parameters
- column: TColumn
  
  new column
Returns void
- Defined in lib/user/userColumns.ts:446

alterColumn

alterColumn(column: TColumn): void
Alter a column
Parameters
- column: TColumn
  
  altered column
Returns void
- Defined in lib/user/userColumns.ts:510

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
- Defined in lib/user/userColumns.ts:361

columnsOfType

columnsOfType(type: GeoPackageDataType): TColumn[]
Get the columns with the provided data type

Returns
columns
Parameters
- type: GeoPackageDataType
  
  data type
Returns TColumn[]
- Defined in lib/user/userColumns.ts:438

`Abstract` copy

copy(): UserColumns<TColumn>
Copy the user columns

Returns
copied user columns

Returns UserColumns<TColumn>
- Defined in lib/user/userColumns.ts:100

dropColumn

dropColumn(column: TColumn): void
Drop a column
Parameters
- column: TColumn
  
  column to drop
Returns void
- Defined in lib/user/userColumns.ts:484

dropColumnWithIndex

dropColumnWithIndex(index: number): void
Drop a column
Parameters
- index: number
  
  column index
Returns void
- Defined in lib/user/userColumns.ts:500

dropColumnWithName

dropColumnWithName(columnName: string): void
Drop a column
Parameters
- columnName: string
  
  column name
Returns void
- Defined in lib/user/userColumns.ts:492

duplicateCheck

duplicateCheck(index: number, previousIndex: number, column: string): void
Check for duplicate column names
Parameters
- index: number
  
  index
- previousIndex: number
  
  previous index
- column: string
  
  column
Returns void
- Defined in lib/user/userColumns.ts:225

getColumn

getColumn(columnName: string): TColumn
Get the column of the column name

Returns
column
Parameters
- columnName: string
  
  column name
Returns TColumn
- Defined in lib/user/userColumns.ts:344

getColumnForIndex

getColumnForIndex(index: number): TColumn
Get the column at the index

Returns
column
Parameters
- index: number
  
  column index
Returns TColumn
- Defined in lib/user/userColumns.ts:335

getColumnIndex

getColumnIndex(columnName: string, required: boolean): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
- required: boolean
  
  column existence is required
Returns number
- Defined in lib/user/userColumns.ts:287

getColumnIndexForColumnName

getColumnIndexForColumnName(columnName: string): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
- Defined in lib/user/userColumns.ts:277

getColumnName

getColumnName(index: number): string
Get the column name at the index

Returns
column name
Parameters
- index: number
  
  column index
Returns string
- Defined in lib/user/userColumns.ts:318

getColumnNames

getColumnNames(): string[]
Get the array of column names

Returns
column names

Returns string[]
- Defined in lib/user/userColumns.ts:309

getColumns

getColumns(): TColumn[]
Get the list of columns

Returns
columns

Returns TColumn[]
- Defined in lib/user/userColumns.ts:326

getPkColumn

getPkColumn(): TColumn
Get the primary key column

Returns
primary key column

Returns TColumn
- Defined in lib/user/userColumns.ts:417

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
- Defined in lib/user/userColumns.ts:409

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
- Defined in lib/user/userColumns.ts:429

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
- Defined in lib/user/userColumns.ts:369

hasColumn

hasColumn(columnName: string): boolean
Check if the table has the column

Returns
true if has the column
Parameters
- columnName: string
  
  column name
Returns boolean
- Defined in lib/user/userColumns.ts:353

hasPkColumn

hasPkColumn(): boolean
Check if the table has a primary key column

Returns
true if has a primary key

Returns boolean
- Defined in lib/user/userColumns.ts:401

isCustom

isCustom(): boolean
Is custom column specification (partial and/or ordering)

Returns
custom flag

Returns boolean
- Defined in lib/user/userColumns.ts:385

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
- Defined in lib/user/userColumns.ts:185

isValueValidation

isValueValidation(): boolean
Is value validation against column types enabled

Returns
true if values are validated against column types

Returns boolean
- Defined in lib/user/userColumns.ts:204

missingCheck

missingCheck(index: number, column: string): void
Check for missing columns
Parameters
- index: number
  
  column index
- column: string
  
  user column
Returns void
- Defined in lib/user/userColumns.ts:266

renameColumn

renameColumn(column: TColumn, newColumnName: string): void
Rename a column
Parameters
- column: TColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userColumns.ts:456

renameColumnWithIndex

renameColumnWithIndex(index: number, newColumnName: string): void
Rename a column
Parameters
- index: number
  
  column index
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userColumns.ts:475

renameColumnWithName

renameColumnWithName(columnName: string, newColumnName: string): void
Rename a column
Parameters
- columnName: string
  
  column name
- newColumnName: string
  
  new column name
Returns void
- Defined in lib/user/userColumns.ts:466

setCustom

setCustom(custom: boolean): void
Set the custom column specification flag
Parameters
- custom: boolean
  
  custom flag
Returns void
- Defined in lib/user/userColumns.ts:393

setPkModifiable

setPkModifiable(pkModifiable: boolean): void
Set if the primary key can be modified
Parameters
- pkModifiable: boolean
  
  primary key modifiable flag
Returns void
- Defined in lib/user/userColumns.ts:195

setTableName

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

setValueValidation

setValueValidation(valueValidation: boolean): void
Set if values should validated against column types
Parameters
- valueValidation: boolean
  
  value validation flag
Returns void
- Defined in lib/user/userColumns.ts:214

typeCheck

typeCheck(expected: GeoPackageDataType, column: TColumn): void
Check for the expected data type
Parameters
- expected: GeoPackageDataType
  
  expected data type
- column: TColumn
  
  user column
Returns void
- Defined in lib/user/userColumns.ts:245

updateColumns

updateColumns(): void
Update the table columns

Returns void
- Defined in lib/user/userColumns.ts:105

Class UserColumns<TColumn>Abstract

Type Parameters

TColumn extends UserColumn

Hierarchy

Index

Constructors

Methods

Constructors

Protected constructor

Type Parameters

TColumn extends UserColumn<TColumn>

Parameters

tableName: string

columns: TColumn[]

custom: boolean

Returns UserColumns<TColumn>

Type Parameters

TColumn extends UserColumn<TColumn>

Parameters

userColumns: UserColumns<TColumn>

Returns UserColumns<TColumn>

Methods

addColumn

Parameters

column: TColumn

Returns void

alterColumn

Parameters

column: TColumn

Returns void

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns TColumn[]

Abstract copy

Returns

Returns UserColumns<TColumn>

dropColumn

Parameters

column: TColumn

Returns void

dropColumnWithIndex

Parameters

index: number

Returns void

dropColumnWithName

Parameters

columnName: string

Returns void

duplicateCheck

Parameters

index: number

previousIndex: number

column: string

Returns void

getColumn

Returns

Parameters

columnName: string

Returns TColumn

getColumnForIndex

Returns

Parameters

index: number

Returns TColumn

getColumnIndex

Returns

Parameters

columnName: string

required: boolean

Returns number

getColumnIndexForColumnName

Returns

Parameters

columnName: string

Returns number

Class UserColumns<TColumn>`Abstract`

`Protected` constructor

`Abstract` copy