Class RTreeIndexExtension

RTreeIndex extension

Hierarchy

BaseExtension
- RTreeIndexExtension

Index

Constructors

constructor

new RTreeIndexExtension(geoPackage: GeoPackage): RTreeIndexExtension
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns RTreeIndexExtension
Overrides BaseExtension.constructor
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:118

Properties

`Protected` connection

connection: GeoPackageConnection = null

Connection

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` DEFINITION

DEFINITION: "http://www.geopackage.org/spec/#extension_rtree" = 'http://www.geopackage.org/spec/#extension_rtree'

Extension definition URL

`Static` `Readonly` EXTENSION_NAME

EXTENSION_NAME: string = ...

Extension name

Methods

`Protected` _executeSQL

_executeSQL(sql: string): void
Execute the SQL statement
Parameters
- sql: string
  
  SQL statement
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:840

create

create(tableName: string, geometryColumnName: string, idColumnName: string): Extensions
Create the RTree Index extension for the feature table, geometry column, and id column. Creates the SQL functions, loads the tree, and creates the triggers.

Returns
extension
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns Extensions
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:253

createAllFunctions

createAllFunctions(): void
Create all connection SQL Functions for min x, max x, min y, max y, and is empty

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:291

createAllTriggers

createAllTriggers(tableName: string, geometryColumnName: string, idColumnName: string): void
Create Triggers to Maintain Spatial Index Values
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:461

createAllTriggersWithFeatureTable

createAllTriggersWithFeatureTable(featureTable: FeatureTable): void
Create Triggers to Maintain Spatial Index Values
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:446

createDeleteTrigger

createDeleteTrigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create delete trigger

Conditions: Row deleted Actions : Remove record from rtree for old
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:558

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

createFunctions

createFunctions(): boolean
Check if the GeoPackage has the RTree extension and create the functions if needed

Returns
true if has extension and functions created

Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:221

createFunctionsWithFeatureTable

createFunctionsWithFeatureTable(featureTable: FeatureTable): boolean
Check if the feature table has the RTree extension and create the functions if needed

Returns
true if has extension and functions created
Parameters
- featureTable: FeatureTable
  
  feature table
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:195

createFunctionsWithTableAndColumn

createFunctionsWithTableAndColumn(tableName: string, columnName: string): boolean
Check if the table and column has the RTree extension and create the functions if needed

Returns
true if has extension and functions created
Parameters
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:207

createInsertTrigger

createInsertTrigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create insert trigger
```
Conditions: Insertion of non-empty geometry
Actions   : Insert record into rtree
```
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:482

createIsEmptyFunction

createIsEmptyFunction(): void
Inherit Doc

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:393

createMaxXFunction

createMaxXFunction(): void
Inherit Doc

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:345

createMaxYFunction

createMaxYFunction(): void
Inherit Doc

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:377

createMinXFunction

createMinXFunction(): void
Inherit Doc

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:329

createMinYFunction

createMinYFunction(): void
Inherit Doc

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:361

createRTreeIndex

createRTreeIndex(tableName: string, geometryColumnName: string, idColumn?: string): void
Create the RTree Index Virtual Table
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- Optional idColumn: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:282

createRTreeIndexWithFeatureTable

createRTreeIndexWithFeatureTable(featureTable: FeatureTable): void
Create the RTree Index Virtual Table
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:267

createUpdate1Trigger

createUpdate1Trigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create update 1 trigger

Conditions: Update of geometry column to non-empty geometry No row ID change Actions : Update record in rtree
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:497

createUpdate2Trigger

createUpdate2Trigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create update 2 trigger

Conditions: Update of geometry column to empty geometry No row ID change Actions : Remove record from rtree
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:512

createUpdate3Trigger

createUpdate3Trigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create update 3 trigger

Conditions: Update of any column Row ID change Non-empty geometry Actions : Remove record from rtree for old Insert record into rtree for new
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:528

createUpdate4Trigger

createUpdate4Trigger(tableName: string, geometryColumnName: string, idColumnName: string): void
Create update 4 trigger

Conditions: Update of any column Row ID change Empty geometry Actions : Remove record from rtree for old and new
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:543

createWithFeatureTable

createWithFeatureTable(featureTable: FeatureTable): Extensions
Create the RTree Index extension for the feature table. Creates the SQL functions, loads the tree, and creates the triggers.

Returns
extension
Parameters
- featureTable: FeatureTable
  
  feature table
Returns Extensions
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:236

deleteAll

deleteAll(): void
Delete all RTree Index extensions. Drops the triggers, RTree tables, and deletes the extensions.

Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:632

deleteWithFeatureTable

deleteWithFeatureTable(featureTable: FeatureTable): void
Delete the RTree Index extension for the feature table. Drops the triggers, RTree table, and deletes the extension.
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:569

deleteWithTableAndGeometryColumn

deleteWithTableAndGeometryColumn(tableName: string, geometryColumnName: string): void
Delete the RTree Index extension for the table and geometry column. Drops the triggers, RTree table, and deletes the extension.
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:580

deleteWithTableName

deleteWithTableName(tableName: string): void
Delete all RTree Index extensions for the table. Drops the triggers, RTree tables, and deletes the extensions.
Parameters
- tableName: string
  
  table name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:606

drop

drop(tableName: string, geometryColumnName: string): void
Drop the the triggers and RTree table for the table and geometry column
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:662

dropAllTriggers

dropAllTriggers(tableName: string, geometryColumnName: string): void
Drop Triggers that Maintain Spatial Index Values
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:733

dropAllTriggersWithFeatureTable

dropAllTriggersWithFeatureTable(featureTable: FeatureTable): void
Drop Triggers that Maintain Spatial Index Values
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:723

dropDeleteTrigger

dropDeleteTrigger(tableName: string, geometryColumnName: string): void
Drop delete trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:798

dropInsertTrigger

dropInsertTrigger(tableName: string, geometryColumnName: string): void
Drop insert trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:748

dropRTreeIndex

dropRTreeIndex(tableName: string, geometryColumnName: string): void
Drop the RTree Index Virtual Table
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:682

dropRTreeIndexWithFeatureTable

dropRTreeIndexWithFeatureTable(featureTable: FeatureTable): void
Drop the RTree Index Virtual Table
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:672

dropTrigger

dropTrigger(tableName: string, geometryColumnName: string, triggerName: string): void
Drop the trigger for the table, geometry column, and trigger name
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- triggerName: string
  
  trigger name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:809

dropTriggers

dropTriggers(tableName: string, columnName: string): boolean
Check if the table and column has the RTree extension and if found, drop the triggers

Returns
true if dropped
Parameters
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:710

dropTriggersWithFeatureTable

dropTriggersWithFeatureTable(featureTable: FeatureTable): void
Check if the feature table has the RTree extension and if found, drop the triggers
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:698

dropUpdate1Trigger

dropUpdate1Trigger(tableName: string, geometryColumnName: string): void
Drop update 1 trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:758

dropUpdate2Trigger

dropUpdate2Trigger(tableName: string, geometryColumnName: string): void
Drop update 2 trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:768

dropUpdate3Trigger

dropUpdate3Trigger(tableName: string, geometryColumnName: string): void
Drop update 3 trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:778

dropUpdate4Trigger

dropUpdate4Trigger(tableName: string, geometryColumnName: string): void
Drop update 4 trigger
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:788

dropWithFeatureTable

dropWithFeatureTable(featureTable: FeatureTable): void
Drop the the triggers and RTree table for the feature table
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:652

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

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(tableName: string, columnName: string): Extensions
Get or create the extension

Returns
extension
Parameters
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns Extensions
Overrides BaseExtension.getOrCreate
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:138

getOrCreateWithFeatureTable

getOrCreateWithFeatureTable(featureTable: FeatureTable): Extensions
Get or create the extension

Returns
extension
Parameters
- featureTable: FeatureTable
  
  feature table
Returns Extensions
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:128

`Protected` getRTreeTable

getRTreeTable(featureTable: FeatureTable): UserCustomTable
Get the RTree Table

Returns
RTree table
Parameters
- featureTable: FeatureTable
  
  feature table
Returns UserCustomTable
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:897

getTableDao

getTableDao(featureDao: FeatureDao): RTreeIndexTableDao
Get a RTree Index Table DAO for the feature dao

Returns
RTree Index Table DAO
Parameters
- featureDao: FeatureDao
  
  feature DAO
Returns RTreeIndexTableDao
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:306

has

has(): boolean
Determine if the GeoPackage has the extension for any table

Returns
true if has extension

Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:184

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

hasExtensionWithFeatureTable

hasExtensionWithFeatureTable(featureTable: FeatureTable): boolean
Determine if the GeoPackage feature table has the extension feature table

Returns
true if has extension
Parameters
- featureTable: FeatureTable
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:152

hasExtensionWithTable

hasExtensionWithTable(tableName: string): boolean
Determine if the GeoPackage table has the extension

Returns
true if has extension
Parameters
- tableName: string
  
  table name
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:175

hasExtensionWithTableAndColumn

hasExtensionWithTableAndColumn(tableName: string, columnName: string): boolean
Determine if the GeoPackage table and column has the extension

Returns
true if has extension
Parameters
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns boolean
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:162

hasExtensions

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

loadRTreeIndex

loadRTreeIndex(tableName: string, geometryColumnName: string, idColumnName: string): void
Load the RTree Spatial Index Values
Parameters
- tableName: string
  
  table name
- geometryColumnName: string
  
  geometry column name
- idColumnName: string
  
  id column name
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:436

loadRTreeIndexWithFeatureTable

loadRTreeIndexWithFeatureTable(featureTable: FeatureTable): void
Load the RTree Spatial Index Values
Parameters
- featureTable: FeatureTable
  
  feature table
Returns void
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:422

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` getEnvelope

