Class SQLite3Driver

The SQLite3 Nymph database driver.

Hierarchy

default
- SQLite3Driver

Constructors

constructor

new SQLite3Driver(config, store?): SQLite3Driver
Parameters
- config: Partial<SQLite3DriverConfig>
- Optional store: InternalStore
Returns SQLite3Driver
Overrides NymphDriver.constructor
- Defined in driver-sqlite3/src/SQLite3Driver.ts:54

Properties

config

config: SQLite3DriverConfig

`Protected` entityCache

entityCache: {
    [k: string]: {
        cdate: number;
        data: EntityData;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    };
}

Type declaration

[k: string]: {
    cdate: number;
    data: EntityData;
    mdate: number;
    sdata: SerializedEntityData;
    tags: string[];
}
- cdate: number
- data: EntityData
- mdate: number
- sdata: SerializedEntityData
- tags: string[]

`Protected` entityCount

entityCount: {
[k: string]: number;
}

Type declaration

[k: string]: number

`Protected` nymph

nymph: default

`Protected` prefix

prefix: string

`Protected` store

store: InternalStore

Methods

`Private` _connect

_connect(write): void
Parameters
- write: boolean
Returns void
- Defined in driver-sqlite3/src/SQLite3Driver.ts:93

checkData

checkData(data, sdata, selectors, guid?, tags?): boolean
Parameters
- data: EntityData
- sdata: SerializedEntityData
- selectors: Selector[]
- Optional guid: null | string
- Optional tags: null | string[]
Returns boolean
Inherited from NymphDriver.checkData
- Defined in nymph/dist/driver/NymphDriver.d.ts:58

`Protected` cleanCache

cleanCache(guid): void
Parameters
- guid: string
Returns void
Inherited from NymphDriver.cleanCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:59

clone

clone(): SQLite3Driver
This is used internally by Nymph. Don't call it yourself.

Returns SQLite3Driver
A clone of this instance.
Overrides NymphDriver.clone
- Defined in driver-sqlite3/src/SQLite3Driver.ts:73

commit

commit(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.commit
- Defined in driver-sqlite3/src/SQLite3Driver.ts:452

connect

connect(): Promise<boolean>
Connect to the SQLite3 database.

Returns Promise<boolean>
Whether this instance is connected to a SQLite3 database.
Overrides NymphDriver.connect
- Defined in driver-sqlite3/src/SQLite3Driver.ts:82

`Private` createTables

createTables(etype?): boolean
Create entity tables in the database.
Parameters
- etype: null | string = null
  
  The entity type to create a table for. If this is blank, the default tables are created.
Returns boolean
- Defined in driver-sqlite3/src/SQLite3Driver.ts:222

deleteEntity

deleteEntity(entity): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
Inherited from NymphDriver.deleteEntity
- Defined in nymph/dist/driver/NymphDriver.d.ts:60

deleteEntityByID

deleteEntityByID(guid, className?): Promise<boolean>
Parameters
- guid: string
- Optional className: null | string | EntityConstructor
Returns Promise<boolean>
Overrides NymphDriver.deleteEntityByID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:477

deleteUID

deleteUID(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.deleteUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:547

disconnect

disconnect(): Promise<false>
Disconnect from the SQLite3 database.

Returns Promise<false>
Whether this instance is connected to a SQLite3 database.
Overrides NymphDriver.disconnect
- Defined in driver-sqlite3/src/SQLite3Driver.ts:187

`Protected` entityReferenceSearch

entityReferenceSearch(value, entity): boolean
Parameters
- value: any
- entity: string | EntityInterface | EntityReference | (string | EntityInterface | EntityReference)[]
Returns boolean
Inherited from NymphDriver.entityReferenceSearch
- Defined in nymph/dist/driver/NymphDriver.d.ts:61

export

export(filename): Promise<boolean>
Parameters
- filename: string
Returns Promise<boolean>
Inherited from NymphDriver.export
- Defined in nymph/dist/driver/NymphDriver.d.ts:55

`Protected` exportEntities

exportEntities(writeLine): Promise<void>
Parameters
- writeLine: ((line) => void)
  - - (line): void
    - Parameters
      
      line: string
      
      Returns void
Returns Promise<void>
Overrides NymphDriver.exportEntities
- Defined in driver-sqlite3/src/SQLite3Driver.ts:566

exportPrint

exportPrint(): Promise<boolean>
Returns Promise<boolean>
Inherited from NymphDriver.exportPrint
- Defined in nymph/dist/driver/NymphDriver.d.ts:56

`Protected` findReferences

findReferences(svalue): string[]
Parameters
- svalue: string
Returns string[]
Inherited from NymphDriver.findReferences
- Defined in nymph/dist/driver/NymphDriver.d.ts:127

formatSelectors

formatSelectors(selectors, options?): {
qrefs: [Options, ...FormattedSelector[]][];
selectors: FormattedSelector[];
}
Parameters
- selectors: Selector[]
- Optional options: Options
Returns {
qrefs: [Options, ...FormattedSelector[]][];
selectors: FormattedSelector[];
}
- qrefs: [Options, ...FormattedSelector[]][]
- selectors: FormattedSelector[]
Inherited from NymphDriver.formatSelectors
- Defined in nymph/dist/driver/NymphDriver.d.ts:62

`Protected` getEntitesRowLike

getEntitesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => number | Error);
result: any;
}
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- selectors: Selector[]
- performQueryCallback: ((options, formattedSelectors, etype) => {
  result: any;
  })
  - - (options, formattedSelectors, etype): {
      result: any;
      }
    - Parameters
      
      options: Options<T>
      
      formattedSelectors: FormattedSelector[]
      
      etype: string
      
      Returns {
      result: any;
      }
      
      result: any
