Class MySQLDriver

The MySQL Nymph database driver.

Hierarchy

default
- MySQLDriver

Constructors

constructor

new MySQLDriver(
    config: Partial<MySQLDriverConfig>,
    link?: Pool,
    transaction?: MySQLDriverTransaction,
): MySQLDriver
Parameters
- config: Partial<MySQLDriverConfig>
- Optionallink: Pool
- Optionaltransaction: MySQLDriverTransaction
Returns MySQLDriver
Overrides NymphDriver.constructor
- Defined in driver-mysql/src/MySQLDriver.ts:60

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.

`Protected`entityCount

entityCount: { [k: string]: number }

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

`Protected`link

link: Pool

`Protected`nymph

nymph: Nymph

`Protected`prefix

prefix: string

`Protected`tokenizer

tokenizer: Tokenizer

`Protected`transaction

transaction: MySQLDriverTransaction | null = null

Methods

addIndex

addIndex(
    etype: string,
    definition: {
        name: string;
        property: string;
        scope: "tokens" | "data" | "references";
    },
): Promise<boolean>
Parameters
- etype: string
- definition: { name: string; property: string; scope: "tokens" | "data" | "references" }
Returns Promise<boolean>
Overrides NymphDriver.addIndex
- Defined in driver-mysql/src/MySQLDriver.ts:818

checkData

checkData(
    etype: string,
    data: EntityData,
    sdata: SerializedEntityData,
    selectors: Selector[],
    guid?: string | null,
    tags?: string[] | null,
): boolean
Parameters
- etype: string
- data: EntityData
- sdata: SerializedEntityData
- selectors: Selector[]
- Optionalguid: string | null
- Optionaltags: string[] | null
Returns boolean
Inherited from NymphDriver.checkData
- Defined in nymph/dist/driver/NymphDriver.d.ts:134

checkIndexName

checkIndexName(name: string): void
Parameters
- name: string
Returns void
Inherited from NymphDriver.checkIndexName
- Defined in nymph/dist/driver/NymphDriver.d.ts:128

`Protected`cleanCache

cleanCache(guid: string): 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:140

clone

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

Returns MySQLDriver
A clone of this instance.
Overrides NymphDriver.clone
- Defined in driver-mysql/src/MySQLDriver.ts:94

commit

commit(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.commit
- Defined in driver-mysql/src/MySQLDriver.ts:651

connect

connect(): Promise<true>
Connect to the MySQL database.

Returns Promise<true>
Whether this instance is connected to a MySQL database.
Overrides NymphDriver.connect
- Defined in driver-mysql/src/MySQLDriver.ts:116

deleteEntity

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

deleteEntityByID

deleteEntityByID(
guid: string,
className?: string | EntityConstructor | null,
): Promise<boolean>
Parameters
- guid: string
- OptionalclassName: string | EntityConstructor | null
Returns Promise<boolean>
Overrides NymphDriver.deleteEntityByID
- Defined in driver-mysql/src/MySQLDriver.ts:674

deleteIndex

deleteIndex(
    etype: string,
    scope: "tokens" | "data" | "references",
    name: string,
): Promise<boolean>
Parameters
- etype: string
- scope: "tokens" | "data" | "references"
- name: string
Returns Promise<boolean>
Overrides NymphDriver.deleteIndex
- Defined in driver-mysql/src/MySQLDriver.ts:877

deleteUID

deleteUID(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.deleteUID
- Defined in driver-mysql/src/MySQLDriver.ts:757

disconnect

disconnect(): Promise<false>
Disconnect from the MySQL database.

Returns Promise<false>
Whether this instance is connected to a MySQL database.
Overrides NymphDriver.disconnect
- Defined in driver-mysql/src/MySQLDriver.ts:163

`Protected`entityReferenceSearch

entityReferenceSearch(
    value: any,
    entity:
        | string
        | EntityInterface
        | EntityReference
        | (string | EntityInterface | EntityReference)[],
): 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:149

export

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

exportDataIterator

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

exportPrint

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

`Protected`findReferences

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

formatSelectors

formatSelectors(
    selectors: Selector[],
    options?: Options,
): {
    qrefs: [Options, ...FormattedSelector[]][];
    selectors: FormattedSelector[];
}
Parameters
- selectors: Selector[]
- Optionaloptions: Options
Returns { qrefs: [Options, ...FormattedSelector[]][]; selectors: FormattedSelector[] }
Inherited from NymphDriver.formatSelectors
- Defined in nymph/dist/driver/NymphDriver.d.ts:160

getEntities

getEntities<T extends EntityConstructor = EntityConstructor>(
options: Options<T> & { return: "count" },
...selectors: Selector[],
): Promise<number>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "count" }
- ...selectors: Selector[]
Returns Promise<number>
Overrides NymphDriver.getEntities
- Defined in driver-mysql/src/MySQLDriver.ts:2559
getEntities<T extends EntityConstructor = EntityConstructor>(
options: Options<T> & { return: "guid" },
...selectors: Selector[],
): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "guid" }
- ...selectors: Selector[]
Returns Promise<string[]>
Overrides NymphDriver.getEntities
- Defined in driver-mysql/src/MySQLDriver.ts:2563
getEntities<T extends EntityConstructor = EntityConstructor>(
options: Options<T> & { return: "object" },
...selectors: Selector[],
): Promise<EntityObjectType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "object" }
- ...selectors: Selector[]
Returns Promise<EntityObjectType<T>[]>
Overrides NymphDriver.getEntities
- Defined in driver-mysql/src/MySQLDriver.ts:2567
getEntities<T extends EntityConstructor = EntityConstructor>(
options?: Options<T>,
...selectors: Selector[],
): Promise<EntityInstanceType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optionaloptions: Options<T>
- ...selectors: Selector[]
Returns Promise<EntityInstanceType<T>[]>
Overrides NymphDriver.getEntities
- Defined in driver-mysql/src/MySQLDriver.ts:2571

