Class OINODataSourceAbstract

constructor

• new OINODataSource(): OINODataSource

  Returns OINODataSource

isConnected

isValidated

bindCellValue

• bindCellValue(cellValue: OINODataCell, nativeType: string): OINODataCell

  Coerce a single data value into a form that can safely be passed to the datasource as a bind parameter (as opposed to printCellAsValue, which formats it as an inline SQL literal).

  The default implementation returns the value unchanged. SQL datasources override this to apply driver-specific coercions (e.g. converting Date/boolean for drivers that only accept primitive bind types). Non-SQL datasources (blob, nosql) can ignore it.

  Parameters

  • cellValue: OINODataCell

    data value to bind
  • nativeType: string

    native type name for the table column

  Returns OINODataCell

Abstractconnect

• connect(): Promise<OINOResult>

  Connect to database.

  Returns Promise<OINOResult>

Abstractdisconnect

• disconnect(): Promise<void>

  Disconnect from database.

  Returns Promise<void>

AbstractinitializeApiDatamodel

• initializeApiDatamodel(api: OINOApi): 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>

AbstractparseValueAsCell

• 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

AbstractprintCellAsValue

• 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

AbstractprintColumnName

• printColumnName(column: string): string

  Print a column name with correct datasource specific formatting.

  Parameters

  • column: string

    name of the column

  Returns string

AbstractprintStringValue

• printStringValue(sqlString: string): string

  Print a single string value as valid sql literal

  Parameters

  • sqlString: string

    string value

  Returns string

Abstractvalidate

• validate(): Promise<OINOResult>

  Validate connection to database is working.

  Returns Promise<OINOResult>