Class MySQLDriver

The MySQL Nymph database driver.

Hierarchy (view full)

Constructors

constructor

Properties

config connected entityCache entityCount link mysqlConfig nymph prefix transaction

Methods

checkData cleanCache clone commit connect createTables deleteEntity deleteEntityByID deleteUID disconnect entityReferenceSearch export exportDataIterator exportPrint findReferences formatSelectors getConnection getEntities getEntitiesRowLike getUID import importData importDataIterator importEntity importUID inTransaction init internalTransaction isConnected iterateSelectorsForQuery makeEntityQuery needsMigration newUID performQuery posixRegexMatch pullCache pushCache query queryGet queryIter queryRun renameUID rollback saveEntity saveEntityRowLike setUID startTransaction translateQuery escape escapeValue

Constructors

constructor

Properties

config

config: MySQLDriverConfig

Protected connected

connected: boolean = false

Protected entityCache

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

A cache to make entity retrieval faster.

Type declaration

Protected entityCount

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

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

Type declaration

  • [k: string]: number

Protected link

link: Pool

Private mysqlConfig

mysqlConfig: PoolOptions

Protected nymph

nymph: Nymph

Protected prefix

prefix: string

Protected transaction

transaction: null | MySQLDriverTransaction = null

Methods

checkData

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

clone

commit

connect

Private createTables

  • createTables(etype?): Promise<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 Promise<boolean>

    True on success, false on failure.

deleteEntity

deleteEntityByID

deleteUID

disconnect

Protected entityReferenceSearch

export

  • export(filename): Promise<boolean>

  • Parameters

    • filename: string

    Returns Promise<boolean>

exportDataIterator

  • exportDataIterator(): AsyncGenerator<{
        content: string;
        type: "comment" | "uid" | "entity";
    }, void, undefined | false>

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

exportPrint

  • exportPrint(): Promise<boolean>

  • Returns Promise<boolean>

Protected findReferences

  • findReferences(svalue): string[]

  • Parameters

    • svalue: string

    Returns string[]

formatSelectors

Private getConnection

getEntities

Protected getEntitiesRowLike

  • getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
        process: (() => number | Error);
        result: any;
    }

  • Type Parameters

    Parameters

    • options: Options<T> & {
          return: "count";
      }
    • selectors: Selector[]
    • performQueryCallback: ((data) => {
          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

    Parameters

    • options: Options<T> & {
          return: "guid";
      }
    • selectors: Selector[]
    • performQueryCallback: ((data) => {
          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

    Parameters

    • options: Options<T>
    • selectors: Selector[]
    • performQueryCallback: ((data) => {
          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;
    }

getUID

import

  • import(filename, transaction?): Promise<boolean>

  • Parameters

    • filename: string
    • Optional transaction: boolean

    Returns Promise<boolean>

importData

  • importData(text, transaction?): Promise<boolean>

  • Parameters

    • text: string
    • Optional transaction: boolean

    Returns Promise<boolean>

importDataIterator

  • importDataIterator(lines, transaction?): Promise<boolean>

  • Parameters

    • lines: Iterable<string>
    • Optional transaction: boolean

    Returns Promise<boolean>

importEntity

importUID

inTransaction

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

Protected internalTransaction

isConnected

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

Private makeEntityQuery

  • makeEntityQuery(options, formattedSelectors, etype, count?, params?, subquery?, tableSuffix?, etypes?, guidSelector?): {
        etypes: string[];
        params: {
            [k: string]: any;
        };
        query: string;
    }

  • Generate the MySQL 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

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>

newUID

Protected performQuery

Protected posixRegexMatch

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

  • Parameters

    • pattern: string
    • subject: string
    • Optional caseInsensitive: boolean

    Returns boolean

Protected pullCache

  • pullCache<T>(guid, className, useSkipAc?): null | T

  • Pull an entity from the cache.

    Type Parameters

    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.

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

Private query

  • query<T>(runQuery, query, etypes?): ReturnType<T>

  • Type Parameters

    • T extends (() => any)

    Parameters

    • runQuery: T
    • query: string
    • etypes: string[] = []

    Returns ReturnType<T>

Private queryGet

  • queryGet(query, __namedParameters?): Promise<any>

  • Parameters

    • query: string
    • __namedParameters: {
          etypes?: string[];
          params?: {
              [k: string]: any;
          };
      } = {}
      • Optional etypes?: string[]
      • Optional params?: {
            [k: string]: any;
        }
        • [k: string]: any

    Returns Promise<any>

Private queryIter

  • queryIter(query, __namedParameters?): Promise<any>

  • Parameters

    • query: string
    • __namedParameters: {
          etypes?: string[];
          params?: {
              [k: string]: any;
          };
      } = {}
      • Optional etypes?: string[]
      • Optional params?: {
            [k: string]: any;
        }
        • [k: string]: any

    Returns Promise<any>

Private queryRun

  • queryRun(query, __namedParameters?): Promise<{
        changes: any;
    }>

  • Parameters

    • query: string
    • __namedParameters: {
          etypes?: string[];
          params?: {
              [k: string]: any;
          };
      } = {}
      • Optional etypes?: string[]
      • Optional params?: {
            [k: string]: any;
        }
        • [k: string]: any

    Returns Promise<{
        changes: any;
    }>

renameUID

rollback

saveEntity

Protected saveEntityRowLike

  • saveEntityRowLike(entity, saveNewEntityCallback, saveExistingEntityCallback, startTransactionCallback?, commitTransactionCallback?): Promise<boolean>

  • Parameters

    • entity: EntityInterface
    • saveNewEntityCallback: ((data) => Promise<boolean>)
    • saveExistingEntityCallback: ((data) => Promise<boolean>)
    • Optional startTransactionCallback: null | (() => Promise<void>)
    • Optional commitTransactionCallback: null | ((success) => Promise<boolean>)

    Returns Promise<boolean>

setUID

startTransaction

Private translateQuery

  • translateQuery(origQuery, origParams): {
        params: any[];
        query: string;
    }

  • Parameters

    • origQuery: string
    • origParams: {
          [k: string]: any;
      }
      • [k: string]: any

    Returns {
        params: any[];
        query: string;
    }

    • params: any[]
    • query: string

Static escape

Static escapeValue

Settings

Member Visibility

Theme

On This Page

constructorconfigconnectedentityCacheentityCountlinkmysqlConfignymphprefixtransactioncheckDatacleanCacheclonecommitconnectcreateTablesdeleteEntitydeleteEntityByIDdeleteUIDdisconnectentityReferenceSearchexportexportDataIteratorexportPrintfindReferencesformatSelectorsgetConnectiongetEntitiesgetEntitiesRowLikegetUIDimportimportDataimportDataIteratorimportEntityimportUIDinTransactioninitinternalTransactionisConnectediterateSelectorsForQuerymakeEntityQueryneedsMigrationnewUIDperformQueryposixRegexMatchpullCachepushCachequeryqueryGetqueryIterqueryRunrenameUIDrollbacksaveEntitysaveEntityRowLikesetUIDstartTransactiontranslateQueryescapeescapeValue