`Protected`getEntitiesRowLike

getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
    options: Options<T> & { return: "count" },
    selectors: Selector[],
    performQueryCallback: (
        data: {
            etype: string;
            options: Options<T>;
            selectors: FormattedSelector[];
        },
    ) => { result: any },
    rowFetchCallback: () => any,
    freeResultCallback: () => void,
    getCountCallback: (row: any) => number,
    getGUIDCallback: (row: any) => string,
    getTagsAndDatesCallback: (
        row: any,
    ) => { cdate: number; mdate: number; tags: string[] },
    getDataNameAndSValueCallback: (
        row: any,
    ) => { name: string; svalue: string },
): { process: () => number | Error; result: any }
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "count" }
- selectors: Selector[]
- performQueryCallback: (
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      },
  ) => { result: any }
- rowFetchCallback: () => any
- freeResultCallback: () => void
- getCountCallback: (row: any) => number
- getGUIDCallback: (row: any) => string
- getTagsAndDatesCallback: (row: any) => { cdate: number; mdate: number; tags: string[] }
- getDataNameAndSValueCallback: (row: any) => { name: string; svalue: string }
Returns { process: () => number | Error; result: any }
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:170
getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
    options: Options<T> & { return: "guid" },
    selectors: Selector[],
    performQueryCallback: (
        data: {
            etype: string;
            options: Options<T>;
            selectors: FormattedSelector[];
        },
    ) => { result: any },
    rowFetchCallback: () => any,
    freeResultCallback: () => void,
    getCountCallback: (row: any) => number,
    getGUIDCallback: (row: any) => string,
    getTagsAndDatesCallback: (
        row: any,
    ) => { cdate: number; mdate: number; tags: string[] },
    getDataNameAndSValueCallback: (
        row: any,
    ) => { name: string; svalue: string },
): { process: () => Error | string[]; result: any }
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "guid" }
- selectors: Selector[]
- performQueryCallback: (
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      },
  ) => { result: any }