- rowFetchCallback: (() => any)
  - - (): any
    - Returns any
- freeResultCallback: (() => void)
  - - (): void
    - Returns void
- getCountCallback: ((row) => number)
  - - (row): number
    - Parameters
      
      row: any
      
      Returns number
- getGUIDCallback: ((row) => string)
  - - (row): string
    - Parameters
      
      row: any
      
      Returns string
- getTagsAndDatesCallback: ((row) => {
      cdate: number;
      mdate: number;
      tags: string[];
  })
  - - (row): {
          cdate: number;
          mdate: number;
          tags: string[];
      }
    - Parameters
      
      row: any
      
      Returns {
          cdate: number;
          mdate: number;
          tags: string[];
      }
      
      cdate: number
      
      mdate: number
      
      tags: string[]
- getDataNameAndSValueCallback: ((row) => {
  name: string;
  svalue: string;
  })
  - - (row): {
      name: string;
      svalue: string;
      }
    - Parameters
      
      row: any
      
      Returns {
      name: string;
      svalue: string;
      }
      
      name: string
      
      svalue: string
Returns {
process: (() => number | Error);
result: any;
}
- process: (() => number | Error)
  - - (): number | Error
    - Returns number | Error
- result: any
Inherited from NymphDriver.getEntitesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:81
getEntitesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => string[] | Error);
result: any;
}
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- selectors: Selector[]
- performQueryCallback: ((options, formattedSelectors, etype) => {
  result: any;
  })
  - - (options, formattedSelectors, etype): {
      result: any;
      }
    - Parameters
      
      options: Options<T>
      
      formattedSelectors: FormattedSelector[]
      
      etype: string
      
      Returns {
      result: any;
      }
      
      result: any
- rowFetchCallback: (() => any)
  - - (): any
    - Returns any
- freeResultCallback: (() => void)
  - - (): void
    - Returns void
- getCountCallback: ((row) => number)
  - - (row): number
    - Parameters
      
      row: any
      
      Returns number
- getGUIDCallback: ((row) => string)
  - - (row): string
    - Parameters
      
      row: any
      
      Returns string