getEnvelope(data: GeoPackageGeometryData): GeometryEnvelope
Get or build a geometry envelope from the Geometry Data

Returns
geometry envelope
Parameters
- data: GeoPackageGeometryData
  
  geometry data
Returns GeometryEnvelope
- Defined in lib/extension/rtree/rTreeIndexExtension.ts:318

Class RTreeIndexExtension

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

Returns RTreeIndexExtension

Properties

Protected connection

extensionDefinition

extensionName

Readonly extensionsDao

Readonly geoPackage

tableName

Static Readonly DEFINITION

Static Readonly EXTENSION_NAME

Methods

Protected _executeSQL

Parameters

sql: string

Returns void

create

Returns

Parameters

tableName: string

geometryColumnName: string

idColumnName: string

Returns Extensions

createAllFunctions

Returns void

createAllTriggers

Parameters

tableName: string

geometryColumnName: string

idColumnName: string

Returns void

createAllTriggersWithFeatureTable

Parameters

featureTable: FeatureTable

Returns void

createDeleteTrigger

Parameters

tableName: string

geometryColumnName: string

idColumnName: string

Returns void

createExtension

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: string

Returns number

createFunctions

Returns

Returns boolean

createFunctionsWithFeatureTable

Returns

Parameters

featureTable: FeatureTable

Returns boolean

createFunctionsWithTableAndColumn

Returns

Parameters

tableName: string

columnName: string

Returns boolean

createInsertTrigger

Parameters

tableName: string

geometryColumnName: string

idColumnName: string

Returns void

createIsEmptyFunction

Inherit Doc

`Protected` connection

`Readonly` extensionsDao

`Readonly` geoPackage

`Static` `Readonly` DEFINITION

`Static` `Readonly` EXTENSION_NAME

`Protected` _executeSQL

`Optional` idColumn: string