Class SqljsAdapter

This adapter uses sql.js to execute queries against the GeoPackage database

See

http://kripken.github.io/sql.js/documentation/|sqljs

Hierarchy

SqljsAdapter

Implements

DBAdapter

Index

Constructors

constructor

Properties

db filePath SQL sqljsWasmLocateFile

Constructors

constructor

new SqljsAdapter(filePath?: string | Buffer | Uint8Array): SqljsAdapter
Parameters
- Optional filePath: string | Buffer | Uint8Array
  
  string path to an existing file or a path to where a new file will be created or a url from which to download a GeoPackage or a Uint8Array containing the contents of the file, if undefined, an in memory database is created
Returns SqljsAdapter
- Defined in lib/db/sqljsAdapter.ts:115

Properties

db

db: any

filePath

filePath: string | Buffer | Uint8Array

`Static` SQL

SQL: {
Database: any;
}

Type declaration

Database: any

`Static` sqljsWasmLocateFile

sqljsWasmLocateFile: ((filename: string) => string) = ...

Type declaration

- (filename: string): string
- Parameters
  - filename: string
  Returns string

Methods

all

all(sql: string, params?: Record<string, DBValue> | []): Record<string, DBValue>[]
Gets all results from the statement in an array

Returns
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns Record<string, DBValue>[]
Implementation of DBAdapter.all
- Defined in lib/db/sqljsAdapter.ts:199

bindAndInsert

bindAndInsert(statement: any, params?: Record<string, DBValue> | []): number
Runs an insert statement with the parameters provided

Returns
last inserted row id
Parameters
- statement: any
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns number
Implementation of DBAdapter.bindAndInsert
- Defined in lib/db/sqljsAdapter.ts:295

close

close(): void
Closes the connection to the GeoPackage

Returns void
Implementation of DBAdapter.close
- Defined in lib/db/sqljsAdapter.ts:130

closeStatement

closeStatement(statement: any): void
Closes a prepared statement
Parameters
- statement: any
Returns void
Implementation of DBAdapter.closeStatement
- Defined in lib/db/sqljsAdapter.ts:307

count

count(tableName: string, where?: string, whereArgs?: Record<string, DBValue> | []): number
Counts rows that match the query

Returns
count
Parameters
- tableName: string
  
  table name from which to count
- Optional where: string
  
  where clause
- Optional whereArgs: Record<string, DBValue> | []
  
  where args
Returns number
Implementation of DBAdapter.count
- Defined in lib/db/sqljsAdapter.ts:340

delete

delete(sql: string, params?: Record<string, DBValue> | []): number
Runs the specified delete statement and returns the number of deleted rows

Returns
deleted rows
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns number
Implementation of DBAdapter.delete
- Defined in lib/db/sqljsAdapter.ts:316

dropTable

dropTable(table: string): boolean
Drops the table

Returns
indicates if the table was dropped
Parameters
- table: string
  
  table name
Returns boolean
Implementation of DBAdapter.dropTable
- Defined in lib/db/sqljsAdapter.ts:328

each

each(sql: string, params?: Record<string, DBValue> | []): IterableIterator<Record<string, DBValue>>
Returns an Iterable with results from the query

Returns
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns IterableIterator<Record<string, DBValue>>
Implementation of DBAdapter.each
- Defined in lib/db/sqljsAdapter.ts:213

export

export(): Promise<Uint8Array>
Returns a Uint8Array containing the contents of the database as a file

Returns Promise<Uint8Array>
Implementation of DBAdapter.export
- Defined in lib/db/sqljsAdapter.ts:143

get

get(sql: string, params?: Record<string, DBValue> | []): Record<string, DBValue>
Gets one row of results from the statement

See
- get
- getAsObject
Returns
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  substitution parameters
Returns Record<string, DBValue>
Implementation of DBAdapter.get
- Defined in lib/db/sqljsAdapter.ts:165

getDBConnection

getDBConnection(): any
Get the connection to the database file

Returns

Returns any
Implementation of DBAdapter.getDBConnection
- Defined in lib/db/sqljsAdapter.ts:137

initialize

initialize(): Promise<SqljsAdapter>
Returns a Promise which, when resolved, returns a DBAdapter which has connected to the GeoPackage database file

Returns Promise<SqljsAdapter>
Implementation of DBAdapter.initialize
- Defined in lib/db/sqljsAdapter.ts:24

insert

insert(sql: string, params?: Record<string, DBValue> | []): number
Runs the specified insert statement and returns the last inserted id or undefined if no insert happened