- getTagsAndDatesCallback: ((row) => {
      cdate: number;
      mdate: number;
      tags: string[];
  })
  - - (row): {
          cdate: number;
          mdate: number;
          tags: string[];
      }
    - Parameters
      
      row: any
      
      Returns {
          cdate: number;
          mdate: number;
          tags: string[];
      }
      
      cdate: number
      
      mdate: number
      
      tags: string[]
- getDataNameAndSValueCallback: ((row) => {
  name: string;
  svalue: string;
  })
  - - (row): {
      name: string;
      svalue: string;
      }
    - Parameters
      
      row: any
      
      Returns {
      name: string;
      svalue: string;
      }
      
      name: string
      
      svalue: string
Returns {
process: (() => string[] | Error);
result: any;
}
- process: (() => string[] | Error)
  - - (): string[] | Error
    - Returns string[] | Error
- result: any
Inherited from NymphDriver.getEntitesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:96
getEntitesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => Error | ReturnType<T["factorySync"]>[]);
result: any;
}
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- selectors: Selector[]
- performQueryCallback: ((options, formattedSelectors, etype) => {
  result: any;
  })
  - - (options, formattedSelectors, etype): {
      result: any;
      }
    - Parameters
      
      options: Options<T>
      
      formattedSelectors: FormattedSelector[]
      
      etype: string
      
      Returns {
      result: any;
      }
      
      result: any
- rowFetchCallback: (() => any)
  - - (): any
    - Returns any
- freeResultCallback: (() => void)
  - - (): void
    - Returns void
- getCountCallback: ((row) => number)
  - - (row): number
    - Parameters
      
      row: any
      
      Returns number
- getGUIDCallback: ((row) => string)
  - - (row): string
    - Parameters
      
      row: any
      
      Returns string
- getTagsAndDatesCallback: ((row) => {
      cdate: number;
      mdate: number;
      tags: string[];
  })
  - - (row): {
          cdate: number;
          mdate: number;
          tags: string[];
      }
    - Parameters
      
      row: any
      
      Returns {
          cdate: number;
          mdate: number;
          tags: string[];
      }
      
      cdate: number
      
      mdate: number
      
      tags: string[]
- getDataNameAndSValueCallback: ((row) => {
  name: string;
  svalue: string;
  })
  - - (row): {
      name: string;
      svalue: string;
      }
    - Parameters
      
      row: any
      
      Returns {
      name: string;
      svalue: string;
      }
      
      name: string
      
      svalue: string
Returns {
process: (() => Error | ReturnType<T["factorySync"]>[]);
result: any;
}
- process: (() => Error | ReturnType<T["factorySync"]>[])
  - - (): Error | ReturnType<T["factorySync"]>[]
    - Returns Error | ReturnType<T["factorySync"]>[]
- result: any
Inherited from NymphDriver.getEntitesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:111

getEntities

getEntities<T>(options, ...selectors): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- Rest ...selectors: Selector[]
Returns Promise<number>
Overrides NymphDriver.getEntities
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1637
getEntities<T>(options, ...selectors): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns Promise<string[]>
Overrides NymphDriver.getEntities
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1641
getEntities<T>(options?, ...selectors): Promise<ReturnType<T["factorySync"]>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optional options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<ReturnType<T["factorySync"]>[]>
Overrides NymphDriver.getEntities
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1645

`Protected` getEntitiesSync

getEntitiesSync<T>(options, ...selectors): number
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- Rest ...selectors: Selector[]
Returns number
Overrides NymphDriver.getEntitiesSync
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1656
getEntitiesSync<T>(options, ...selectors): string[]
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns string[]
Overrides NymphDriver.getEntitiesSync
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1660
getEntitiesSync<T>(options?, ...selectors): ReturnType<T["factorySync"]>[]
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optional options: Options<T>
- Rest ...selectors: Selector[]
Returns ReturnType<T["factorySync"]>[]
Overrides NymphDriver.getEntitiesSync
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1664

getEntitySync

getEntitySync<T>(options, ...selectors): number
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- Rest ...selectors: Selector[]
Returns number
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:67
getEntitySync<T>(options, ...selectors): null | string
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns null | string
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:70
getEntitySync<T>(options, ...selectors): null | ReturnType<T["factorySync"]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- Rest ...selectors: Selector[]
Returns null | ReturnType<T["factorySync"]>
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:73
getEntitySync<T>(options, guid): number
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "count";
  }
