Class UFMysqlDatabase

UFMysqlDatabase implements UFDatabase for use with mysql using the promise version of the mysql2 library. The class uses the pooling functionality to share connections.

Hierarchy

UFDatabase<RowDataPacket>
- UFMysqlDatabase

Index

Constructors

constructor

Methods

convertRow delete field fieldAs fieldOrFailAs getUniqueCode init insert insertObject processSqlParameters row rowAs rowOrFailAs rows rowsAs transaction update updateObject

Constructors

constructor

new UFMysqlDatabase(aLog: IUFLog): UFMysqlDatabase
Constructs an instance of UFMysqlDatabase.
Parameters
- aLog: IUFLog
  
  Log to use
Returns UFMysqlDatabase
Overrides UFDatabase<RowDataPacket>.constructor
- Defined in src/data/UFMysqlDatabase.ts:116

Methods

`Protected` convertRow

convertRow<T>(aRow: RowDataPacket): T
Converts a row from database type to an external type. The default implementation just uses a typecast.

Returns
The data from aRow as new type.
Type Parameters
- T
Parameters
- aRow: RowDataPacket
  
  Row to convert.
Returns T
Inherited from UFDatabase.convertRow
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:135

delete

delete(aSql: string, aParameterValues?: IUFDynamicObject): Promise<number>
Inherit Doc
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<number>
Inherited from UFDatabase.delete
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:84

`Protected` field

field(aSql: string, aParameterValues?: IUFDynamicObject, aDefault?: any): Promise<any>
Inherit Doc
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
- aDefault: any = undefined
Returns Promise<any>
Overrides UFDatabase.field
- Defined in src/data/UFMysqlDatabase.ts:221

fieldAs

fieldAs<T>(aSql: string, aParameterValues: IUFDynamicObject, aDefault: T): Promise<T>
Inherit Doc
Type Parameters
- T
Parameters
- aSql: string
- aParameterValues: IUFDynamicObject
- aDefault: T
Returns Promise<T>
Inherited from UFDatabase.fieldAs
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:44

fieldOrFailAs

fieldOrFailAs<T>(aSql: string, aParameterValues?: IUFDynamicObject): Promise<T>
Inherit Doc
Type Parameters
- T
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<T>
Inherited from UFDatabase.fieldOrFailAs
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:48

getUniqueCode

getUniqueCode(aTable: string, aColumn: string, aLength: number): Promise<string>
Inherit Doc
Parameters
- aTable: string
- aColumn: string
- aLength: number
Returns Promise<string>
Inherited from UFDatabase.getUniqueCode
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:88

init

init(aHost: string, aDatabase: string, anUser: string, aPassword: string): Promise<void>
Initializes the database.
Parameters
- aHost: string
  
  Server address
- aDatabase: string
  
  Name of database
- anUser: string
  
  Name of user to log in with
- aPassword: string
  
  Password to use with login
Returns Promise<void>
- Defined in src/data/UFMysqlDatabase.ts:137

insert

insert(aSql: string, aParameterValues: IUFDynamicObject): Promise<number>
Inherit Doc
Parameters
- aSql: string
- aParameterValues: IUFDynamicObject
Returns Promise<number>
Overrides UFDatabase.insert
- Defined in src/data/UFMysqlDatabase.ts:161

insertObject

insertObject<T>(aTable: string, aData: T, aPrimaryKey?: string, anIgnoreFields?: string[]): Promise<T>
Inherit Doc
Type Parameters
- T extends object
Parameters
- aTable: string
- aData: T
- Optional aPrimaryKey: string
- Optional anIgnoreFields: string[]
Returns Promise<T>
Inherited from UFDatabase.insertObject
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:56

`Protected` processSqlParameters

processSqlParameters(aSql: string, aParameterValues: IUFDynamicObject, aCallback: ((aName: string, aValue: any) => string)): string
Processes a sql with named parameters and replaces the named parameters with values returned by the callback.

Returns
an updated SQL statement
Parameters
- aSql: string
  
  Sql statement to process.
- aParameterValues: IUFDynamicObject
  
  An object that contains properties whose name match the named parameters
- aCallback: ((aName: string, aValue: any) => string)
  
  This callback is invoked for every found named parameter. The result will be used to replace the named parameter.
  - - (aName: string, aValue: any): string
    - Parameters
      
      aName: string
      
      aValue: any
      
      Returns string
Returns string
Inherited from UFDatabase.processSqlParameters
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:148

`Protected` row

row(aSql: string, aParameterValues?: IUFDynamicObject): Promise<undefined | RowDataPacket>
Inherit Doc
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<undefined | RowDataPacket>
Overrides UFDatabase.row
- Defined in src/data/UFMysqlDatabase.ts:213

