Class UserTable<TColumn>`Abstract`

UserTable models optional user data tables in a [GeoPackage]GeoPackage.

Param

table name

Param

user columns

Param

required columns

Type Parameters

TColumn extends UserColumn

Hierarchy

UserTable

Index

Constructors

Properties

columns constraints contents DEFAULT_AUTOINCREMENT DEFAULT_PK_NOT_NULL

Constructors

constructor

new UserTable<TColumn>(columns: UserColumns<TColumn>): UserTable<TColumn>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
Parameters
- columns: UserColumns<TColumn>
  
  columns
Returns UserTable<TColumn>
- Defined in lib/user/userTable.ts:48
new UserTable<TColumn>(userTable: UserTable<TColumn>): UserTable<TColumn>
Constructor
Type Parameters
- TColumn extends UserColumn<TColumn>
Parameters
- userTable: UserTable<TColumn>
  
  UserTable
Returns UserTable<TColumn>
- Defined in lib/user/userTable.ts:54

Properties

columns

columns: UserColumns<TColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents

contents: Contents

Foreign key to Contents

`Static` DEFAULT_AUTOINCREMENT

DEFAULT_AUTOINCREMENT: boolean = true

Default id autoincrement setting

`Static` DEFAULT_PK_NOT_NULL

DEFAULT_PK_NOT_NULL: boolean = true

Default primary key not null setting

Methods

addColumn

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

addConstraint

addConstraint(constraint: Constraint): void
Add constraint
Parameters
- constraint: Constraint
  
  constraint
Returns void
- Defined in lib/user/userTable.ts:273

addConstraints

addConstraints(constraints: Constraint[]): void
Add constraints
Parameters
- constraints: Constraint[]
  
  constraints
Returns void
- Defined in lib/user/userTable.ts:283

addConstraintsWithConstraints

addConstraintsWithConstraints(constraints: Constraints): void
Add constraints
Parameters
- constraints: Constraints
  
  constraints
Returns void
- Defined in lib/user/userTable.ts:293

alterColumn

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

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

Returns Constraint[]
- Defined in lib/user/userTable.ts:342

clearConstraintsByType

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

Returns
cleared constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
- Defined in lib/user/userTable.ts:353

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
- Defined in lib/user/userTable.ts:208

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/userTable.ts:364

`Abstract` copy

copy(): UserTable<TColumn>
Copy the table

Returns
copied table

Returns UserTable<TColumn>
- Defined in lib/user/userTable.ts:78

`Abstract` createUserColumns

createUserColumns(columns: TColumn[]): UserColumns<TColumn>
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columns: TColumn[]
  
  columns
Returns UserColumns<TColumn>
- Defined in lib/user/userTable.ts:108

createUserColumnsFromColumnNames

createUserColumnsFromColumnNames(columnNames: string[]): UserColumns<TColumn>
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columnNames: string[]
  
  column names
Returns UserColumns<TColumn>
- Defined in lib/user/userTable.ts:115

dropColumn

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

dropColumnWithIndex

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

dropColumnWithName

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

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

getColumnForIndex

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

Returns
column
Parameters
- index: number
  
  column index
Returns TColumn
- Defined in lib/user/userTable.ts:179

getColumnIndex

getColumnIndex(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/userTable.ts:132

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/userTable.ts:149

getColumnNames

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

Returns
column names

Returns string[]
- Defined in lib/user/userTable.ts:140

getColumns

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

Returns
columns

Returns TColumn[]
- Defined in lib/user/userTable.ts:157

getColumnsForColumnNames

getColumnsForColumnNames(columnNames: string[]): TColumn[]
Get the columns from the column names

Returns
columns
Parameters
- columnNames: string[]
  
  column names
Returns TColumn[]
- Defined in lib/user/userTable.ts:166

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
- Defined in lib/user/userTable.ts:322

getConstraintsByType

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

Returns
constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
- Defined in lib/user/userTable.ts:333

getContents

getContents(): Contents
Get the contents

Returns
contents

Returns Contents
- Defined in lib/user/userTable.ts:373

`Abstract` getDataType

getDataType(): string
Get the contents data type

Returns
data type

Returns string
- Defined in lib/user/userTable.ts:84

`Protected` getDataTypeOrDefault

getDataTypeOrDefault(defaultType: string): string
Get the contents data type from the contents or use the default

Returns
contents or default data type
Parameters
- defaultType: string
  
  default data type
Returns string
- Defined in lib/user/userTable.ts:92

getPkColumn

getPkColumn(): TColumn
Get the primary key column

Returns
primary key column

Returns TColumn
- Defined in lib/user/userTable.ts:254

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
- Defined in lib/user/userTable.ts:245

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
- Defined in lib/user/userTable.ts:263

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
- Defined in lib/user/userTable.ts:217

getUserColumns

getUserColumns(): UserColumns<TColumn>
Get the user columns

Returns
user columns

Returns UserColumns<TColumn>
- Defined in lib/user/userTable.ts:123

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/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
- Defined in lib/user/userTable.ts:302

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
- Defined in lib/user/userTable.ts:313

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/userTable.ts:236

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
- Defined in lib/user/userTable.ts:403

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/userTable.ts:422

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/userTable.ts:454

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/userTable.ts:478

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/userTable.ts:466

setContents

setContents(contents: Contents): void
Set the contents
Parameters
- contents: Contents
  
  contents
Returns void
- Defined in lib/user/userTable.ts:383

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/userTable.ts:413

setTableName

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

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/userTable.ts:432

`Protected` validateContents

validateContents(contents: Contents): void
Validate that the set contents are valid
Parameters
- contents: Contents
  
  contents
Returns void
- Defined in lib/user/userTable.ts:396

Generated using TypeDoc