Class SQLite3Driver

The SQLite3 Nymph database driver.

Hierarchy (view full)

NymphDriver
- 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:56

Properties

config

config: SQLite3DriverConfig

`Protected` entityCache

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

A cache to make entity retrieval faster.

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;
}

A counter for the entity cache to determine the most accessed entities.

Type declaration

[k: string]: number

`Protected` nymph

nymph: Nymph

`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:95

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:105

`Protected` cleanCache

cleanCache(guid): void
Remove all copies of an entity from the cache.
Parameters
- guid: string
  The GUID of the entity to remove.
Returns void
Inherited from NymphDriver.cleanCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:111

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:75

commit

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

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:84

`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:227

deleteEntity

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

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:496

deleteUID

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

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:192

`Protected` entityReferenceSearch

entityReferenceSearch(value, entity): boolean
Search through a value for an entity reference.
Parameters
- value: any
  Any value to search.
- entity: string | EntityInterface | EntityReference | (string | EntityInterface | EntityReference)[]
  An entity, GUID, or array of either to search for.
Returns boolean
True if the reference is found, false otherwise.
Inherited from NymphDriver.entityReferenceSearch
- Defined in nymph/dist/driver/NymphDriver.d.ts:120

export

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

exportDataIterator

exportDataIterator(): AsyncGenerator<{
content: string;
type: "comment" | "uid" | "entity";
}, void, undefined | false>
Returns AsyncGenerator<{
content: string;
type: "comment" | "uid" | "entity";
}, void, undefined | false>
Overrides NymphDriver.exportDataIterator
- Defined in driver-sqlite3/src/SQLite3Driver.ts:587

exportPrint

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

`Protected` findReferences

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

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:121

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:1701
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:1705
getEntities<T>(options?, ...selectors): Promise<EntityInstanceType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optional options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<EntityInstanceType<T>[]>
Overrides NymphDriver.getEntities
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1709

`Protected` getEntitiesRowLike

getEntitiesRowLike<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: ((data) => {
  result: any;
  })
  - - (data): {
      result: any;
      }
    - Parameters
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      }
      etype: string
      options: Options<T>
      selectors: FormattedSelector[]
      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.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:131
getEntitiesRowLike<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: ((data) => {
  result: any;
  })
  - - (data): {
      result: any;
      }
    - Parameters
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      }
      etype: string
      options: Options<T>
      selectors: FormattedSelector[]
      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.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:150
getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => Error | EntityInstanceType<T>[]);
result: any;
}
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- selectors: Selector[]
- performQueryCallback: ((data) => {
  result: any;
  })
  - - (data): {
      result: any;
      }
    - Parameters
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      }
      etype: string
      options: Options<T>
      selectors: FormattedSelector[]
      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 | EntityInstanceType<T>[]);
result: any;
}
- process: (() => Error | EntityInstanceType<T>[])
  - - (): Error | EntityInstanceType<T>[]
    - Returns Error | EntityInstanceType<T>[]
- result: any
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:169

getUID

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

import

import(filename, transaction?): Promise<boolean>
Parameters
- filename: string
- Optional transaction: boolean
Returns Promise<boolean>
Inherited from NymphDriver.import
- Defined in nymph/dist/driver/NymphDriver.d.ts:104

importData

importData(text, transaction?): Promise<boolean>
Parameters
- text: string
- Optional transaction: boolean
Returns Promise<boolean>
Inherited from NymphDriver.importData
- Defined in nymph/dist/driver/NymphDriver.d.ts:103

importDataIterator

importDataIterator(lines, transaction?): Promise<boolean>
Parameters
- lines: Iterable<string>
- Optional transaction: boolean
Returns Promise<boolean>
Inherited from NymphDriver.importDataIterator
- Defined in nymph/dist/driver/NymphDriver.d.ts:102

importEntity

importEntity(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
      cdate: number;
      etype: string;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }
  - cdate: number
  - etype: string
  - guid: string
  - mdate: number
  - sdata: SerializedEntityData
  - tags: string[]
Returns Promise<void>
Overrides NymphDriver.importEntity
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1776

importUID

importUID(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  name: string;
  value: number;
  }
  - name: string
  - value: number
Returns Promise<void>
Overrides NymphDriver.importUID
- Defined in driver-sqlite3/src/SQLite3Driver.ts:1931

inTransaction

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

init

init(nymph): void
Initialize the Nymph driver.

This is meant to be called internally by Nymph. Don't call this directly.
Parameters
- nymph: Nymph
  The Nymph instance.
Returns void
Inherited from NymphDriver.init
- Defined in nymph/dist/driver/NymphDriver.d.ts:98

internalTransaction

internalTransaction(name): Promise<void>
Parameters
- name: string
Returns Promise<void>
Overrides NymphDriver.internalTransaction
- Defined in driver-sqlite3/src/SQLite3Driver.ts:2292

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:218

