Class OINODbDataModel

constructor

• new OINODbDataModel(api: OINODbApi): OINODbDataModel

  Constructor of the data model. NOTE! OINODbDataModel.initialize must be called after constructor to populate fields.

  Parameters

  • api: OINODbApi

    api of the data model

  Returns OINODbDataModel

Readonlyapi

Readonlyfields

addField

• addField(field: OINODbDataField): void

  Add a field to the datamodel.

  Parameters

  • field: OINODbDataField

    dataset field

  Returns void

filterFields

• filterFields(filter: OINODbDataFieldFilter): OINODbDataField[]

  Find all fields based of given filter callback criteria (e.g. fields of certain data type, primary keys etc.)

  Parameters

  • filter: OINODbDataFieldFilter

    callback called for each field to include or not

  Returns OINODbDataField[]

findFieldByName

• findFieldByName(name: string): OINODbDataField

  Find a field of a given name if any.

  Parameters

  • name: string

    name of the field to find

  Returns OINODbDataField

findFieldIndexByName

• findFieldIndexByName(name: string): number

  Find index of a field of a given name if any.

  Parameters

  • name: string

    name of the field to find

  Returns number

getRowPrimarykeyValues

• getRowPrimarykeyValues(row: OINODataRow, hashidValues?: boolean): string[]

  Return the primary key values of one row in order of the data model

  Parameters

  • row: OINODataRow

    data row
  • hashidValues: boolean = false

    apply hashid when applicable

  Returns string[]

initialize

• initialize(): Promise<void>

  Initialize datamodel from SQL schema.

  Returns Promise<void>

printDebug

• printDebug(separator?: string): string

  Print debug information about the fields.

  Parameters

  • separator: string = ""

    string to separate field prints

  Returns string

printFieldPublicPropertiesJson

• printFieldPublicPropertiesJson(): string

  Print all public properties (db, table name, fields) of the datamodel. Used in automated testing validate schema has stayed the same.

  Returns string

printSqlDelete

• printSqlDelete(id: string): string

  Print SQL delete statement for id.

  Parameters

  • id: string

    OINO ID (i.e. combined primary key values)

  Returns string

printSqlInsert

• printSqlInsert(row: OINODataRow): string

  Print SQL insert statement from one data row.

  Parameters

  • row: OINODataRow

    one row of data in the data model

  Returns string

printSqlSelect

• printSqlSelect(id: string, params: OINODbSqlParams): string

  Print SQL select statement using optional id and filter.

  Parameters

  • id: string

    OINO ID (i.e. combined primary key values)
  • params: OINODbSqlParams

    OINO reqest params

  Returns string

printSqlUpdate

• printSqlUpdate(id: string, row: OINODataRow): string

  Print SQL insert statement from one data row.

  Parameters

  • id: string

    OINO ID (i.e. combined primary key values)
  • row: OINODataRow

    one row of data in the data model

  Returns string