Class OINODb`Abstract`

Base class for database abstraction, implementing methods for connecting, making queries and parsing/formatting data between SQL and serialization formats.

Index

Constructors

Methods

connect initializeApiDatamodel parseSqlValueAsCell printCellAsSqlValue printSqlColumnname printSqlTablename sqlExec sqlSelect

Constructors

constructor

new OINODb(params): OINODb
Constructor for OINODb.
Parameters
- params: OINODbParams
Returns OINODb
- Defined in core/src/OINODb.ts:22

Methods

`Abstract` connect

connect(): Promise<boolean>
Connect to database.

Returns Promise<boolean>
- Defined in core/src/OINODb.ts:30

`Abstract` initializeApiDatamodel

initializeApiDatamodel(api): Promise<void>
Initialize a data model by getting the SQL schema and populating OINODataFields of the model.
Parameters
- api: OINOApi
  api which data model to initialize.
Returns Promise<void>
- Defined in core/src/OINODb.ts:91

`Abstract` parseSqlValueAsCell

parseSqlValueAsCell(strValue, sqlType): OINODataCell
Parse a single SQL result value for serialization using the context of the native data type.
Parameters
- strValue: OINODataCell
  data from serialization
- sqlType: string
  native type name for table column
Returns OINODataCell
- Defined in core/src/OINODb.ts:66

`Abstract` printCellAsSqlValue

printCellAsSqlValue(sqlValue, sqlType): string
Print a single data value from serialization using the context of the native data type with the correct SQL escaping.
Parameters
- sqlValue: OINODataCell
  data from sql results
- sqlType: string
  native type name for table column
Returns string
- Defined in core/src/OINODb.ts:56

`Abstract` printSqlColumnname

printSqlColumnname(sqlColumn): string
Print a column name with correct SQL escaping.
Parameters
- sqlColumn: string
  name of the column
Returns string
- Defined in core/src/OINODb.ts:46

`Abstract` printSqlTablename

printSqlTablename(sqlTable): string
Print a table name using database specific SQL escaping.
Parameters
- sqlTable: string
  name of the table
Returns string
- Defined in core/src/OINODb.ts:38

`Abstract` sqlExec

sqlExec(sqlCmd): Promise<OINODataSet>
Execute other sql operations.
Parameters
- sqlCmd: string
  SQL statement.
Returns Promise<OINODataSet>
- Defined in core/src/OINODb.ts:82

`Abstract` sqlSelect

sqlSelect(sqlCmd): Promise<OINODataSet>
Execute a select operation.
Parameters
- sqlCmd: string
  SQL statement.
Returns Promise<OINODataSet>
- Defined in core/src/OINODb.ts:74