Returns
last inserted row id
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns number
Implementation of DBAdapter.insert
- Defined in lib/db/sqljsAdapter.ts:266

isTableExists

isTableExists(tableName: string): boolean
Determines if a tableName exists in the database

Returns
Parameters
- tableName: string
Returns boolean
Implementation of DBAdapter.isTableExists
- Defined in lib/db/sqljsAdapter.ts:182

prepareStatement

prepareStatement(sql: string): any
Prepares a SQL statement
Parameters
- sql: string
Returns any
Implementation of DBAdapter.prepareStatement
- Defined in lib/db/sqljsAdapter.ts:286

query

query(sql: string, params?: Record<string, DBValue> | []): ResultSet
Returns a result set for the given query
Parameters
- sql: string
- Optional params: Record<string, DBValue> | []
Returns ResultSet
Implementation of DBAdapter.query
- Defined in lib/db/sqljsAdapter.ts:369

readableSize

readableSize(): string
Returns string
Implementation of DBAdapter.readableSize
- Defined in lib/db/sqljsAdapter.ts:123

registerFunction

registerFunction(name: string, functionDefinition: Function): SqljsAdapter
Registers the given function so that it can be used by SQL statements

See
create_function

Returns
this
Parameters
- name: string
  
  name of function to register
- functionDefinition: Function
  
  function to register
Returns SqljsAdapter
Implementation of DBAdapter.registerFunction
- Defined in lib/db/sqljsAdapter.ts:153

run

run(sql: string, params?: Record<string, DBValue> | []): {
changes: number;
lastInsertRowid: number;
}
Runs the statement specified, returning information about what changed

See
run

Returns
object containing a changes property indicating the number of rows changed and a lastInsertROWID indicating the last inserted row
Parameters
- sql: string
  
  statement to run
- Optional params: Record<string, DBValue> | []
  
  bind parameters
Returns {
changes: number;
lastInsertRowid: number;
}
- changes: number
- lastInsertRowid: number
Implementation of DBAdapter.run
- Defined in lib/db/sqljsAdapter.ts:243

size

size(): number
Returns number
Implementation of DBAdapter.size
- Defined in lib/db/sqljsAdapter.ts:119

transaction

transaction(func: Function): void
Parameters
- func: Function
Returns void
Implementation of DBAdapter.transaction
- Defined in lib/db/sqljsAdapter.ts:348

unsafe

unsafe(enabled: boolean): void
Enable or disable unsafe mode
Parameters
- enabled: boolean
Returns void
Implementation of DBAdapter.unsafe
- Defined in lib/db/sqljsAdapter.ts:364

`Static` setSqljsWasmLocateFile

setSqljsWasmLocateFile(locateFile: ((filename: string) => string)): void
Parameters
- locateFile: ((filename: string) => string)
  - - (filename: string): string
    - Parameters
      
      filename: string
      
      Returns string
Returns void
- Defined in lib/db/sqljsAdapter.ts:17

Class SqljsAdapter

See

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional filePath: string | Buffer | Uint8Array

Returns SqljsAdapter

Properties

db

filePath

Static SQL

Type declaration

Database: any

Static sqljsWasmLocateFile

Type declaration

Parameters

filename: string

Returns string

Methods

all

Returns

Parameters

sql: string

Optional params: Record<string, DBValue> | []

Returns Record<string, DBValue>[]

bindAndInsert

Returns

Parameters

statement: any

Optional params: Record<string, DBValue> | []

Returns number

close

Returns void

closeStatement

Parameters

statement: any

Returns void

count

Returns

Parameters

tableName: string

Optional where: string

Optional whereArgs: Record<string, DBValue> | []

Returns number

delete

Returns

Parameters

sql: string

Optional params: Record<string, DBValue> | []

Returns number

dropTable

Returns

Parameters

table: string

Returns boolean

each

Returns

Parameters

sql: string

Optional params: Record<string, DBValue> | []

Returns IterableIterator<Record<string, DBValue>>

export

Returns Promise<Uint8Array>

get

See

Returns

Parameters

sql: string

Optional params: Record<string, DBValue> | []

Returns Record<string, DBValue>

getDBConnection

Returns

Returns any

initialize

`Optional` filePath: string | Buffer | Uint8Array

`Static` SQL

`Static` sqljsWasmLocateFile

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` where: string

`Optional` whereArgs: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

`Optional` params: Record<string, DBValue> | []

Returns {
changes: number;
lastInsertRowid: number;
}

`Static` setSqljsWasmLocateFile