Class NymphDriver`Abstract`

A Nymph database driver.

Hierarchy

NymphDriver

Constructors

constructor

new NymphDriver(): NymphDriver
Returns NymphDriver

Properties

`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 = ...

`Private` putDataCounter

putDataCounter: number = 0

Protect against infinite loops.

Methods

checkData

checkData(data, sdata, selectors, guid?, tags?): boolean
Parameters
- data: EntityData
- sdata: SerializedEntityData
- selectors: Selector[]
- guid: null | string = null
- tags: null | string[] = null
Returns boolean
- Defined in packages/nymph/src/driver/NymphDriver.ts:321

`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
- Defined in packages/nymph/src/driver/NymphDriver.ts:547

`Abstract` clone

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

Returns NymphDriver
A clone of this instance.
- Defined in packages/nymph/src/driver/NymphDriver.ts:63

`Abstract` commit

commit(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:73

`Abstract` connect

connect(): Promise<boolean>
Connect to the data store.

Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:68

deleteEntity

deleteEntity(entity): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:551

`Abstract` deleteEntityByID

deleteEntityByID(guid, classConstructor): Promise<boolean>
Parameters
- guid: string
- classConstructor: EntityConstructor
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:76
deleteEntityByID(guid, className?): Promise<boolean>
Parameters
- guid: string
- Optional className: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:80

`Abstract` deleteUID

deleteUID(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:81

`Abstract` disconnect

disconnect(): Promise<boolean>
Disconnect from the data store.

Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:86

`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.
- Defined in packages/nymph/src/driver/NymphDriver.ts:572

export

export(filename): Promise<boolean>
Parameters
- filename: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:197

`Abstract` exportDataIterator

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

exportPrint

exportPrint(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:213

`Protected` findReferences

findReferences(svalue): string[]
Parameters
- svalue: string
Returns string[]
- Defined in packages/nymph/src/driver/NymphDriver.ts:1197

formatSelectors

formatSelectors(selectors, options?): {
qrefs: [Options, ...FormattedSelector[]][];
selectors: FormattedSelector[];
}
Parameters
- selectors: Selector[]
- options: Options = {}
Returns {
qrefs: [Options, ...FormattedSelector[]][];
selectors: FormattedSelector[];
}
- qrefs: [Options, ...FormattedSelector[]][]
- selectors: FormattedSelector[]
- Defined in packages/nymph/src/driver/NymphDriver.ts:619

`Abstract` 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>
- Defined in packages/nymph/src/driver/NymphDriver.ts:101
getEntities<T>(options, ...selectors): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest ...selectors: Selector[]
Returns Promise<string[]>
- Defined in packages/nymph/src/driver/NymphDriver.ts:105
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>[]>
- Defined in packages/nymph/src/driver/NymphDriver.ts:109
getEntities<T>(options?, ...selectors): Promise<number | string[] | EntityInstanceType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optional options: Options<T>
- Rest ...selectors: Selector[]
Returns Promise<number | string[] | EntityInstanceType<T>[]>
- Defined in packages/nymph/src/driver/NymphDriver.ts:113

`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
- Defined in packages/nymph/src/driver/NymphDriver.ts:749
getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => Error | string[]);
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: (() => Error | string[]);
result: any;
}
- process: (() => Error | string[])
  - - (): Error | string[]
    - Returns Error | string[]
- result: any
- Defined in packages/nymph/src/driver/NymphDriver.ts:773
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
- Defined in packages/nymph/src/driver/NymphDriver.ts:797

`Abstract` getUID

getUID(name): Promise<null | number>
Parameters
- name: string
Returns Promise<null | number>
- Defined in packages/nymph/src/driver/NymphDriver.ts:117

import

import(filename, transaction?): Promise<boolean>
Parameters
- filename: string
- Optional transaction: boolean
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:301

importData

importData(text, transaction?): Promise<boolean>
Parameters
- text: string
- Optional transaction: boolean
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:297

importDataIterator

importDataIterator(lines, transaction?): Promise<boolean>
Parameters
- lines: Iterable<string>
- Optional transaction: boolean
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:220

`Abstract` importEntity