- guid: string
Returns number
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:74
getEntitySync<T>(options, guid): null | string
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- guid: string
Returns null | string
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:77
getEntitySync<T>(options, guid): null | ReturnType<T["factorySync"]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- guid: string
Returns null | ReturnType<T["factorySync"]>
Inherited from NymphDriver.getEntitySync
- Defined in nymph/dist/driver/NymphDriver.d.ts:80

getUID

getUID(name): Promise<null | number>
Parameters
- name: string
Returns Promise<null | number>
Overrides NymphDriver.getUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1706

import

import(filename): Promise<boolean>
Parameters
- filename: string
Returns Promise<boolean>
Overrides NymphDriver.import
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1723

`Protected` importFromFile

importFromFile(filename, saveEntityCallback, saveUIDCallback, startTransactionCallback?, commitTransactionCallback?): Promise<boolean>
Parameters
- filename: string
- saveEntityCallback: ((guid, tags, sdata, etype) => Promise<void>)
  - - (guid, tags, sdata, etype): Promise<void>
    - Parameters
      
      guid: string
      
      tags: string[]
      
      sdata: SerializedEntityData
      
      etype: string
      
      Returns Promise<void>
- saveUIDCallback: ((name, value) => Promise<void>)
  - - (name, value): Promise<void>
    - Parameters
      
      name: string
      
      value: number
      
      Returns Promise<void>
- Optional startTransactionCallback: null | (() => Promise<void>)
- Optional commitTransactionCallback: null | (() => Promise<void>)
Returns Promise<boolean>
Inherited from NymphDriver.importFromFile
- Defined in nymph/dist/driver/NymphDriver.d.ts:57

inTransaction

inTransaction(): Promise<boolean>
Returns Promise<boolean>
Overrides NymphDriver.inTransaction
- Defined in driver-sqlite3/src/SQLite3Driver.ts:204

init

init(nymph): void
Parameters
- nymph: default
Returns void
Inherited from NymphDriver.init
- Defined in nymph/dist/driver/NymphDriver.d.ts:53

isConnected

isConnected(): boolean
Check connection status.

Returns boolean
Whether this instance is connected to a SQLite3 database.
Overrides NymphDriver.isConnected
- Defined in driver-sqlite3/src/SQLite3Driver.ts:213

`Protected` iterateSelectorsForQuery

iterateSelectorsForQuery(selectors, callback): string[]
Parameters
- selectors: FormattedSelector[]
- callback: ((key, value, typeIsOr, typeIsNot) => string)
  - - (key, value, typeIsOr, typeIsNot): string
    - Parameters
      
      key: string
      
      value: any
      
      typeIsOr: boolean
      
      typeIsNot: boolean
      
      Returns string
Returns string[]
Inherited from NymphDriver.iterateSelectorsForQuery
- Defined in nymph/dist/driver/NymphDriver.d.ts:66

`Private` makeEntityQuery

makeEntityQuery(options, formattedSelectors, etype, count?, params?, subquery?, tableSuffix?, etypes?): {
    etypes: string[];
    params: {
        [k: string]: any;
    };
    query: string;
}
Generate the SQLite3 query.
Parameters
- options: Options
  
  The options array.
- formattedSelectors: FormattedSelector[]
  
  The formatted selector array.
- etype: string
- count: {
  i: number;
  } = ...
  
  Used to track internal params.
  - i: number
- params: {
  [k: string]: any;
  } = {}
  
  Used to store internal params.
  - [k: string]: any
- subquery: boolean = false
  
  Whether only a subquery should be returned.
- tableSuffix: string = ''
- etypes: string[] = []
Returns {
    etypes: string[];
    params: {
        [k: string]: any;
    };
    query: string;
}
The SQL query.
- etypes: string[]
- params: {
  [k: string]: any;
  }
  - [k: string]: any
