Class SchemaExtension

SchemaExtension

Hierarchy

BaseExtension
- SchemaExtension

Constructors

constructor

new SchemaExtension(geoPackage: GeoPackage): SchemaExtension
Parameters
- geoPackage: GeoPackage
Returns SchemaExtension
Overrides BaseExtension.constructor
- Defined in lib/extension/schema/schemaExtension.ts:21

Properties

`Protected` `Readonly` connection

connection: GeoPackageConnection

Connection to the GeoPackage

extensionDefinition

extensionDefinition: string

Definition for the extension

extensionName

extensionName: string

Name of the extension

`Readonly` extensionsDao

extensionsDao: ExtensionsDao

ExtensionDao

`Readonly` geoPackage

geoPackage: GeoPackage

GeoPackage

tableName

tableName: string

extension table name

`Static` `Readonly` EXTENSION_NAME

EXTENSION_NAME: string = ...

`Static` `Readonly` EXTENSION_SCHEMA_AUTHOR

EXTENSION_SCHEMA_AUTHOR: string = 'gpkg'

`Static` `Readonly` EXTENSION_SCHEMA_DEFINITION

EXTENSION_SCHEMA_DEFINITION: string = 'http://www.geopackage.org/spec/#extension_schema'

`Static` `Readonly` EXTENSION_SCHEMA_NAME_NO_AUTHOR

EXTENSION_SCHEMA_NAME_NO_AUTHOR: string = 'schema'

Methods

createDataColumnConstraintsTable

createDataColumnConstraintsTable(): boolean
Create the Data Column Constraints table if it does not already exist

Returns
true if created

Returns boolean
- Defined in lib/extension/schema/schemaExtension.ts:120

createDataColumnsTable

createDataColumnsTable(): boolean
Create the Data Columns table if it does not already exist

Returns
true if created

Returns boolean
- Defined in lib/extension/schema/schemaExtension.ts:84

createExtension

createExtension(extensionName: string, tableName: string, columnName: string, definition: string, scopeType: string): number
Create the extension
Parameters
- extensionName: string
- tableName: string
- columnName: string
- definition: string
- scopeType: string
Returns number
Inherited from BaseExtension.createExtension
- Defined in lib/extension/baseExtension.ts:168

get

get(extensionName: string, tableName?: string, columnName?: string): Extensions
Get the extension for the name, table name and column name

Returns
Parameters
- extensionName: string
  
  extension name
- Optional tableName: string
  
  table name
- Optional columnName: string
  
  column name
Returns Extensions
Inherited from BaseExtension.get
- Defined in lib/extension/baseExtension.ts:110

getDataColumnConstraintsDao

getDataColumnConstraintsDao(): DataColumnConstraintsDao
Get a Data Column Constraints DAO

Returns
Data Column Constraints DAO

Returns DataColumnConstraintsDao
- Defined in lib/extension/schema/schemaExtension.ts:103

getDataColumnsDao

getDataColumnsDao(): DataColumnsDao
Get a Data Columns DAO

Returns
Data Columns DAO

Returns DataColumnsDao
- Defined in lib/extension/schema/schemaExtension.ts:67

getExtension

getExtension(extensionName: string, tableName?: string, columnName?: string): Extensions[]
Get the extension for the name, table name and column name

Returns
Parameters
- extensionName: string
  
  extension name
- Optional tableName: string
  
  table name
- Optional columnName: string
  
  column name
Returns Extensions[]
Inherited from BaseExtension.getExtension
- Defined in lib/extension/baseExtension.ts:132

getGeoPackage

getGeoPackage(): GeoPackage
Get the geopackage

Returns GeoPackage
Inherited from BaseExtension.getGeoPackage
- Defined in lib/extension/baseExtension.ts:52

getOrCreate

getOrCreate(extensionName: string, tableName: string, columnName: string, definition: string, scopeType: ExtensionScopeType): Extensions
Get the extension or create as needed

Returns
Parameters
- extensionName: string
  
  extension name
- tableName: string
  
  table name
- columnName: string
  
  column name
- definition: string
  
  extension definition
- scopeType: ExtensionScopeType
  
  extension scope type
Returns Extensions
Inherited from BaseExtension.getOrCreate
- Defined in lib/extension/baseExtension.ts:65

getOrCreateExtension

getOrCreateExtension(): Extensions[]
Returns Extensions[]
- Defined in lib/extension/schema/schemaExtension.ts:24

has

has(): boolean
Returns boolean
- Defined in lib/extension/schema/schemaExtension.ts:47

hasExtension

hasExtension(extensionName: string, tableName: string, columnName: string): boolean
Determine if the GeoPackage has the extension

Returns
if the extension exists
Parameters
- extensionName: string
  
  extension name
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns boolean
Inherited from BaseExtension.hasExtension
- Defined in lib/extension/baseExtension.ts:145

hasExtensions

hasExtensions(extensionName: string): boolean
Parameters
- extensionName: string
Returns boolean
Inherited from BaseExtension.hasExtensions
- Defined in lib/extension/baseExtension.ts:149

removeExtension

removeExtension(): void
Returns void
- Defined in lib/extension/schema/schemaExtension.ts:51

verifyWritable

verifyWritable(): void
Verify the GeoPackage is writable and throw an exception if it is not

Returns void
Inherited from BaseExtension.verifyWritable
- Defined in lib/extension/baseExtension.ts:156

`Static` getDataColumnConstraintsDao

getDataColumnConstraintsDao(geoPackage: GeoPackage): DataColumnConstraintsDao
Get a Data Column Constraints DAO

Returns
Data Column Constraints DAO
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns DataColumnConstraintsDao
- Defined in lib/extension/schema/schemaExtension.ts:112

`Static` getDataColumnsDao

getDataColumnsDao(geoPackage: GeoPackage): DataColumnsDao
Get a Data Columns DAO

Returns
Data Columns DAO
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns DataColumnsDao
- Defined in lib/extension/schema/schemaExtension.ts:76

Class SchemaExtension

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

Returns SchemaExtension

Properties

Protected Readonly connection

extensionDefinition

extensionName

Readonly extensionsDao

Readonly geoPackage

tableName

Static Readonly EXTENSION_NAME

Static Readonly EXTENSION_SCHEMA_AUTHOR

Static Readonly EXTENSION_SCHEMA_DEFINITION

Static Readonly EXTENSION_SCHEMA_NAME_NO_AUTHOR

Methods

createDataColumnConstraintsTable

Returns

Returns boolean

createDataColumnsTable

Returns

Returns boolean

createExtension

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: string

Returns number

get

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions

getDataColumnConstraintsDao

Returns

Returns DataColumnConstraintsDao

getDataColumnsDao

Returns

Returns DataColumnsDao

getExtension

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions[]

getGeoPackage

Returns GeoPackage

getOrCreate

Returns

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: ExtensionScopeType

Returns Extensions

getOrCreateExtension

Returns Extensions[]

has

Returns boolean

hasExtension

Returns

Parameters

extensionName: string

tableName: string

columnName: string

Returns boolean

hasExtensions

`Protected` `Readonly` connection

`Readonly` extensionsDao

`Readonly` geoPackage

`Static` `Readonly` EXTENSION_NAME

`Static` `Readonly` EXTENSION_SCHEMA_AUTHOR

`Static` `Readonly` EXTENSION_SCHEMA_DEFINITION

`Static` `Readonly` EXTENSION_SCHEMA_NAME_NO_AUTHOR

`Optional` tableName: string

`Optional` columnName: string

`Optional` tableName: string

`Optional` columnName: string

`Static` getDataColumnConstraintsDao

`Static` getDataColumnsDao