Class nanoSQL

Hierarchy

nanoSQL

Implements

InanoSQLInstance

Index

Constructors

constructor

Properties

Constructors

constructor

new nanoSQL(): nanoSQL

- Defined in index.ts:98
Returns nanoSQL

Properties

dbs

dbs: object

Type declaration

[id: string]: InanoSQLDBConfig

events

events: object

Type declaration

[id: string]: object
- [eventName: string]: object
  - [path: string]: ReallySmallEvents
- Core: object
  - [path: string]: ReallySmallEvents

functions

functions: object

Type declaration

[fnName: string]: InanoSQLFunction

indexTypes

indexTypes: object

Type declaration

[type: string]: function
- - (value: any): any
  - Parameters
    - value: any
    Returns any

planetRadius

planetRadius: number = 6371

selectedDB

selectedDB: string = "nSQL_DB"

selectedTable

selectedTable: any

txs

txs: object

Type declaration

[id: string]: object[]

version

version: number = VERSION

Methods

CSVtoJSON

CSVtoJSON(csv: string, rowMap?: undefined | function): any

- Defined in index.ts:1364
Parameters
- csv: string
- Optional rowMap: undefined | function
Returns any

JSONtoCSV

JSONtoCSV(json: any[], printHeaders?: undefined | false | true, useHeaders?: string[]): string

- Defined in index.ts:1301
Parameters
- json: any[]
- Optional printHeaders: undefined | false | true
- Optional useHeaders: string[]
Returns string

_checkTTL

_checkTTL(): void

- Defined in index.ts:231
Returns void

_doAV

_doAV(AVType: "a" | "v", table: string, AVName: string, AVArgs: any): Promise<any>

- Defined in index.ts:960
Parameters
- AVType: "a" | "v"
- table: string
- AVName: string
- AVArgs: any
Returns Promise<any>

_initPeers

_initPeers(): void

- Defined in index.ts:706
Returns void

_initPlugins

_initPlugins(config: InanoSQLConfig): Promise<any>

- Defined in index.ts:306
Parameters
- config: InanoSQLConfig
Returns Promise<any>

_rebuildFKs

_rebuildFKs(): void

- Defined in index.ts:135
Returns void

_refreshEventChecker

_refreshEventChecker(): InanoSQLInstance

- Defined in index.ts:936
Returns InanoSQLInstance

_saveTableIds

_saveTableIds(databaseID: string): Promise<any>

- Defined in index.ts:378
Parameters
- databaseID: string
Returns Promise<any>

clearCache

clearCache(id: string): boolean

- Defined in index.ts:196
Parameters
- id: string
Returns boolean

clearTTL

clearTTL(primaryKey: any): Promise<any>

- Defined in index.ts:202
Parameters
- primaryKey: any
Returns Promise<any>

connect

connect(config?: InanoSQLConfig): Promise<any>

- Defined in index.ts:457
Parameters
- Default value config: InanoSQLConfig = {}
Returns Promise<any>

createDatabase

createDatabase(config?: InanoSQLConfig): Promise<any>

- Defined in index.ts:418
Parameters
- Optional config: InanoSQLConfig
Returns Promise<any>

csvToArray

csvToArray(text: string): any[]

- Defined in index.ts:1341
Parameters
- text: string
Returns any[]

default

default(databaseID: string | undefined, replaceObj?: any, table?: undefined | string): object | Error

- Defined in index.ts:1090
Parameters
- databaseID: string | undefined
- Optional replaceObj: any
- Optional table: undefined | string
Returns object | Error

disconnect

disconnect(dbID?: undefined | string): Promise<Object>

- Defined in index.ts:1254
Parameters
- Optional dbID: undefined | string
Returns Promise<Object>

doAction

doAction(actionName: string, actionArgs: any): Promise<any>

- Defined in index.ts:956
Parameters
- actionName: string
- actionArgs: any
Returns Promise<any>

doFilter

doFilter<T>(databaseID: string | undefined, filterName: string, args: T, complete: function, cancelled: function): void

- Defined in index.ts:165
Type parameters
- T
Parameters
- databaseID: string | undefined
- filterName: string
- args: T
- complete: function
  - - (result: T): void
    - Parameters
      - result: T
      Returns void
- cancelled: function
  - - (abortInfo: any): void
    - Parameters
      - abortInfo: any
      Returns void
Returns void

dropDatabase

dropDatabase(id: string): Promise<any>

- Defined in index.ts:426
Parameters
- id: string
Returns Promise<any>

every

every(args: object): number[]

- Defined in index.ts:798
Parameters
- args: object
  - Optional every?: undefined | number
  - length: number
  - Optional offset?: undefined | number
Returns number[]

expires

expires(primaryKey: any): Promise<any>

- Defined in index.ts:212
Parameters
- primaryKey: any
Returns Promise<any>

extend