- query: string
- Defined in driver-sqlite3/src/SQLite3Driver.ts:659

newUID

newUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
Overrides NymphDriver.newUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1882

`Protected` performQuery

performQuery(options, formattedSelectors, etype): {
result: any;
}
Parameters
- options: Options
- formattedSelectors: FormattedSelector[]
- etype: string
Returns {
result: any;
}
- result: any
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1619

`Protected` posixRegexMatch

posixRegexMatch(pattern, subject, caseInsensitive?): boolean
Parameters
- pattern: string
- subject: string
- Optional caseInsensitive: boolean
Returns boolean
Inherited from NymphDriver.posixRegexMatch
- Defined in nymph/dist/driver/NymphDriver.d.ts:54

`Protected` pullCache

pullCache<T>(guid, className, useSkipAc?): null | T
Type Parameters
- T extends EntityInterface = EntityInterface
Parameters
- guid: string
- className: string
- Optional useSkipAc: boolean
Returns null | T
Inherited from NymphDriver.pullCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:125

`Protected` pushCache

pushCache(guid, cdate, mdate, tags, data, sdata): void
Parameters
- guid: string
- cdate: number
- mdate: number
- tags: string[]
- data: EntityData
- sdata: SerializedEntityData
Returns void
Inherited from NymphDriver.pushCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:126

`Private` query

query<T>(runQuery, query, etypes?): ReturnType<T>
Type Parameters
- T extends (() => any)
Parameters
- runQuery: T
- query: string
- etypes: string[] = []
Returns ReturnType<T>
- Defined in driver-sqlite3/src/SQLite3Driver.ts:370

`Private` queryGet

queryGet(query, __namedParameters?): unknown
Parameters
- query: string
- __namedParameters: {
      etypes?: string[];
      params?: {
          [k: string]: any;
      };
  } = {}
  - Optional etypes?: string[]
  - Optional params?: {
    [k: string]: any;
    }
    - [k: string]: any
Returns unknown
- Defined in driver-sqlite3/src/SQLite3Driver.ts:422

`Private` queryIter

queryIter(query, __namedParameters?): IterableIterator<unknown>
Parameters
- query: string
- __namedParameters: {
      etypes?: string[];
      params?: {
          [k: string]: any;
      };
  } = {}
  - Optional etypes?: string[]
  - Optional params?: {
    [k: string]: any;
    }
    - [k: string]: any
Returns IterableIterator<unknown>
- Defined in driver-sqlite3/src/SQLite3Driver.ts:405

`Private` queryRun

queryRun(query, __namedParameters?): RunResult
Parameters
- query: string
- __namedParameters: {
      etypes?: string[];
      params?: {
          [k: string]: any;
      };
  } = {}
  - Optional etypes?: string[]
  - Optional params?: {
    [k: string]: any;
    }
    - [k: string]: any
Returns RunResult
- Defined in driver-sqlite3/src/SQLite3Driver.ts:437

renameUID

renameUID(oldName, newName): Promise<boolean>
Parameters
- oldName: string
- newName: string
Returns Promise<boolean>
Overrides NymphDriver.renameUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1936

rollback