- rowFetchCallback: () => any
- freeResultCallback: () => void
- getCountCallback: (row: any) => number
- getGUIDCallback: (row: any) => string
- getTagsAndDatesCallback: (row: any) => { cdate: number; mdate: number; tags: string[] }
- getDataNameAndSValueCallback: (row: any) => { name: string; svalue: string }
Returns { process: () => Error | string[]; result: any }
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:189
getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
    options: Options<T> & { return: "object" },
    selectors: Selector[],
    performQueryCallback: (
        data: {
            etype: string;
            options: Options<T>;
            selectors: FormattedSelector[];
        },
    ) => { result: any },
    rowFetchCallback: () => any,
    freeResultCallback: () => void,
    getCountCallback: (row: any) => number,
    getGUIDCallback: (row: any) => string,
    getTagsAndDatesCallback: (
        row: any,
    ) => { cdate: number; mdate: number; tags: string[] },
    getDataNameAndSValueCallback: (
        row: any,
    ) => { name: string; svalue: string },
): { process: () => Error | EntityObjectType<T>[]; result: any }
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & { return: "object" }
- selectors: Selector[]
- performQueryCallback: (
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      },
  ) => { result: any }
- rowFetchCallback: () => any
- freeResultCallback: () => void
- getCountCallback: (row: any) => number
- getGUIDCallback: (row: any) => string
- getTagsAndDatesCallback: (row: any) => { cdate: number; mdate: number; tags: string[] }
- getDataNameAndSValueCallback: (row: any) => { name: string; svalue: string }
Returns { process: () => Error | EntityObjectType<T>[]; result: any }
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:208
getEntitiesRowLike<T extends EntityConstructor = EntityConstructor>(
    options: Options<T>,
    selectors: Selector[],
    performQueryCallback: (
        data: {
            etype: string;
            options: Options<T>;
            selectors: FormattedSelector[];
        },
    ) => { result: any },
    rowFetchCallback: () => any,
    freeResultCallback: () => void,
    getCountCallback: (row: any) => number,
    getGUIDCallback: (row: any) => string,
    getTagsAndDatesCallback: (
        row: any,
    ) => { cdate: number; mdate: number; tags: string[] },
    getDataNameAndSValueCallback: (
        row: any,
    ) => { name: string; svalue: string },
): { process: () => Error | EntityInstanceType<T>[]; result: any }
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T>
- selectors: Selector[]
- performQueryCallback: (
      data: {
          etype: string;
          options: Options<T>;
          selectors: FormattedSelector[];
      },
  ) => { result: any }
- rowFetchCallback: () => any
- freeResultCallback: () => void
- getCountCallback: (row: any) => number
- getGUIDCallback: (row: any) => string
- getTagsAndDatesCallback: (row: any) => { cdate: number; mdate: number; tags: string[] }
- getDataNameAndSValueCallback: (row: any) => { name: string; svalue: string }
Returns { process: () => Error | EntityInstanceType<T>[]; result: any }
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:227

getEtypes

getEtypes(): Promise<string[]>
Returns Promise<string[]>
Overrides NymphDriver.getEtypes
- Defined in driver-mysql/src/MySQLDriver.ts:926

getIndexes

getIndexes(
    etype: string,
): Promise<
    {
        name: string;
        property: string;
        scope: "tokens"
        | "data"
        | "references";
    }[],
>
Parameters
- etype: string
Returns Promise<
    {
        name: string;
        property: string;
        scope: "tokens"
        | "data"
        | "references";
    }[],
>
Overrides NymphDriver.getIndexes
- Defined in driver-mysql/src/MySQLDriver.ts:774

getUID

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

import

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

importData

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

importDataIterator

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

importEntity

importEntity(
    entity: {
        cdate: number;
        etype: string;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    },
): Promise<void>
Parameters
- entity: {
      cdate: number;
      etype: string;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }
Returns Promise<void>
Overrides NymphDriver.importEntity
- Defined in driver-mysql/src/MySQLDriver.ts:2651

importEntityTilmeldAC

importEntityTilmeldAC(
    entity: {
        cdate: number;
        etype: string;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    },
): Promise<void>
Parameters
- entity: {
      cdate: number;
      etype: string;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }
Returns Promise<void>
Overrides NymphDriver.importEntityTilmeldAC
- Defined in driver-mysql/src/MySQLDriver.ts:2673

importEntityTokens

importEntityTokens(
    entity: {
        cdate: number;
        etype: string;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    },
): Promise<void>
Parameters
- entity: {
      cdate: number;
      etype: string;
      guid: string;
      mdate: number;
      sdata: SerializedEntityData;
      tags: string[];
  }
