Class OINODbMariadb

Implementation of MariaDb/MySql-database.

Hierarchy

unknown
- OINODbMariadb

Index

Constructors

Methods

connect disconnect getNativeDataType getSchemaFields parseValueAsCell printCellAsValue printColumnName printStringValue printTableName sqlExec sqlSelect validate

Constructors

constructor

new OINODbMariadb(params: OINODbParams): OINODbMariadb
Constructor of OINODbMariadb
Parameters
- params: OINODbParams
  database parameters
Returns OINODbMariadb
Overrides OINODb.constructor
- Defined in db-mariadb/src/OINODbMariadb.ts:113

Methods

connect

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

Returns Promise<OINOResult>
- Defined in db-mariadb/src/OINODbMariadb.ts:293

disconnect

disconnect(): Promise<void>
Disconnect from database.

Returns Promise<void>
- Defined in db-mariadb/src/OINODbMariadb.ts:352

getNativeDataType

getNativeDataType(schema: OINODataFieldSchema): string
Resolve the optimal native (SQL) type for a serialized field schema.
Parameters
- schema: OINODataFieldSchema
  serialized field schema
Returns string
- Defined in db-mariadb/src/OINODbMariadb.ts:473

getSchemaFields

getSchemaFields(tableName: string): Promise<OINODataField[]>
Get the schema fields of a table as OINODataFields (without any API-level field filtering).
Parameters
- tableName: string
  name of the table
Returns Promise<OINODataField[]>
- Defined in db-mariadb/src/OINODbMariadb.ts:426

parseValueAsCell

parseValueAsCell(sqlValue: OINODataCell, nativeType: string): OINODataCell
Parse a single SQL result value for serialization using the context of the native data type.
Parameters
- sqlValue: OINODataCell
  data from serialization
- nativeType: string
  native type name for table column
Returns OINODataCell
- Defined in db-mariadb/src/OINODbMariadb.ts:261

printCellAsValue

printCellAsValue(cellValue: OINODataCell, nativeType: string): string
Print a single data value from serialization using the context of the native data type with the correct SQL escaping.
Parameters
- cellValue: OINODataCell
  data from sql results
- nativeType: string
  native type name for table column
Returns string
- Defined in db-mariadb/src/OINODbMariadb.ts:206

printColumnName

printColumnName(sqlColumn: string): string
Print a column name with correct SQL escaping.
Parameters
- sqlColumn: string
  name of the column
Returns string
- Defined in db-mariadb/src/OINODbMariadb.ts:193

printStringValue

printStringValue(sqlString: string): string
Print a single string value as valid sql literal
Parameters
- sqlString: string
  string value
Returns string
- Defined in db-mariadb/src/OINODbMariadb.ts:248

printTableName

printTableName(sqlTable: string): string
Print a table name using database specific SQL escaping.
Parameters
- sqlTable: string
  name of the table
Returns string
- Defined in db-mariadb/src/OINODbMariadb.ts:183

sqlExec

sqlExec(sql: string): Promise<OINODataSet>
Execute other sql operations.
Parameters
- sql: string
  SQL statement.
Returns Promise<OINODataSet>
- Defined in db-mariadb/src/OINODbMariadb.ts:382

sqlSelect

sqlSelect(sql: string): Promise<OINODataSet>
Execute a select operation.
Parameters
- sql: string
  SQL statement.
Returns Promise<OINODataSet>
- Defined in db-mariadb/src/OINODbMariadb.ts:366

validate

validate(): Promise<OINOResult>
Validate connection to database is working.

Returns Promise<OINOResult>
- Defined in db-mariadb/src/OINODbMariadb.ts:322