Class UFDatabase<TRow>Abstract

UFDatabase can act as a base class for database implementations.

It supports named parameters in sql queries, using ':name' where name can be a combination of letters, numbers and underscores.

The parameter values are contained in a dynamic object, where the property names match the named parameter.

Subclasses can use processSqlParameters to convert the sql statement.

The class defines several abstract methods subclasses must implement.

Type Parameters

  • TRow

Implements

Constructors

constructor

Methods

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

Constructors

constructor

Methods

Protected convertRow

  • convertRow<T>(aRow): T

  • Converts a row from database type to an external type. The default implementation just uses a typecast.

    Type Parameters

    • T

    Parameters

    • aRow: TRow

      Row to convert.

    Returns T

    The data from aRow as new type.

delete

  • delete(aSql, aParameterValues?): Promise<number>

  • Performs a database delete and returns the number of deleted records.

    Parameters

    • aSql: string

      Sql delete statement

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<number>

    number of deleted records.

Protected Abstract field

  • field(aSql, aParameterValues?, aDefault?): Promise<any>

  • Execute a sql to get a single value.

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    • Optional aDefault: any

      Default value to return if the sql statement did not have any results

    Returns Promise<any>

    result from sql statement or aDefault

fieldAs

  • fieldAs<T>(aSql, aParameterValues, aDefault): Promise<T>

  • Execute a sql to get a single value as a certain type.

    Type Parameters

    • T

    Parameters

    • aSql: string

      Sql statement to perform

    • aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    • aDefault: T

      Default value to return if the sql statement did not have any results

    Returns Promise<T>

    result from sql statement or aDefault

fieldOrFailAs

  • fieldOrFailAs<T>(aSql, aParameterValues?): Promise<T>

  • Execute a sql to get a single value as a certain type. If no value can be found, the method will throw an error.

    Type Parameters

    • T

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<T>

    result from sql statement

    Throws

    if no row (and thus field) can be found

getUniqueCode

  • getUniqueCode(aTable, aColumn, aLength): Promise<string>

  • Generates a unique code with UFText.generateCode to be used in some table.

    Parameters

    • aTable: string

      Table to use unique code with

    • aColumn: string

      Name of column in table that contains the unique code

    • aLength: number

      Number of characters the code should exist of

    Returns Promise<string>

    an unique code

Abstract insert

  • insert(aSql, aParameterValues?): Promise<number>

  • Performs an insert and returns the id of the created record.

    Parameters

    • aSql: string

      Sql insert statement

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<number>

    id of created record or 0 if there is no id.

insertObject

  • insertObject<T>(aTable, aData, aPrimaryKey?, anIgnoreFields?): Promise<T>

  • Inserts a data from an object. The method creates an insert into statement using the property names inside the object.

    The aData structure can contain a primary key property, when building the sql statement it will be skipped. After the insert statement the generated id (if any) will be assigned to the primary key field.

    Type Parameters

    • T extends object

      should be an object type not a class; since the method might create a new object

    Parameters

    • aTable: string

      Name of table

    • aData: T

      Data to insert (should be some form of object)

    • aPrimaryKey: string = 'id'

      Name of primary key field

    • anIgnoreFields: string[] = []

      Fields to ignore in aData

    Returns Promise<T>

    Either aData if there is no primary key or a new object with values copied from aData with the new primary key value.

Protected processSqlParameters

  • processSqlParameters(aSql, aParameterValues, aCallback): string

  • Processes a sql with named parameters and replaces the named parameters with values returned by the callback.

    Parameters

    • aSql: string

      Sql statement to process.

    • aParameterValues: UFDynamicObject

      An object that contains properties whose name match the named parameters

    • aCallback: ((aName, aValue) => string)

      This callback is invoked for every found named parameter. The result will be used to replace the named parameter.

        • (aName, aValue): string

        • Parameters

          • aName: string
          • aValue: any

          Returns string

    Returns string

    an updated SQL statement

Protected Abstract row

  • row(aSql, aParameterValues?): Promise<undefined | TRow>

  • Execute a sql to get a row.

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<undefined | TRow>

    result from sql statement; undefined when no row could be found

rowAs

  • rowAs<T>(aSql, aParameterValues?): Promise<undefined | T>

  • Execute a sql to get a row as a certain type.

    Type Parameters

    • T

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<undefined | T>

    result from sql statement; undefined when no row could be found

rowOrFailAs

  • rowOrFailAs<T>(aSql, aParameterValues?): Promise<T>

  • Execute a sql to get a row as a certain type. If no row can be found, the method will throw an error.

    Type Parameters

    • T

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<T>

    result from sql statement

    Throws

    error if no row can be found

Protected Abstract rows

  • rows(aSql, aParameterValues?): Promise<TRow[]>

  • Execute a sql to get multiple rows.

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<TRow[]>

    Result from sql statement

rowsAs

  • rowsAs<T>(aSql, aParameterValues?): Promise<T[]>

  • Execute a sql to get multiple rows as a certain type.

    Type Parameters

    • T

    Parameters

    • aSql: string

      Sql statement to perform

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<T[]>

    result from sql statement

Abstract transaction

  • transaction(aCallback): Promise<void>

  • Execute a function within a transaction.

    Parameters

    • aCallback: ((aDatabase) => Promise<void>)

      A function that will be called with await. It will be called with a single parameter, which can be used to communicate with the database. The parameter might be a different instance then the instance the transaction call originated from.

        • (aDatabase): Promise<void>

        • Parameters

          Returns Promise<void>

    Returns Promise<void>

    Throws

    any exception that occurred while calling aCallback

Abstract update

  • update(aSql, aParameterValues?): Promise<number>

  • Performs an update and returns the number of changed records.

    Parameters

    • aSql: string

      Sql update statement

    • Optional aParameterValues: UFDynamicObject

      Values to use in case the statement contains parameters

    Returns Promise<number>

    number of changed records.

updateObject

  • updateObject<T>(aTable, aPrimaryValue, aData, aPrimaryKey?, anIgnoreFields?): Promise<void>

  • Updates a record in a table assuming it has a single primary key column.

    Type Parameters

    • T extends object

    Parameters

    • aTable: string

      Name of table

    • aPrimaryValue: any

      Primary key vale

    • aData: T

      Object containing field names and their new values.

    • aPrimaryKey: string = 'id'

      Name of primary key

    • anIgnoreFields: string[] = []

      Fields to ignore in aData

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorconvertRowdeletefieldfieldAsfieldOrFailAsgetUniqueCodeinsertinsertObjectprocessSqlParametersrowrowAsrowOrFailAsrowsrowsAstransactionupdateupdateObject