`Protected` iterateSelectorsForQuery

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

`Private` makeEntityQuery

makeEntityQuery(options, formattedSelectors, etype, count?, params?, subquery?, tableSuffix?, etypes?, guidSelector?): {
    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[] = []
- guidSelector: undefined | string = undefined
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:719

needsMigration

needsMigration(): Promise<boolean>
Detect whether the database needs to be migrated.

If true, the database should be exported with an old version of Nymph, then imported into a fresh database with this version.

Returns Promise<boolean>
Overrides NymphDriver.needsMigration
- Defined in driver-sqlite3/src/SQLite3Driver.ts:2310

newUID

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

`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:1683

`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:99

`Protected` pullCache

pullCache<T>(guid, className, useSkipAc?): null | T
Pull an entity from the cache.
Type Parameters
- T extends Entity<EntityData>
Parameters
- guid: string
  The entity's GUID.
- className: string
  The entity's class.
- Optional useSkipAc: boolean
  Whether to tell the entity to use skip_ac.
Returns null | T
The entity or null if it's not cached.
Inherited from NymphDriver.pullCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:213

`Protected` pushCache

pushCache(guid, cdate, mdate, tags, data, sdata): void
Push an entity onto the cache.
Parameters
- guid: string
  The entity's GUID.
- cdate: number
  The entity's cdate.
- mdate: number
  The entity's mdate.
- tags: string[]
  The entity's tags.
- data: EntityData
  The entity's data.
- sdata: SerializedEntityData
  The entity's sdata.
Returns void
Inherited from NymphDriver.pushCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:224

`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:383

`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:441

`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:424

`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:456

renameUID

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

rollback

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

saveEntity

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

`Protected` saveEntityRowLike

saveEntityRowLike(entity, saveNewEntityCallback, saveExistingEntityCallback, startTransactionCallback?, commitTransactionCallback?): Promise<boolean>
Parameters
- entity: EntityInterface
- saveNewEntityCallback: ((data) => Promise<boolean>)
  - - (data): Promise<boolean>
    - Parameters
      data: {
          cdate: number;
          data: EntityData;
          entity: EntityInterface;
          etype: string;
          guid: string;
          sdata: SerializedEntityData;
          tags: string[];
          uniques: string[];
      }
      cdate: number
      data: EntityData
      entity: EntityInterface
      etype: string
      guid: string
      sdata: SerializedEntityData
      tags: string[]
      uniques: string[]
      Returns Promise<boolean>
- saveExistingEntityCallback: ((data) => Promise<boolean>)
  - - (data): Promise<boolean>
    - Parameters
      data: {
          data: EntityData;
          entity: EntityInterface;
          etype: string;
          guid: string;
          mdate: number;
          sdata: SerializedEntityData;
          tags: string[];
          uniques: string[];
      }
      data: EntityData
      entity: EntityInterface
      etype: string
      guid: string
      mdate: number
      sdata: SerializedEntityData
      tags: string[]
      uniques: 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:186

setUID

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

startTransaction

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

`Static` escape

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

Class SQLite3Driver

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Returns void

checkData

Parameters

Returns boolean

Protected cleanCache

Parameters

Returns void

clone

Returns SQLite3Driver

commit

Parameters

Returns Promise<boolean>

connect

Returns Promise<boolean>

Private createTables

Parameters

Returns boolean

deleteEntity

Parameters

Returns Promise<boolean>

deleteEntityByID

Parameters

Returns Promise<boolean>

deleteUID

Parameters

Returns Promise<boolean>

disconnect

Returns Promise<false>

Protected entityReferenceSearch

Parameters

Returns boolean

export

Parameters

Returns Promise<boolean>

exportDataIterator

Returns AsyncGenerator<{ content: string; type: "comment" | "uid" | "entity"; }, void, undefined | false>

exportPrint

Returns Promise<boolean>

Protected findReferences

Parameters

Returns string[]

formatSelectors

Parameters

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

qrefs: [Options, ...FormattedSelector[]][]

selectors: FormattedSelector[]

getEntities

Type Parameters

Parameters

Returns Promise<number>

Type Parameters

`Protected` entityCache

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

`Protected` entityCount

`Protected` nymph

`Protected` prefix

`Protected` store

`Private` _connect

`Protected` cleanCache

`Private` createTables

`Protected` entityReferenceSearch

Returns AsyncGenerator<{
content: string;
type: "comment" | "uid" | "entity";
}, void, undefined | false>

`Protected` findReferences

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

`Protected` getEntitiesRowLike

Returns {
result: any;
}

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

Returns {
name: string;
svalue: string;
}

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

Returns {
result: any;
}

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

Returns {
name: string;
svalue: string;
}

Returns {
process: (() => string[] | Error);
result: any;
}

Returns {
result: any;
}