Returns Promise<void>
Overrides NymphDriver.importEntityTokens
- Defined in driver-mysql/src/MySQLDriver.ts:2662

importUID

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

init

init(nymph: 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:126

`Protected`internalTransaction

internalTransaction(name: string): Promise<MySQLDriverTransaction>
Parameters
- name: string
Returns Promise<MySQLDriverTransaction>
Overrides NymphDriver.internalTransaction
- Defined in driver-mysql/src/MySQLDriver.ts:3529

inTransaction

inTransaction(): Promise<boolean>
Returns Promise<boolean>
Overrides NymphDriver.inTransaction
- Defined in driver-mysql/src/MySQLDriver.ts:171

isConnected

isConnected(): boolean
Check connection status.

Returns boolean
Whether this instance is connected to a MySQL database.
Overrides NymphDriver.isConnected
- Defined in driver-mysql/src/MySQLDriver.ts:183

`Protected`iterateSelectorsForQuery

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

liveMigration

liveMigration(
migrationType: "tilmeldColumns" | "tokenTables" | "tilmeldRemoveOldRows",
): Promise<void>
Parameters
- migrationType: "tilmeldColumns" | "tokenTables" | "tilmeldRemoveOldRows"
Returns Promise<void>
Overrides NymphDriver.liveMigration
- Defined in driver-mysql/src/MySQLDriver.ts:3694

needsMigration

needsMigration(): Promise<false | "json" | "tokens" | "tilmeldColumns">
Returns Promise<false | "json" | "tokens" | "tilmeldColumns">
Overrides NymphDriver.needsMigration
- Defined in driver-mysql/src/MySQLDriver.ts:3630

newUID

newUID(name: string): Promise<number | null>
Parameters
- name: string
Returns Promise<number | null>
Overrides NymphDriver.newUID
- Defined in driver-mysql/src/MySQLDriver.ts:3005

`Protected`performQuery

performQuery(
    options: Options,
    formattedSelectors: FormattedSelector[],
    etype: string,
): { result: any }
Parameters
- options: Options
- formattedSelectors: FormattedSelector[]
- etype: string
Returns { result: any }
- Defined in driver-mysql/src/MySQLDriver.ts:2539

`Protected`posixRegexMatch

posixRegexMatch(
    pattern: string,
    subject: string,
    caseInsensitive?: boolean,
): boolean
Parameters
- pattern: string
- subject: string
- OptionalcaseInsensitive: boolean
Returns boolean
Inherited from NymphDriver.posixRegexMatch
- Defined in nymph/dist/driver/NymphDriver.d.ts:127

`Protected`pullCache

pullCache(
    guid: string,
):
    | {
        cdate: number;
        data: EntityData;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    }
    | null
Pull an entity from the cache.
Parameters
- guid: string
  The entity's GUID.
Returns
    | {
        cdate: number;
        data: EntityData;
        guid: string;
        mdate: number;
        sdata: SerializedEntityData;
        tags: string[];
    }
    | null
The entity's data or null if it's not cached.
Inherited from NymphDriver.pullCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:269

`Protected`pushCache

pushCache(
    guid: string,
    cdate: number,
    mdate: number,
    tags: string[],
    data: EntityData,
    sdata: SerializedEntityData,
): 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:287

`Protected`removeAndReturnACValues

removeAndReturnACValues(
    etype: string,
    data: EntityData,
    sdata: SerializedEntityData,
): {
    acFull: string[] | null;
    acGroup: number | null;
    acOther: number | null;
    acRead: string[] | null;
    acUser: number | null;
    acWrite: string[] | null;
    group: string | null;
    user: string | null;
}
Parameters
- etype: string
- data: EntityData
- sdata: SerializedEntityData
Returns {
    acFull: string[] | null;
    acGroup: number | null;
    acOther: number | null;
    acRead: string[] | null;
    acUser: number | null;
    acWrite: string[] | null;
    group: string | null;
    user: string | null;
}
Inherited from NymphDriver.removeAndReturnACValues
- Defined in nymph/dist/driver/NymphDriver.d.ts:150

renameUID

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

rollback

rollback(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.rollback
- Defined in driver-mysql/src/MySQLDriver.ts:3081

saveEntity

saveEntity(entity: EntityInterface): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
Overrides NymphDriver.saveEntity
- Defined in driver-mysql/src/MySQLDriver.ts:3104

`Protected`saveEntityRowLike

saveEntityRowLike(
    entity: EntityInterface,
    saveNewEntityCallback: (
        data: {
            cdate: number;
            data: EntityData;
            entity: EntityInterface;
            etype: string;
            guid: string;
            sdata: SerializedEntityData;
            tags: string[];
            uniques: string[];
        },
    ) => Promise<boolean>,
    saveExistingEntityCallback: (
        data: {
            data: EntityData;
            entity: EntityInterface;
            etype: string;
            guid: string;
            mdate: number;
            sdata: SerializedEntityData;
            tags: string[];
            uniques: string[];
        },
    ) => Promise<boolean>,
    startTransactionCallback?: (() => Promise<void>) | null,
    commitTransactionCallback?: ((success: boolean) => Promise<boolean>) | null,
): Promise<boolean>
Parameters
- entity: EntityInterface
- saveNewEntityCallback: (
      data: {
          cdate: number;
          data: EntityData;
          entity: EntityInterface;
          etype: string;
          guid: string;
          sdata: SerializedEntityData;
          tags: string[];
          uniques: string[];
      },
  ) => Promise<boolean>
- saveExistingEntityCallback: (
      data: {
          data: EntityData;
          entity: EntityInterface;
          etype: string;
          guid: string;
          mdate: number;
          sdata: SerializedEntityData;
          tags: string[];
          uniques: string[];
      },
  ) => Promise<boolean>
- OptionalstartTransactionCallback: (() => Promise<void>) | null
- OptionalcommitTransactionCallback: ((success: boolean) => Promise<boolean>) | null
Returns Promise<boolean>
Inherited from NymphDriver.saveEntityRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:244

setUID

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

startTransaction

startTransaction(name: string): Promise<Nymph>
Parameters
- name: string
Returns Promise<Nymph>
Overrides NymphDriver.startTransaction
- Defined in driver-mysql/src/MySQLDriver.ts:3557

`Static`escape

escape(input: string): string
Parameters
- input: string
Returns string
- Defined in driver-mysql/src/MySQLDriver.ts:52

`Static`escapeValue

escapeValue(input: string): string
Parameters
- input: string
Returns string
- Defined in driver-mysql/src/MySQLDriver.ts:56

Class MySQLDriver

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MySQLDriver

Properties

config

Protectedconnected

ProtectedentityCache

ProtectedentityCount

Protectedlink

Protectednymph

Protectedprefix

Protectedtokenizer

Protectedtransaction

Methods

addIndex

Parameters

Returns Promise<boolean>

checkData

Parameters

Returns boolean

checkIndexName

Parameters

Returns void

ProtectedcleanCache

Parameters

Returns void

clone

Returns MySQLDriver

commit

Parameters

Returns Promise<boolean>

connect

Returns Promise<true>

deleteEntity

Parameters

Returns Promise<boolean>

deleteEntityByID

Parameters

Returns Promise<boolean>

deleteIndex

Parameters

Returns Promise<boolean>

deleteUID

Parameters

Returns Promise<boolean>

disconnect

Returns Promise<false>

ProtectedentityReferenceSearch

Parameters

Returns boolean

export

Parameters

Returns Promise<boolean>

exportDataIterator

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

exportPrint

Returns Promise<boolean>

ProtectedfindReferences

Parameters

Returns string[]

formatSelectors

Parameters

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

getEntities

Type Parameters

Parameters

Returns Promise<number>

Type Parameters

Parameters

Returns Promise<string[]>

Type Parameters

Parameters

Returns Promise<EntityObjectType<T>[]>

`Protected`connected

`Protected`entityCache

`Protected`entityCount

`Protected`link

`Protected`nymph

`Protected`prefix

`Protected`tokenizer

`Protected`transaction

`Protected`cleanCache

`Protected`entityReferenceSearch

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

`Protected`findReferences

`Protected`getEntitiesRowLike

Returns Promise<
{
name: string;
property: string;
scope: "tokens"
| "data"
| "references";
}[],
>

`Protected`internalTransaction

`Protected`iterateSelectorsForQuery

`Protected`performQuery

`Protected`posixRegexMatch