Class NymphDriverAbstract

Protected entityCache

Protected entityCount

Protected nymph

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

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.

Protected Abstract exportEntities

• exportEntities(writeLine): Promise<void>

• Parameters

  • writeLine: ((line) => void)

    • • (line): void

      • Parameters

        • line: string

        Returns void

  Returns Promise<void>

Protected findReferences

• findReferences(svalue): string[]

• Parameters

  • svalue: string

  Returns string[]

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

• 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

• 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

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>

  • startTransactionCallback: null | (() => Promise<void>) = null

  • commitTransactionCallback: null | (() => Promise<void>) = null

  Returns Promise<boolean>

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[]

Protected posixRegexMatch

• posixRegexMatch(pattern, subject, caseInsensitive?): boolean

• Parameters

  • pattern: string

  • subject: string

  • caseInsensitive: boolean = false

  Returns boolean

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.

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

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>