db | metaphasejs

db.js API Documentation: http://kripken.github.io/sql.js/documentation/#http://kripken.github.io/sql.js/documentation/class/Database.html

Database instance

type: {SQL} Global variable created by 'sql.js'

Hierarchy

db

Index

Methods

Methods

close

close(): void

- Defined in orm/database.ts:85
Returns void

constructor

constructor(data: number[]): void

- Defined in orm/database.ts:23
Open a new database either by creating a new one or opening an existing one, stored in the byte array passed in first argument

Parameters
- data: number[]
Returns void

create_function

create_function(name: string, fn: Function): void

- Defined in orm/database.ts:87
Parameters
- name: string
- fn: Function
Returns void

each

each(sqlQuery: string, callback: Function, done: Function, params?: any | any[]): db

- Defined in orm/database.ts:83
Parameters
- sqlQuery: string
- callback: Function
- done: Function
- Optional params: any | any[]
Returns db

exec

exec(sqlQuery: string): Array<object>

- Defined in orm/database.ts:81
Parameters
- sqlQuery: string
Returns Array<object>

execQuery

execQuery(query: QueryBuilder | string): Object[]

- Defined in orm/database.ts:45
Execute a query against database and returns an array of objects It wraps db.exec()

Parameters
- query: QueryBuilder | string
  
  object
Returns Object[]

List of models

export

export(): Uint8Array

- Defined in orm/database.ts:84
Returns Uint8Array

getIdLastRecordInserted

getIdLastRecordInserted(): number

- Defined in orm/database.ts:78
Get id of last record inserted in database

Returns number

getResults

getResults(statement: any): Object[]

- Defined in orm/database.ts:52
Get the results from a query and transform them into a list of POJOs

Parameters
- statement: any
  
  Prepared SQL statement
Returns Object[]

getRowsModified

getRowsModified(): number

- Defined in orm/database.ts:86
Returns number

getSchema

getSchema(): Object[]

- Defined in orm/database.ts:72
Get DDL (Data Definition Language) queries Useful for debugging purposes

Returns Object[]

hasTable

hasTable(tableName: string): boolean

- Defined in orm/database.ts:59
Check whether a table exists in the database

Parameters
- tableName: string
Returns boolean

integrityCheck

integrityCheck(): Object[]

- Defined in orm/database.ts:65
Check databse integrity (for posible errors and corruption)

Returns Object[]

with integrity info

prepare

prepare(sqlQuery: string, params?: any | any[]): Object

- Defined in orm/database.ts:82
Parameters
- sqlQuery: string
- Optional params: any | any[]
Returns Object

run

run(sqlQuery: string, params?: any | any[]): db

- Defined in orm/database.ts:80
Parameters
- sqlQuery: string
- Optional params: any | any[]
Returns db

runQuery

runQuery(query: QueryBuilder | string): any

- Defined in orm/database.ts:37
Runs a database query that can be created by the query builder or by a sql query string. It does not return a list of results. It returns a "db" database object for fn chaining It wraps db.run()

Parameters
- query: QueryBuilder | string
Returns any

setDatabase

setDatabase(database: db): void

- Defined in orm/database.ts:29
Set DB created from external file

Parameters
- database: db
Returns void

Generated using TypeDoc