extend(scope: string, ...args: any[]): any | nanoSQL

- Defined in index.ts:1270
Parameters
- scope: string
- Rest ...args: any[]
Returns any | nanoSQL

getCache

getCache(id: string, args?: undefined | object): any[]

- Defined in index.ts:185
Parameters
- id: string
- Optional args: undefined | object
Returns any[]

getDB

getDB(id?: undefined | string): InanoSQLDBConfig

- Defined in index.ts:127
Parameters
- Optional id: undefined | string
Returns InanoSQLDBConfig

getPeers

getPeers(): any

- Defined in index.ts:302
Returns any

getView

getView(viewName: string, viewArgs: any): Promise<any>

- Defined in index.ts:951
Parameters
- viewName: string
- viewArgs: any
Returns Promise<any>

listDatabases

listDatabases(): string[]

- Defined in index.ts:422
Returns string[]

loadCSV

loadCSV(csvString: string, rowMap?: undefined | function, onProgress?: undefined | function, parallel?: undefined | false | true): Promise<any[]>

- Defined in index.ts:1408
Parameters
- csvString: string
- Optional rowMap: undefined | function
- Optional onProgress: undefined | function
- Optional parallel: undefined | false | true
Returns Promise<any[]>

loadJS

loadJS(rows: object[], onProgress?: undefined | function, parallel?: undefined | false | true): Promise<any[]>

- Defined in index.ts:1276
Parameters
- rows: object[]
- Optional onProgress: undefined | function
- Optional parallel: undefined | false | true
Returns Promise<any[]>

maybeCreateEventObject

maybeCreateEventObject(id: string): void

- Defined in index.ts:446
Parameters
- id: string
Returns void

off

off(action: string, callBack: function, selectTable?: undefined | string): void

- Defined in index.ts:875
Parameters
- action: string
- callBack: function
  - - (event: InanoSQLDatabaseEvent): void
    - Parameters
      - event: InanoSQLDatabaseEvent
      Returns void
- Optional selectTable: undefined | string
Returns void

on

on(action: string, callBack: function, selectTable?: undefined | string): void

- Defined in index.ts:814
Parameters
- action: string
- callBack: function
  - - (event: InanoSQLDatabaseEvent): void
    - Parameters
      - event: InanoSQLDatabaseEvent
      Returns void
- Optional selectTable: undefined | string
Returns void

presetQuery

presetQuery(fn: string, args?: any): InanoSQLQueryBuilder

- Defined in index.ts:390
Parameters
- fn: string
- Optional args: any
Returns InanoSQLQueryBuilder

query

query(action: string | function, args?: any): InanoSQLQueryBuilder

- Defined in index.ts:987
Parameters
- action: string | function
- Optional args: any
Returns InanoSQLQueryBuilder

rawDump

rawDump(tables: string[], indexes: boolean, onRow: function): Promise<any>

- Defined in index.ts:1173
Parameters
- tables: string[]
- indexes: boolean
- onRow: function
  - - (table: string, row: object): void
    - Parameters
      - table: string
      - row: object
        
        [key: string]: any
      Returns void
Returns Promise<any>

rawImport

rawImport(tables: object, indexes: boolean, onProgress?: undefined | function): Promise<any>

- Defined in index.ts:1195
Parameters
- tables: object
  - [table: string]: object[]
- indexes: boolean
- Optional onProgress: undefined | function
Returns Promise<any>

saveCount

saveCount(databaseID: string, tableName: string, complete?: undefined | function): void

- Defined in index.ts:1057
Parameters
- databaseID: string
- tableName: string
- Optional complete: undefined | function
Returns void

selectTable

selectTable(table?: string | any[] | function): InanoSQLInstance

- Defined in index.ts:295
Parameters
- Optional table: string | any[] | function
Returns InanoSQLInstance

triggerEvent

triggerEvent(databaseID: string | undefined, eventData: InanoSQLDatabaseEvent, ignoreStarTable?: undefined | false | true): InanoSQLInstance

- Defined in index.ts:1019
Parameters
- databaseID: string | undefined
- eventData: InanoSQLDatabaseEvent
- Optional ignoreStarTable: undefined | false | true
Returns InanoSQLInstance

triggerQuery

triggerQuery(databaseID: string | undefined, query: InanoSQLQuery, onRow: function, complete: function, error: function): void

- Defined in index.ts:997
Parameters
- databaseID: string | undefined
- query: InanoSQLQuery
- onRow: function
  - - (row: any): void
    - Parameters
      - row: any
      Returns void
- complete: function
  - - (): void
    - Returns void
- error: function
  - - (err: string): void
    - Parameters
      - err: string
      Returns void
Returns void

useDatabase

useDatabase(id: string): InanoSQLInstance

- Defined in index.ts:413
Parameters
- id: string
Returns InanoSQLInstance

Generated using TypeDoc