rollback(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.rollback
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1956

saveEntity

saveEntity(entity): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
Overrides NymphDriver.saveEntity
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1981

`Protected` saveEntityRowLike

saveEntityRowLike(entity, saveNewEntityCallback, saveExistingEntityCallback, startTransactionCallback?, commitTransactionCallback?): Promise<boolean>
Parameters
- entity: EntityInterface
- saveNewEntityCallback: ((entity, guid, tags, data, sdata, cdate, etype) => Promise<boolean>)
  - - (entity, guid, tags, data, sdata, cdate, etype): Promise<boolean>
    - Parameters
      
      entity: EntityInterface
      
      guid: string
      
      tags: string[]
      
      data: EntityData
      
      sdata: SerializedEntityData
      
      cdate: number
      
      etype: string
      
      Returns Promise<boolean>
- saveExistingEntityCallback: ((entity, guid, tags, data, sdata, mdate, etype) => Promise<boolean>)
  - - (entity, guid, tags, data, sdata, mdate, etype): Promise<boolean>
    - Parameters
      
      entity: EntityInterface
      
      guid: string
      
      tags: string[]
      
      data: EntityData
      
      sdata: SerializedEntityData
      
      mdate: number
      
      etype: string
      
      Returns Promise<boolean>
- Optional startTransactionCallback: null | (() => Promise<void>)
- Optional commitTransactionCallback: null | ((success) => Promise<boolean>)
Returns Promise<boolean>
Inherited from NymphDriver.saveEntityRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:124

setUID

setUID(name, curUid): Promise<boolean>
Parameters
- name: string
- curUid: number
Returns Promise<boolean>
Overrides NymphDriver.setUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:2155

startTransaction

startTransaction(name): Promise<default>
Parameters
- name: string
Returns Promise<default>
Overrides NymphDriver.startTransaction
- Defined in driver-sqlite3/src/SQLite3Driver.ts:2185

`Static` escape

escape(input): string
Parameters
- input: string
Returns string
- Defined in driver-sqlite3/src/SQLite3Driver.ts:44

Class SQLite3Driver

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: Partial<SQLite3DriverConfig>

Optional store: InternalStore

Returns SQLite3Driver

Properties

config

Protected entityCache

Type declaration

[k: string]: { cdate: number; data: EntityData; mdate: number; sdata: SerializedEntityData; tags: string[]; }

cdate: number

data: EntityData

mdate: number

sdata: SerializedEntityData

tags: string[]

Protected entityCount

Type declaration

[k: string]: number

Protected nymph

Protected prefix

Protected store

Methods

Private _connect

Parameters

write: boolean

Returns void

checkData

Parameters

data: EntityData

sdata: SerializedEntityData

selectors: Selector[]

Optional guid: null | string

Optional tags: null | string[]

Returns boolean

Protected cleanCache

Parameters

guid: string

Returns void

clone

Returns SQLite3Driver

commit

Parameters

name: string

Returns Promise<boolean>

connect

Returns Promise<boolean>

Private createTables

Parameters

etype: null | string = null

Returns boolean

deleteEntity

Parameters

entity: EntityInterface

Returns Promise<boolean>

deleteEntityByID

Parameters

guid: string

Optional className: null | string | EntityConstructor

Returns Promise<boolean>

deleteUID

Parameters

name: string

Returns Promise<boolean>

disconnect

Returns Promise<false>

Protected entityReferenceSearch

Parameters

value: any

entity: string | EntityInterface | EntityReference | (string | EntityInterface | EntityReference)[]

Returns boolean

export

Parameters

filename: string

`Optional` store: InternalStore

`Protected` entityCache

[k: string]: {
cdate: number;
data: EntityData;
mdate: number;
sdata: SerializedEntityData;
tags: string[];
}

`Protected` entityCount

`Protected` nymph

`Protected` prefix

`Protected` store

`Private` _connect

`Optional` guid: null | string

`Optional` tags: null | string[]

`Protected` cleanCache

`Private` createTables

`Optional` className: null | string | EntityConstructor

`Protected` entityReferenceSearch

`Protected` exportEntities

`Protected` findReferences

`Optional` options: Options

Returns {
qrefs: [Options, ...FormattedSelector[]][];
selectors: FormattedSelector[];
}

`Protected` getEntitesRowLike

options: Options<T> & {
return: "count";
}

performQueryCallback: ((options, formattedSelectors, etype) => {
result: any;
})

Returns {
result: any;
}

getTagsAndDatesCallback: ((row) => {
cdate: number;
mdate: number;
tags: string[];
})

Returns {
cdate: number;
mdate: number;
tags: string[];
}

getDataNameAndSValueCallback: ((row) => {
name: string;
svalue: string;
})

Returns {
name: string;
svalue: string;
}

Returns {
process: (() => number | Error);
result: any;
}

options: Options<T> & {
return: "guid";
}

performQueryCallback: ((options, formattedSelectors, etype) => {
result: any;
})