Class PostgreSQLDriver

The PostgreSQL Nymph database driver.

Hierarchy (view full)

NymphDriver
- PostgreSQLDriver

Constructors

constructor

new PostgreSQLDriver(config, link?, transaction?): PostgreSQLDriver
Parameters
- config: Partial<PostgreSQLDriverConfig>
- Optionallink: Pool
- Optionaltransaction: PostgreSQLDriverTransaction
Returns PostgreSQLDriver
Overrides NymphDriver.constructor
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:100

Properties

config

config: PostgreSQLDriverConfig

`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: null | PostgreSQLDriverTransaction = null

Methods

checkData

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

`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
Inherited from NymphDriver.cleanCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:123

clone

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

Returns PostgreSQLDriver
A clone of this instance.
Overrides NymphDriver.clone
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:134

commit

commit(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.commit
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:1095

connect

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

Returns Promise<true>
Whether this instance is connected to a PostgreSQL database.
Overrides NymphDriver.connect
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:168

deleteEntity

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

deleteEntityByID

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

deleteUID

deleteUID(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.deleteUID
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:1199

disconnect

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

Returns Promise<false>
Whether this instance is connected to a PostgreSQL database.
Overrides NymphDriver.disconnect
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:224

`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.
Inherited from NymphDriver.entityReferenceSearch
- Defined in nymph/dist/driver/NymphDriver.d.ts:132

export

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

exportDataIterator

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

exportPrint

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

`Protected`findReferences

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

formatSelectors

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

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>
Overrides NymphDriver.getEntities
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2538
getEntities<T>(options, ...selectors): Promise<string[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "guid";
  }
- Rest...selectors: Selector[]
Returns Promise<string[]>
Overrides NymphDriver.getEntities
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2542
getEntities<T>(options, ...selectors): Promise<EntityObjectType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- options: Options<T> & {
  return: "object";
  }
- Rest...selectors: Selector[]
Returns Promise<EntityObjectType<T>[]>
Overrides NymphDriver.getEntities
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2546
getEntities<T>(options?, ...selectors): Promise<EntityInstanceType<T>[]>
Type Parameters
- T extends EntityConstructor = EntityConstructor
Parameters
- Optionaloptions: Options<T>
- Rest...selectors: Selector[]
Returns Promise<EntityInstanceType<T>[]>
Overrides NymphDriver.getEntities
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2550

`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: {
      etype: string;
      options: Options<T>;
      selectors: FormattedSelector[];
  }) => {
      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: any) => number)
  - - (row): number
    - Parameters
      row: any
      Returns number
- getGUIDCallback: ((row: any) => string)
  - - (row): string
    - Parameters
      row: any
      Returns string
- getTagsAndDatesCallback: ((row: any) => {
      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: any) => {
  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
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:143
getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
process: (() => string[] | Error);
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;
  })
  - - (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: any) => number)
  - - (row): number
    - Parameters
      row: any
      Returns number
- getGUIDCallback: ((row: any) => string)
  - - (row): string
    - Parameters
      row: any
      Returns string
- getTagsAndDatesCallback: ((row: any) => {
      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: any) => {
  name: string;
  svalue: string;
  })
  - - (row): {
      name: string;
      svalue: string;
      }
    - Parameters
      row: any
      Returns {
      name: string;
      svalue: string;
      }
      name: string
      svalue: string
Returns {
process: (() => string[] | Error);
result: any;
}
- process: (() => string[] | Error)
  - - (): string[] | Error
    - Returns string[] | Error
- result: any
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:162
getEntitiesRowLike<T>(options, selectors, performQueryCallback, rowFetchCallback, freeResultCallback, getCountCallback, getGUIDCallback, getTagsAndDatesCallback, getDataNameAndSValueCallback): {
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;
  })
  - - (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: any) => number)
  - - (row): number
    - Parameters
      row: any
      Returns number
- getGUIDCallback: ((row: any) => string)
  - - (row): string
    - Parameters
      row: any
      Returns string
- getTagsAndDatesCallback: ((row: any) => {
      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: any) => {
  name: string;
  svalue: string;
  })
  - - (row): {
      name: string;
      svalue: string;
      }
    - Parameters
      row: any
      Returns {
      name: string;
      svalue: string;
      }
      name: string
      svalue: string
Returns {
process: (() => Error | EntityObjectType<T>[]);
result: any;
}
- process: (() => Error | EntityObjectType<T>[])
  - - (): Error | EntityObjectType<T>[]
    - Returns Error | EntityObjectType<T>[]
