@nymphjs/nymph 1.0.0-beta.8 → 1.0.0-beta.81

package/src/driver/NymphDriver.ts

@@ -5,7 +5,9 @@ import strtotime from 'locutus/php/datetime/strtotime';
 import { guid } from '@nymphjs/guid';
 
 import type Nymph from '../Nymph';
-import {
+import type { Selector, Options, FormattedSelector } from '../Nymph.types';
+import Entity, { type EntityInstanceType } from '../Entity';
+import type {
   EntityConstructor,
   EntityData,
   EntityInterface,
@@ -13,7 +15,6 @@ import {
   SerializedEntityData,
 } from '../Entity.types';
 import { InvalidParametersError, UnableToConnectError } from '../errors';
-import { Selector, Options, FormattedSelector } from '../Nymph.types';
 import { xor } from '../utils';
 
 // from: https://stackoverflow.com/a/6969486/664915
@@ -28,7 +29,7 @@ export default abstract class NymphDriver {
   protected nymph: Nymph = new Proxy({} as Nymph, {
     get() {
       throw new Error(
-        'Attempted access of Nymph instance before driver initialization!'
+        'Attempted access of Nymph instance before driver initialization!',
       );
     },
   });
@@ -67,13 +68,14 @@ export default abstract class NymphDriver {
   abstract connect(): Promise<boolean>;
 
   abstract isConnected(): boolean;
+  protected abstract internalTransaction(name: string): Promise<any>;
   abstract startTransaction(name: string): Promise<Nymph>;
   abstract commit(name: string): Promise<boolean>;
   abstract rollback(name: string): Promise<boolean>;
   abstract inTransaction(): Promise<boolean>;
   abstract deleteEntityByID(
     guid: string,
-    classConstructor: EntityConstructor
+    classConstructor: EntityConstructor,
   ): Promise<boolean>;
   abstract deleteEntityByID(guid: string, className?: string): Promise<boolean>;
   abstract deleteUID(name: string): Promise<boolean>;
@@ -83,9 +85,19 @@ export default abstract class NymphDriver {
    */
   abstract disconnect(): Promise<boolean>;
 
-  protected abstract exportEntities(
-    writeLine: (line: string) => void
-  ): Promise<void>;
+  /**
+   * 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.
+   */
+  abstract needsMigration(): Promise<boolean>;
+
+  abstract exportDataIterator(): AsyncGenerator<
+    { type: 'comment' | 'uid' | 'entity'; content: string },
+    void,
+    undefined | false
+  >;
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'count' },
     ...selectors: Selector[]
@@ -97,37 +109,21 @@ export default abstract class NymphDriver {
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options?: Options<T>,
     ...selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[]>;
+  ): Promise<EntityInstanceType<T>[]>;
   abstract getEntities<T extends EntityConstructor = EntityConstructor>(
     options?: Options<T>,
     ...selectors: Selector[]
-  ): Promise<ReturnType<T['factorySync']>[] | string[] | number>;
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options: Options<T> & { return: 'count' },
-    ...selectors: Selector[]
-  ): number;
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): string[];
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[];
-  protected abstract getEntitiesSync<
-    T extends EntityConstructor = EntityConstructor
-  >(
-    options?: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']>[] | string[] | number;
+  ): Promise<EntityInstanceType<T>[] | string[] | number>;
   abstract getUID(name: string): Promise<number | null>;
-  abstract import(filename: string): Promise<boolean>;
+  abstract importEntity(entity: {
+    guid: string;
+    cdate: number;
+    mdate: number;
+    tags: string[];
+    sdata: SerializedEntityData;
+    etype: string;
+  }): Promise<void>;
+  abstract importUID(uid: { name: string; value: number }): Promise<void>;
   abstract newUID(name: string): Promise<number | null>;
   abstract renameUID(oldName: string, newName: string): Promise<boolean>;
   abstract saveEntity(entity: EntityInterface): Promise<boolean>;
@@ -147,7 +143,7 @@ export default abstract class NymphDriver {
   protected posixRegexMatch(
     pattern: string,
     subject: string,
-    caseInsensitive = false
+    caseInsensitive = false,
   ) {
     const posixClasses = [
       // '[[:<:]]',
@@ -204,9 +200,9 @@ export default abstract class NymphDriver {
       if (!fhandle) {
         throw new InvalidParametersError('Provided filename is not writeable.');
       }
-      await this.exportEntities((line: string) => {
-        fs.writeSync(fhandle, `${line}\n`);
-      });
+      for await (let entry of this.exportDataIterator()) {
+        fs.writeSync(fhandle, entry.content);
+      }
       fs.closeSync(fhandle);
     } catch (e: any) {
       return false;
@@ -215,130 +211,155 @@ export default abstract class NymphDriver {
   }
 
   public async exportPrint() {
-    await this.exportEntities((line: string) => {
-      console.log(line);
-    });
+    for await (let entry of this.exportDataIterator()) {
+      console.log(entry.content);
+    }
     return true;
   }
 
-  protected async importFromFile(
-    filename: string,
-    saveEntityCallback: (
-      guid: string,
-      tags: string[],
-      sdata: SerializedEntityData,
-      etype: string
-    ) => Promise<void>,
-    saveUIDCallback: (name: string, value: number) => Promise<void>,
-    startTransactionCallback: (() => Promise<void>) | null = null,
-    commitTransactionCallback: (() => Promise<void>) | null = null
+  public async importDataIterator(
+    lines: Iterable<string>,
+    transaction?: boolean,
   ) {
-    let rl: ReadLines;
-    try {
-      rl = new ReadLines(filename);
-    } catch (e: any) {
-      throw new InvalidParametersError('Provided filename is unreadable.');
+    const first = lines[Symbol.iterator]().next();
+
+    if (first.done || first.value !== '#nex2') {
+      throw new Error('Tried to import a file that is not a NEX v2 file.');
     }
-    let guid: string | null = null;
-    let line: Buffer | false = false;
-    let sdata: SerializedEntityData = {};
-    let tags: string[] = [];
-    let etype = '__undefined';
-    if (startTransactionCallback) {
-      await startTransactionCallback();
+
+    if (transaction) {
+      await this.internalTransaction('nymph-import');
     }
-    while ((line = rl.next())) {
-      const text = line.toString('utf8');
-      if (text.match(/^\s*#/)) {
-        continue;
-      }
-      const entityMatch = text.match(
-        /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/
-      );
-      const propMatch = text.match(/^\s*([^=]+)\s*=\s*(.*\S)\s*$/);
-      const uidMatch = text.match(/^\s*<([^>]+)>\[(\d+)\]\s*$/);
-      if (uidMatch) {
-        // Add the UID.
-        await saveUIDCallback(uidMatch[1], Number(uidMatch[2]));
-      } else if (entityMatch) {
-        // Save the current entity.
-        if (guid) {
-          await saveEntityCallback(guid, tags, sdata, etype);
-          guid = null;
-          tags = [];
-          sdata = {};
-          etype = '__undefined';
+    try {
+      let guid: string | null = null;
+      let sdata: SerializedEntityData = {};
+      let tags: string[] = [];
+      let etype = '__undefined';
+      for (let line of lines) {
+        if (line.match(/^\s*#/)) {
+          continue;
         }
-        // Record the new entity's info.
-        guid = entityMatch[1];
-        etype = entityMatch[2];
-        tags = entityMatch[3].split(',');
-      } else if (propMatch) {
-        // Add the variable to the new entity.
-        if (guid) {
-          sdata[propMatch[1]] = propMatch[2];
+        const entityMatch = line.match(
+          /^\s*{([0-9A-Fa-f]+)}<([-\w_]+)>\[([^\]]*)\]\s*$/,
+        );
+        const propMatch = line.match(/^\s*([^=]+)\s*=\s*(.*\S)\s*$/);
+        const uidMatch = line.match(/^\s*<([^>]+)>\[(\d+)\]\s*$/);
+        if (uidMatch) {
+          // Add the UID.
+          await this.importUID({
+            name: uidMatch[1],
+            value: Number(uidMatch[2]),
+          });
+        } else if (entityMatch) {
+          // Save the current entity.
+          if (guid) {
+            const cdate = Number(JSON.parse(sdata.cdate));
+            delete sdata.cdate;
+            const mdate = Number(JSON.parse(sdata.mdate));
+            delete sdata.mdate;
+            await this.importEntity({ guid, cdate, mdate, tags, sdata, etype });
+            guid = null;
+            tags = [];
+            sdata = {};
+            etype = '__undefined';
+          }
+          // Record the new entity's info.
+          guid = entityMatch[1];
+          etype = entityMatch[2];
+          tags = entityMatch[3].split(',');
+        } else if (propMatch) {
+          // Add the variable to the new entity.
+          if (guid) {
+            sdata[propMatch[1]] = propMatch[2];
+          }
         }
+        // Clear the entity cache.
+        this.entityCache = {};
       }
-      // Clear the entity cache.
-      this.entityCache = {};
-    }
-    // Save the last entity.
-    if (guid) {
-      await saveEntityCallback(guid, tags, sdata, etype);
-    }
-    if (commitTransactionCallback) {
-      await commitTransactionCallback();
+      // Save the last entity.
+      if (guid) {
+        const cdate = Number(JSON.parse(sdata.cdate));
+        delete sdata.cdate;
+        const mdate = Number(JSON.parse(sdata.mdate));
+        delete sdata.mdate;
+        await this.importEntity({ guid, cdate, mdate, tags, sdata, etype });
+      }
+      if (transaction) {
+        await this.commit('nymph-import');
+      }
+    } catch (e: any) {
+      await this.rollback('nymph-import');
+      throw e;
     }
     return true;
   }
 
+  public async importData(text: string, transaction?: boolean) {
+    return await this.importDataIterator(text.split('\n'), transaction);
+  }
+
+  public async import(filename: string, transaction?: boolean) {
+    let rl: ReadLines;
+    try {
+      rl = new ReadLines(filename);
+    } catch (e: any) {
+      throw new InvalidParametersError('Provided filename is unreadable.');
+    }
+
+    const lines = {
+      *[Symbol.iterator]() {
+        let line: false | Buffer;
+        while ((line = rl.next())) {
+          yield line.toString('utf8');
+        }
+      },
+    };
+
+    return await this.importDataIterator(lines, transaction);
+  }
+
   public checkData(
     data: EntityData,
     sdata: SerializedEntityData,
     selectors: Selector[],
     guid: string | null = null,
-    tags: string[] | null = null
+    tags: string[] | null = null,
   ) {
-    const formattedSelectors = this.formatSelectors(selectors).selectors;
+    try {
+      const formattedSelectors = this.formatSelectors(selectors).selectors;
 
-    for (const curSelector of formattedSelectors) {
-      const type = curSelector.type;
-      const typeIsNot = type === '!&' || type === '!|';
-      const typeIsOr = type === '|' || type === '!|';
-      let pass = !typeIsOr;
-      for (const k in curSelector) {
-        const key = k as keyof Selector;
-        const value = curSelector[key];
+      for (const curSelector of formattedSelectors) {
+        const type = curSelector.type;
+        const typeIsNot = type === '!&' || type === '!|';
+        const typeIsOr = type === '|' || type === '!|';
+        let pass = !typeIsOr;
+        for (const k in curSelector) {
+          const key = k as keyof Selector;
+          const value = curSelector[key];
 
-        if (key === 'type' || value == null) {
-          continue;
-        }
+          if (key === 'type' || value == null) {
+            continue;
+          }
 
-        const clauseNot = key.substr(0, 1) === '!';
-        if (key === 'selector' || key === '!selector') {
-          const tmpArr = (Array.isArray(value) ? value : [value]) as Selector[];
-          pass = xor(
-            this.checkData(data, sdata, tmpArr, guid, tags),
-            xor(typeIsNot, clauseNot)
-          );
-        } else {
-          if (key === 'qref' || key === '!qref') {
-            throw new Error("Can't use checkData on qref clauses.");
+          const clauseNot = key.substring(0, 1) === '!';
+          if (key === 'selector' || key === '!selector') {
+            const tmpArr = (
+              Array.isArray(value) ? value : [value]
+            ) as Selector[];
+            pass = xor(
+              this.checkData(data, sdata, tmpArr, guid, tags),
+              xor(typeIsNot, clauseNot),
+            );
           } else {
-            // Check if it doesn't pass any for &, check if it
-            // passes any for |.
-            for (const curValue of value) {
-              if (curValue == null) {
-                continue;
-              }
+            if (key === 'qref' || key === '!qref') {
+              throw new Error("Can't use checkData on qref clauses.");
+            } else {
+              // Check if it doesn't pass any for &, check if it passes any for |.
+              for (const curValue of value) {
+                if (curValue == null) {
+                  continue;
+                }
 
-              if (
-                ((key === 'guid' || key === '!guid') && guid == null) ||
-                ((key === 'tag' || key === '!tag') && tags == null)
-              ) {
-                // Skip because it has already been checked (by the query).
-                pass = true;
-              } else {
                 const propName = (curValue as string[])[0];
 
                 // Unserialize the data for this variable.
@@ -356,7 +377,7 @@ export default abstract class NymphDriver {
                   case '!tag':
                     pass = xor(
                       (tags ?? []).indexOf(propName) !== -1,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'defined':
@@ -367,7 +388,7 @@ export default abstract class NymphDriver {
                   case '!truthy':
                     pass = xor(
                       propName in data && data[propName],
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'ref':
@@ -377,9 +398,9 @@ export default abstract class NymphDriver {
                       propName in data &&
                         this.entityReferenceSearch(
                           data[propName],
-                          testRefValue
+                          testRefValue,
                         ),
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'equal':
@@ -391,7 +412,7 @@ export default abstract class NymphDriver {
                       propName in data &&
                         JSON.stringify(data[propName]) ===
                           JSON.stringify(testEqualValue),
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'contain':
@@ -402,9 +423,9 @@ export default abstract class NymphDriver {
                     pass = xor(
                       propName in data &&
                         JSON.stringify(data[propName]).indexOf(
-                          JSON.stringify(testContainValue)
+                          JSON.stringify(testContainValue),
                         ) !== -1,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'like':
@@ -419,9 +440,9 @@ export default abstract class NymphDriver {
                             escapeRegExp(testLikeValue)
                               .replace('%', () => '.*')
                               .replace('_', () => '.') +
-                            '$'
+                            '$',
                         ).test(data[propName]),
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'match':
@@ -433,7 +454,7 @@ export default abstract class NymphDriver {
                     pass = xor(
                       propName in data &&
                         this.posixRegexMatch(testMatchValue, data[propName]),
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'imatch':
@@ -447,9 +468,9 @@ export default abstract class NymphDriver {
                         this.posixRegexMatch(
                           testIMatchValue,
                           data[propName],
-                          true
+                          true,
                         ),
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'gt':
@@ -459,7 +480,7 @@ export default abstract class NymphDriver {
                     )[1] as number;
                     pass = xor(
                       propName in data && data[propName] > testGTValue,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'gte':
@@ -469,7 +490,7 @@ export default abstract class NymphDriver {
                     )[1] as number;
                     pass = xor(
                       propName in data && data[propName] >= testGTEValue,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'lt':
@@ -479,7 +500,7 @@ export default abstract class NymphDriver {
                     )[1] as number;
                     pass = xor(
                       propName in data && data[propName] < testLTValue,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                   case 'lte':
@@ -489,26 +510,33 @@ export default abstract class NymphDriver {
                     )[1] as number;
                     pass = xor(
                       propName in data && data[propName] <= testLTEValue,
-                      xor(typeIsNot, clauseNot)
+                      xor(typeIsNot, clauseNot),
                     );
                     break;
                 }
-              }
-              if (!xor(typeIsOr, pass)) {
-                break;
+
+                if (!xor(typeIsOr, pass)) {
+                  break;
+                }
               }
             }
           }
+          if (!xor(typeIsOr, pass)) {
+            break;
+          }
         }
-        if (!xor(typeIsOr, pass)) {
-          break;
+        if (!pass) {
+          return false;
         }
       }
-      if (!pass) {
-        return false;
-      }
+      return true;
+    } catch (e: any) {
+      this.nymph.config.debugError(
+        'nymph',
+        `Failed to check entity data: ${e}`,
+      );
+      throw e;
     }
-    return true;
   }
 
   /**
@@ -547,7 +575,7 @@ export default abstract class NymphDriver {
       | EntityInterface
       | EntityReference
       | string
-      | (EntityInterface | EntityReference | string)[]
+      | (EntityInterface | EntityReference | string)[],
   ) {
     // Get the GUID, if the passed $entity is an object.
     const guids: string[] = [];
@@ -590,7 +618,7 @@ export default abstract class NymphDriver {
 
   public formatSelectors(
     selectors: Selector[],
-    options: Options = {}
+    options: Options = {},
   ): {
     selectors: FormattedSelector[];
     qrefs: [Options, ...FormattedSelector[]][];
@@ -625,10 +653,9 @@ export default abstract class NymphDriver {
           for (let i = 0; i < tmpArr.length; i++) {
             const name = tmpArr[i][0];
             const [qrefOptions, ...qrefSelectors] = tmpArr[i][1];
-            const QrefEntityClass =
-              typeof qrefOptions.class === 'string'
-                ? this.nymph.getEntityClass(qrefOptions.class)
-                : qrefOptions.class ?? this.nymph.getEntityClass('Entity');
+            const QrefEntityClass = qrefOptions.class
+              ? this.nymph.getEntityClass(qrefOptions.class)
+              : this.nymph.getEntityClass('Entity');
             const newOptions = {
               ...qrefOptions,
               class: QrefEntityClass,
@@ -637,7 +664,7 @@ export default abstract class NymphDriver {
             const newSelectors = this.formatSelectors(qrefSelectors, options);
             qrefs.push(
               [newOptions, ...newSelectors.selectors],
-              ...newSelectors.qrefs
+              ...newSelectors.qrefs,
             );
             formatArr[i] = [name, [newOptions, ...newSelectors.selectors]];
           }
@@ -685,12 +712,12 @@ export default abstract class NymphDriver {
 
   protected iterateSelectorsForQuery(
     selectors: FormattedSelector[],
-    callback: (
-      key: string,
-      value: any,
-      typeIsOr: boolean,
-      typeIsNot: boolean
-    ) => string
+    callback: (data: {
+      key: string;
+      value: any;
+      typeIsOr: boolean;
+      typeIsNot: boolean;
+    }) => string,
   ) {
     const queryParts = [];
     for (const curSelector of selectors) {
@@ -703,7 +730,7 @@ export default abstract class NymphDriver {
         if (key === 'type') {
           continue;
         }
-        let curQuery = callback(key, value, typeIsOr, typeIsNot);
+        let curQuery = callback({ key, value, typeIsOr, typeIsNot });
         if (curQuery) {
           if (curSelectorQuery) {
             curSelectorQuery += typeIsOr ? ' OR ' : ' AND ';
@@ -719,71 +746,14 @@ export default abstract class NymphDriver {
     return queryParts;
   }
 
-  /**
-   * Get the first entity to match all options/selectors, synchronously.
-   *
-   * This should really only be used internally by the Entity class. It's a bad
-   * idea to get entities synchronously. The Entity class uses this to load
-   * sleeping references.
-   *
-   * @param options The options.
-   * @param selectors Unlimited optional selectors to search for, or a single GUID. If none are given, all entities are searched for the given options.
-   * @returns An entity, or null on failure or nothing found.
-   */
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'count' },
-    ...selectors: Selector[]
-  ): number;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    ...selectors: Selector[]
-  ): string | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T>,
-    ...selectors: Selector[]
-  ): ReturnType<T['factorySync']> | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'count' },
-    guid: string
-  ): number;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> & { return: 'guid' },
-    guid: string
-  ): string | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T>,
-    guid: string
-  ): ReturnType<T['factorySync']> | null;
-  public getEntitySync<T extends EntityConstructor = EntityConstructor>(
-    options: Options<T> = {},
-    ...selectors: Selector[] | string[]
-  ): ReturnType<T['factorySync']> | string | number | null {
-    // Set up options and selectors.
-    if (typeof selectors[0] === 'string') {
-      selectors = [{ type: '&', guid: selectors[0] }];
-    }
-    options.limit = 1;
-    const entities = this.getEntitiesSync(
-      options,
-      ...(selectors as Selector[])
-    );
-    if (options.return === 'count') {
-      return entities as unknown as number;
-    }
-    if (!entities || !entities.length) {
-      return null;
-    }
-    return entities[0];
-  }
-
-  protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
+  protected getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'count' },
     selectors: Selector[],
-    performQueryCallback: (
-      options: Options<T>,
-      formattedSelectors: FormattedSelector[],
-      etype: string
-    ) => {
+    performQueryCallback: (data: {
+      options: Options<T>;
+      selectors: FormattedSelector[];
+      etype: string;
+    }) => {
       result: any;
     },
     rowFetchCallback: () => any,
@@ -798,16 +768,16 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): { result: any; process: () => number | Error };
-  protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
+  protected getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T> & { return: 'guid' },
     selectors: Selector[],
-    performQueryCallback: (
-      options: Options<T>,
-      formattedSelectors: FormattedSelector[],
-      etype: string
-    ) => {
+    performQueryCallback: (data: {
+      options: Options<T>;
+      selectors: FormattedSelector[];
+      etype: string;
+    }) => {
       result: any;
     },
     rowFetchCallback: () => any,
@@ -822,16 +792,16 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): { result: any; process: () => string[] | Error };
-  protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
+  protected getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
-    performQueryCallback: (
-      options: Options<T>,
-      formattedSelectors: FormattedSelector[],
-      etype: string
-    ) => {
+    performQueryCallback: (data: {
+      options: Options<T>;
+      selectors: FormattedSelector[];
+      etype: string;
+    }) => {
       result: any;
     },
     rowFetchCallback: () => any,
@@ -846,16 +816,19 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
-  ): { result: any; process: () => ReturnType<T['factorySync']>[] | Error };
-  protected getEntitesRowLike<T extends EntityConstructor = EntityConstructor>(
+    },
+  ): {
+    result: any;
+    process: () => EntityInstanceType<T>[] | Error;
+  };
+  protected getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
     options: Options<T>,
     selectors: Selector[],
-    performQueryCallback: (
-      options: Options<T>,
-      formattedSelectors: FormattedSelector[],
-      etype: string
-    ) => {
+    performQueryCallback: (data: {
+      options: Options<T>;
+      selectors: FormattedSelector[];
+      etype: string;
+    }) => {
       result: any;
     },
     rowFetchCallback: () => any,
@@ -870,10 +843,10 @@ export default abstract class NymphDriver {
     getDataNameAndSValueCallback: (row: any) => {
       name: string;
       svalue: string;
-    }
+    },
   ): {
     result: any;
-    process: () => ReturnType<T['factorySync']>[] | string[] | number | Error;
+    process: () => EntityInstanceType<T>[] | string[] | number | Error;
   } {
     if (!this.isConnected()) {
       throw new UnableToConnectError('not connected to DB');
@@ -886,12 +859,12 @@ export default abstract class NymphDriver {
         ['&', '!&', '|', '!|'].indexOf(selector.type) === -1
       ) {
         throw new InvalidParametersError(
-          'Invalid query selector passed: ' + JSON.stringify(selector)
+          'Invalid query selector passed: ' + JSON.stringify(selector),
         );
       }
     }
 
-    let entities: ReturnType<T['factorySync']>[] | string[] = [];
+    let entities: EntityInstanceType<T>[] | string[] = [];
     let count = 0;
     const EntityClass =
       options.class ?? (this.nymph.getEntityClass('Entity') as T);
@@ -901,6 +874,7 @@ export default abstract class NymphDriver {
     if (
       this.nymph.config.cache &&
       !options.skipCache &&
+      selectors.length &&
       'guid' in selectors[0] &&
       typeof selectors[0].guid === 'number'
     ) {
@@ -912,10 +886,10 @@ export default abstract class NymphDriver {
         (Object.keys(selectors[0]).length === 2 ||
           (Object.keys(selectors[0]).length === 3 && 'tag' in selectors[0]))
       ) {
-        const entity = this.pullCache<ReturnType<T['factorySync']>>(
+        const entity = this.pullCache<EntityInstanceType<T>>(
           selectors[0]['guid'],
           EntityClass.class,
-          !!options.skipAc
+          !!options.skipAc,
         );
         if (
           entity != null &&
@@ -924,7 +898,7 @@ export default abstract class NymphDriver {
             entity.hasTag(
               ...(Array.isArray(selectors[0].tag)
                 ? selectors[0].tag
-                : [selectors[0].tag])
+                : [selectors[0].tag]),
             ))
         ) {
           const guid = entity.guid;
@@ -946,15 +920,16 @@ export default abstract class NymphDriver {
     try {
       const formattedSelectors = this.formatSelectors(selectors, options);
       this.nymph.runQueryCallbacks(options, formattedSelectors.selectors);
-      for (let qref of formattedSelectors.qrefs) {
-        const [options, ...selectors] = qref;
+      for (let i = 0; i < formattedSelectors.qrefs.length; i++) {
+        const [options, ...selectors] = formattedSelectors.qrefs[i];
         this.nymph.runQueryCallbacks(options, selectors);
+        formattedSelectors.qrefs[i] = [options, ...selectors];
       }
-      const { result } = performQueryCallback(
+      const { result } = performQueryCallback({
         options,
-        formattedSelectors.selectors,
-        etype
-      );
+        selectors: formattedSelectors.selectors,
+        etype,
+      });
 
       return {
         result,
@@ -994,9 +969,7 @@ export default abstract class NymphDriver {
                 // Make sure that $row is incremented :)
                 row = rowFetchCallback();
               }
-              const entity = EntityClass.factorySync() as ReturnType<
-                T['factorySync']
-              >;
+              const entity = EntityClass.factorySync() as EntityInstanceType<T>;
               entity.$nymph = this.nymph;
               if (options.skipAc != null) {
                 entity.$useSkipAc(!!options.skipAc);
@@ -1036,34 +1009,37 @@ export default abstract class NymphDriver {
 
   protected async saveEntityRowLike(
     entity: EntityInterface,
-    saveNewEntityCallback: (
-      entity: EntityInterface,
-      guid: string,
-      tags: string[],
-      data: EntityData,
-      sdata: SerializedEntityData,
-      cdate: number,
-      etype: string
-    ) => Promise<boolean>,
-    saveExistingEntityCallback: (
-      entity: EntityInterface,
-      guid: string,
-      tags: string[],
-      data: EntityData,
-      sdata: SerializedEntityData,
-      mdate: number,
-      etype: string
-    ) => Promise<boolean>,
+    saveNewEntityCallback: (data: {
+      entity: EntityInterface;
+      guid: string;
+      tags: string[];
+      data: EntityData;
+      sdata: SerializedEntityData;
+      uniques: string[];
+      cdate: number;
+      etype: string;
+    }) => Promise<boolean>,
+    saveExistingEntityCallback: (data: {
+      entity: EntityInterface;
+      guid: string;
+      tags: string[];
+      data: EntityData;
+      sdata: SerializedEntityData;
+      uniques: string[];
+      mdate: number;
+      etype: string;
+    }) => Promise<boolean>,
     startTransactionCallback: (() => Promise<void>) | null = null,
     commitTransactionCallback:
       | ((success: boolean) => Promise<boolean>)
-      | null = null
+      | null = null,
   ) {
     // Get a modified date.
     const mdate = Date.now();
     const tags = difference(entity.tags, ['']);
     const data = entity.$getData();
     const sdata = entity.$getSData();
+    const uniques = await entity.$getUniques();
     const EntityClass = entity.constructor as EntityConstructor;
     const etype = EntityClass.ETYPE;
     if (startTransactionCallback) {
@@ -1073,15 +1049,16 @@ export default abstract class NymphDriver {
     if (entity.guid == null) {
       const cdate = mdate;
       const newId = guid();
-      success = await saveNewEntityCallback(
+      success = await saveNewEntityCallback({
         entity,
-        newId,
+        guid: newId,
         tags,
         data,
         sdata,
+        uniques,
         cdate,
-        etype
-      );
+        etype,
+      });
       if (success) {
         entity.guid = newId;
         entity.cdate = cdate;
@@ -1092,15 +1069,16 @@ export default abstract class NymphDriver {
       if (this.nymph.config.cache) {
         this.cleanCache(entity.guid);
       }
-      success = await saveExistingEntityCallback(
+      success = await saveExistingEntityCallback({
         entity,
-        entity.guid,
+        guid: entity.guid,
         tags,
         data,
         sdata,
+        uniques,
         mdate,
-        etype
-      );
+        etype,
+      });
       if (success) {
         entity.mdate = mdate;
       }
@@ -1116,7 +1094,7 @@ export default abstract class NymphDriver {
         entity.mdate as number,
         entity.tags,
         data,
-        sdata
+        sdata,
       );
     }
     return success;
@@ -1130,10 +1108,10 @@ export default abstract class NymphDriver {
    * @param useSkipAc Whether to tell the entity to use skip_ac.
    * @returns The entity or null if it's not cached.
    */
-  protected pullCache<T extends EntityInterface = EntityInterface>(
+  protected pullCache<T extends Entity>(
     guid: string,
     className: string,
-    useSkipAc = false
+    useSkipAc = false,
   ): T | null {
     // Increment the entity access count.
     if (!(guid in this.entityCount)) {
@@ -1151,7 +1129,7 @@ export default abstract class NymphDriver {
         entity.tags = this.entityCache[guid]['tags'];
         entity.$putData(
           this.entityCache[guid]['data'],
-          this.entityCache[guid]['sdata']
+          this.entityCache[guid]['sdata'],
         );
         return entity;
       }
@@ -1175,7 +1153,7 @@ export default abstract class NymphDriver {
     mdate: number,
     tags: string[],
     data: EntityData,
-    sdata: SerializedEntityData
+    sdata: SerializedEntityData,
   ) {
     if (guid == null) {
       return;
@@ -1204,7 +1182,7 @@ export default abstract class NymphDriver {
       // Find which entity has been accessed the least.
       const least =
         Object.entries(this.entityCount)
-          .sort(([guidA, countA], [guidB, countB]) => countA - countB)
+          .sort(([_guidA, countA], [_guidB, countB]) => countA - countB)
           .pop()?.[0] ?? null;
       if (least == null) {
         // This should never happen.