rowAs

rowAs<T>(aSql: string, aParameterValues?: IUFDynamicObject): Promise<undefined | T>
Inherit Doc
Type Parameters
- T
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<undefined | T>
Inherited from UFDatabase.rowAs
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:60

rowOrFailAs

rowOrFailAs<T>(aSql: string, aParameterValues?: IUFDynamicObject): Promise<T>
Inherit Doc
Type Parameters
- T
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<T>
Inherited from UFDatabase.rowOrFailAs
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:64

`Protected` rows

rows(aSql: string, aParameterValues?: IUFDynamicObject): Promise<RowDataPacket[]>
Inherit Doc
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<RowDataPacket[]>
Overrides UFDatabase.rows
- Defined in src/data/UFMysqlDatabase.ts:205

rowsAs

rowsAs<T>(aSql: string, aParameterValues?: IUFDynamicObject): Promise<T[]>
Inherit Doc
Type Parameters
- T
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<T[]>
Inherited from UFDatabase.rowsAs
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:68

transaction

transaction(aCallback: ((aDatabase: IUFDatabase) => Promise<void>)): Promise<void>
Inherit Doc
Parameters
- aCallback: ((aDatabase: IUFDatabase) => Promise<void>)
  - - (aDatabase: IUFDatabase): Promise<void>
    - Parameters
      
      aDatabase: IUFDatabase
      
      Returns Promise<void>
Returns Promise<void>
Overrides UFDatabase.transaction
- Defined in src/data/UFMysqlDatabase.ts:177

update

update(aSql: string, aParameterValues?: IUFDynamicObject): Promise<number>
Inherit Doc
Parameters
- aSql: string
- Optional aParameterValues: IUFDynamicObject
Returns Promise<number>
Overrides UFDatabase.update
- Defined in src/data/UFMysqlDatabase.ts:169

updateObject

updateObject<T>(aTable: string, aPrimaryValue: any, aData: T, aPrimaryKey?: string, anIgnoreFields?: string[]): Promise<void>
Inherit Doc
Type Parameters
- T extends object
Parameters
- aTable: string
- aPrimaryValue: any
- aData: T
- Optional aPrimaryKey: string
- Optional anIgnoreFields: string[]
Returns Promise<void>
Inherited from UFDatabase.updateObject
- Defined in node_modules/@ultraforce/ts-general-lib/dist/data/UFDatabase.d.ts:80

Class UFMysqlDatabase

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

aLog: IUFLog

Returns UFMysqlDatabase

Methods

Protected convertRow

Returns

Type Parameters

T

Parameters

aRow: RowDataPacket

Returns T

delete

Inherit Doc

Parameters

aSql: string

Optional aParameterValues: IUFDynamicObject

Returns Promise<number>

Protected field

Inherit Doc

Parameters

aSql: string

Optional aParameterValues: IUFDynamicObject

aDefault: any = undefined

Returns Promise<any>

fieldAs

Inherit Doc

Type Parameters

T

Parameters

aSql: string

aParameterValues: IUFDynamicObject

aDefault: T

Returns Promise<T>

fieldOrFailAs

Inherit Doc

Type Parameters

T

Parameters

aSql: string

Optional aParameterValues: IUFDynamicObject

Returns Promise<T>

getUniqueCode

Inherit Doc

Parameters

aTable: string

aColumn: string

aLength: number

Returns Promise<string>

init

Parameters

aHost: string

aDatabase: string

anUser: string

aPassword: string

Returns Promise<void>

insert

Inherit Doc

Parameters

aSql: string

aParameterValues: IUFDynamicObject

Returns Promise<number>

insertObject

Inherit Doc

Type Parameters

T extends object

Parameters

aTable: string

aData: T

Optional aPrimaryKey: string

Optional anIgnoreFields: string[]

Returns Promise<T>

Protected processSqlParameters

Returns

`Protected` convertRow

`Optional` aParameterValues: IUFDynamicObject

`Protected` field

`Optional` aParameterValues: IUFDynamicObject

`Optional` aParameterValues: IUFDynamicObject

`Optional` aPrimaryKey: string

`Optional` anIgnoreFields: string[]

`Protected` processSqlParameters

`Protected` row

`Optional` aParameterValues: IUFDynamicObject

`Optional` aParameterValues: IUFDynamicObject

`Optional` aParameterValues: IUFDynamicObject

`Protected` rows

`Optional` aParameterValues: IUFDynamicObject

`Optional` aParameterValues: IUFDynamicObject

`Optional` aParameterValues: IUFDynamicObject

`Optional` aPrimaryKey: string

`Optional` anIgnoreFields: string[]