- result: any
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:181
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: {
      etype: string;
      options: Options<T>;
      selectors: FormattedSelector[];
  }) => {
      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: any) => number)
  - - (row): number
    - Parameters
      row: any
      Returns number
- getGUIDCallback: ((row: any) => string)
  - - (row): string
    - Parameters
      row: any
      Returns string
- getTagsAndDatesCallback: ((row: any) => {
      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: any) => {
  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
Inherited from NymphDriver.getEntitiesRowLike
- Defined in nymph/dist/driver/NymphDriver.d.ts:200

getEtypes

getEtypes(): Promise<string[]>
Returns a list of the etypes stored in the DB.

Returns Promise<string[]>
Overrides NymphDriver.getEtypes
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:1216

getUID

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

import

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

importData

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

importDataIterator

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

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>
Overrides NymphDriver.importEntity
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2618

importEntityTokens

importEntityTokens(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>
Overrides NymphDriver.importEntityTokens
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2629

importUID

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

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
Inherited from NymphDriver.init
- Defined in nymph/dist/driver/NymphDriver.d.ts:110

`Protected`internalTransaction

internalTransaction(name): Promise<PostgreSQLDriverTransaction>
Parameters
- name: string
Returns Promise<PostgreSQLDriverTransaction>
Overrides NymphDriver.internalTransaction
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3425

inTransaction

inTransaction(): Promise<boolean>
Returns Promise<boolean>
Overrides NymphDriver.inTransaction
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:232

isConnected

isConnected(): boolean
Check connection status.

Returns boolean
Whether this instance is connected to a PostgreSQL database.
Overrides NymphDriver.isConnected
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:244

`Protected`iterateSelectorsForQuery

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

liveMigration

liveMigration(_migrationType): Promise<void>
Parameters
- _migrationType: "tokenTables"
Returns Promise<void>
Overrides NymphDriver.liveMigration
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3501

needsMigration

needsMigration(): Promise<false | "json" | "tokens">
Returns Promise<false | "json" | "tokens">
Overrides NymphDriver.needsMigration
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3462

newUID

newUID(name): Promise<number>
Parameters
- name: string
Returns Promise<number>
Overrides NymphDriver.newUID
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2935

`Protected`performQuery

performQuery(options, formattedSelectors, etype): {
result: any;
}
Parameters
- options: Options
- formattedSelectors: FormattedSelector[]
- etype: string
Returns {
result: any;
}
- result: any
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:2518

`Protected`posixRegexMatch

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

`Protected`pullCache

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

`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
Inherited from NymphDriver.pushCache
- Defined in nymph/dist/driver/NymphDriver.d.ts:260

renameUID

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

rollback

rollback(name): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Overrides NymphDriver.rollback
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3008

saveEntity

saveEntity(entity): Promise<boolean>
Parameters
- entity: EntityInterface
Returns Promise<boolean>
Overrides NymphDriver.saveEntity
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3031

`Protected`saveEntityRowLike

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

setUID

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

startTransaction

startTransaction(name): Promise<Nymph>
Parameters
- name: string
Returns Promise<Nymph>
Overrides NymphDriver.startTransaction
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:3449

`Static`escape

escape(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:58

`Static`escapeNulls

escapeNulls(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:87

`Static`escapeNullSequences

escapeNullSequences(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:66

`Static`escapeValue

escapeValue(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:62

`Static`unescapeNulls

unescapeNulls(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:94

`Static`unescapeNullSequences

unescapeNullSequences(input): string
Parameters
- input: string
Returns string
- Defined in driver-postgresql/src/PostgreSQLDriver.ts:80

Class PostgreSQLDriver

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PostgreSQLDriver

Properties

config

Protectedconnected

ProtectedentityCache

ProtectedentityCount

Protectedlink

Protectednymph

Protectedprefix

Protectedtokenizer

Protectedtransaction

Methods

checkData

Parameters

Returns boolean

ProtectedcleanCache

Parameters

Returns void

clone

Returns PostgreSQLDriver

commit

Parameters

Returns Promise<boolean>

connect

Returns Promise<true>

deleteEntity

Parameters

Returns Promise<boolean>

deleteEntityByID

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, undefined | false>

exportPrint

Returns Promise<boolean>

ProtectedfindReferences

Parameters

Returns string[]

formatSelectors

Parameters

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

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

Type Parameters

Parameters

Returns Promise<EntityInstanceType<T>[]>

ProtectedgetEntitiesRowLike

Type Parameters

Parameters

Parameters

`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, undefined | false>

`Protected`findReferences

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

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

Returns {
result: any;
}

Returns {
cdate: number;
mdate: number;
tags: string[];
}