importEntity(entity): Promise<void>
Parameters
- entity: {
      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>
- Defined in packages/nymph/src/driver/NymphDriver.ts:118

`Abstract` importUID

importUID(uid): Promise<void>
Parameters
- uid: {
  name: string;
  value: number;
  }
  - name: string
  - value: number
Returns Promise<void>
- Defined in packages/nymph/src/driver/NymphDriver.ts:126

`Abstract` inTransaction

inTransaction(): Promise<boolean>
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:75

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
- Defined in packages/nymph/src/driver/NymphDriver.ts:139

`Protected` `Abstract` internalTransaction

internalTransaction(name): Promise<any>
Parameters
- name: string
Returns Promise<any>
- Defined in packages/nymph/src/driver/NymphDriver.ts:71

`Abstract` isConnected

isConnected(): boolean
Returns boolean
- Defined in packages/nymph/src/driver/NymphDriver.ts:70

`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[]
- Defined in packages/nymph/src/driver/NymphDriver.ts:713

`Abstract` 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>
- Defined in packages/nymph/src/driver/NymphDriver.ts:94

`Abstract` newUID

newUID(name): Promise<null | number>
Parameters
- name: string
Returns Promise<null | number>
- Defined in packages/nymph/src/driver/NymphDriver.ts:127

`Protected` posixRegexMatch

posixRegexMatch(pattern, subject, caseInsensitive?): boolean
Parameters
- pattern: string
- subject: string
- caseInsensitive: boolean = false
Returns boolean
- Defined in packages/nymph/src/driver/NymphDriver.ts:143

`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.
- useSkipAc: boolean = false
  Whether to tell the entity to use skip_ac.
Returns null | T
The entity or null if it's not cached.
- Defined in packages/nymph/src/driver/NymphDriver.ts:1111

`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
- Defined in packages/nymph/src/driver/NymphDriver.ts:1150

`Abstract` renameUID

renameUID(oldName, newName): Promise<boolean>
Parameters
- oldName: string
- newName: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:128

`Abstract` rollback

rollback(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:74

`Abstract` saveEntity

saveEntity(entity): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:129

`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>
- startTransactionCallback: null | (() => Promise<void>) = null
- commitTransactionCallback: null | ((success) => Promise<boolean>) = null
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:1010

`Abstract` setUID

setUID(name, value): Promise<boolean>
Parameters
- name: string
- value: number
Returns Promise<boolean>
- Defined in packages/nymph/src/driver/NymphDriver.ts:130

`Abstract` startTransaction

startTransaction(name): Promise<Nymph>
Parameters
- name: string
Returns Promise<Nymph>
- Defined in packages/nymph/src/driver/NymphDriver.ts:72

Class NymphDriverAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns NymphDriver

Properties

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

Private putDataCounter

Methods

checkData

Parameters

Returns boolean

Protected cleanCache

Parameters

Returns void

Abstract clone

Returns NymphDriver

Abstract commit

Parameters

Returns Promise<boolean>

Abstract connect

Returns Promise<boolean>

deleteEntity

Parameters

Returns Promise<boolean>

Abstract deleteEntityByID

Parameters

Returns Promise<boolean>

Parameters

Returns Promise<boolean>

Abstract deleteUID

Parameters

Returns Promise<boolean>

Abstract disconnect

Returns Promise<boolean>

Protected entityReferenceSearch

Parameters

Returns boolean

export

Parameters

Returns Promise<boolean>

Abstract exportDataIterator

Returns AsyncGenerator<{ content: string; type: "entity" | "comment" | "uid"; }, 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[]

Abstract getEntities

Type Parameters

Parameters

Returns Promise<number>

Type Parameters

Parameters

Returns Promise<string[]>

Type Parameters

Parameters

Returns Promise<EntityInstanceType<T>[]>

Type Parameters

Parameters

Class NymphDriver`Abstract`

`Protected` entityCache

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

`Protected` entityCount

`Protected` nymph

`Private` putDataCounter

`Protected` cleanCache

`Abstract` clone

`Abstract` commit

`Abstract` connect

`Abstract` deleteEntityByID

`Abstract` deleteUID

`Abstract` disconnect

`Protected` entityReferenceSearch

`Abstract` exportDataIterator

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

`Protected` findReferences

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

`Abstract` getEntities

`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: (() => Error | string[]);
result: any;
}

Returns {
result: any;
}